Managing Plugins

Plugins extend PteroCA functionality with custom features, payment providers, integrations, and more. This guide covers managing plugins in the admin panel.

Accessing Plugin Management

To manage plugins:

1. Click Plugins in the admin sidebar

2. You'll see a list of all installed plugins

Required permission: access_plugins or admin role

Plugin Overview

What is a Plugin?

A plugin can add:

• Payment providers - Stripe, PayPal, custom gateways

• Features - Custom functionality and workflows

• Integrations - Third-party service connections

• UI components - New admin panel sections

• Automation - Cron tasks and background jobs

• Custom commands - CLI tools

Plugin Architecture

Plugins are self-contained packages that:

• Hook into PteroCA events

• Add routes and controllers

• Extend database with custom entities

• Provide configuration interfaces

• Can be enabled/disabled independently

Plugin List

The plugin list displays:

• Plugin name - Display name

• Author - Plugin developer

• Version - Plugin version number

• Status - Enabled or disabled

• Health - Compatibility status

• Description - Brief description

• Actions - View, configure, enable/disable, uninstall

Plugin Status Indicators

Enabled (green):

• Plugin is active

• Functionality is available

• Hooks are registered

• Routes are accessible

Disabled (gray):

• Plugin is installed but inactive

• Functionality not available

• No impact on system

• Can be enabled anytime

Error (red):

• Plugin has compatibility issues

• Missing dependencies

• Configuration problems

• Requires attention

Installing Plugins

Uploading Plugin Packages

To install a new plugin:

1. Click Install Plugin or Upload Plugin

2. Select plugin ZIP file

3. Upload and install

4. Plugin appears in list (disabled by default)

5. Enable plugin to activate

Plugin package requirements:

• Valid ZIP archive

• Contains plugin.json manifest

• Includes required PHP files

• Valid plugin structure

Plugin Compatibility

Ensure plugins are compatible with your PteroCA version. Incompatible plugins may cause errors or system instability.

Plugin Sources

Primary source:

PteroCA Marketplace (Recommended)

Visit marketplace.pteroca.com for:

• ✅ Security-scanned plugins

• ✅ Verified developers

• ✅ Community reviews and ratings

• ✅ Version compatibility checking

• ✅ One-click downloads

Other sources:

• Community developers (Discord, forums)

• Custom development (commissioned plugins)

• GitHub repositories (open-source)

Security best practices:

• Prefer plugins from the official marketplace

• Only install plugins from trusted sources

• Review plugin permissions before installation

• Test plugins on staging environment first

• Check plugin reviews and ratings

Managing Installed Plugins

Viewing Plugin Details

To view plugin information:

1. Find plugin in list

2. Click View or plugin name

3. See plugin details including:

   • Full description

   • Author information

   • Version and changelog

   • Dependencies

   • Permissions required

   • Configuration options

Enabling Plugins

To enable a plugin:

1. Find disabled plugin in list

2. Click Enable action

3. Plugin activates immediately

4. Functionality becomes available

What happens when enabled:

• Plugin code is loaded

• Event hooks are registered

• Routes become accessible

• Database migrations run (if needed)

• Configuration becomes active

Disabling Plugins

To disable a plugin:

1. Find enabled plugin in list

2. Click Disable action

3. Confirm disabling

4. Plugin deactivates immediately

What happens when disabled:

• Plugin code is not loaded

• Functionality becomes unavailable

• Routes are not accessible

• Data is preserved (not deleted)

• Can be re-enabled anytime

Disable vs. Uninstall

Disabling keeps plugin data and configuration. Uninstalling removes everything. Disable first to test impact before uninstalling.

Configuring Plugins

To configure a plugin:

1. Find plugin in list

2. Click Configure or Settings action

3. Modify plugin settings

4. Save changes

Common plugin settings:

• API keys - Third-party service credentials

• Webhooks - Callback URLs

• Features - Enable/disable specific features

• Behavior - Customize plugin functionality

• Display - UI customization options

Settings apply:

• Immediately after saving

• May require plugin restart (disable/enable)

• Per-plugin basis

See Plugin Settings for configuration details.

Updating Plugins

To update a plugin:

1. Download new version

2. Disable current version

3. Upload new version (overwrites old)

4. Enable updated plugin

5. Verify functionality

Backup Before Updates

Always backup your database before updating plugins, especially for plugins that modify data structures.

Update considerations:

• Check changelog for breaking changes

• Verify compatibility with PteroCA version

• Test on staging environment

• Review migration notes

• Monitor logs after update

Uninstalling Plugins

To uninstall a plugin:

1. Disable plugin first

2. Click Uninstall or Delete action

3. Confirm uninstallation

4. Plugin is removed

Uninstallation removes:

• Plugin code and files

• Plugin configuration

• Plugin database tables (if cleanup enabled)

• Plugin assets

Before uninstalling:

• Backup plugin data if needed

• Export configuration

• Disable plugin and test impact

• Ensure no active dependencies

Permanent Deletion

Uninstalling a plugin may permanently delete its data. Export or backup data before uninstalling if you might need it later.

Plugin Health Status

Checking Plugin Compatibility

PteroCA automatically checks:

• Plugin version compatibility

• PHP version requirements

• PteroCA version requirements

• Required dependencies

• Database schema integrity

Health indicators:

Healthy (green checkmark):

• All requirements met

• No conflicts detected

• Plugin working correctly

• Compatible with current version

Warning (yellow):

• Minor compatibility issues

• Deprecated features used

• Non-critical warnings

• Plugin works but needs attention

Error (red):

• Incompatible with PteroCA version

• Missing dependencies

• Critical errors

• Plugin won't function

Resolving Plugin Issues

For compatibility errors:

1. Check plugin requirements

2. Update PteroCA or plugin to compatible version

3. Install missing dependencies

4. Contact plugin developer

For configuration errors:

1. Review plugin configuration

2. Check API credentials

3. Verify webhook URLs

4. Reset to default settings

For runtime errors:

1. Check error logs (Logs & Monitoring)

2. Disable and re-enable plugin

3. Clear cache

4. Review plugin documentation

5. Contact plugin support

Plugin Dependencies

Managing Dependencies

Some plugins require:

• Other plugins - Base functionality from another plugin

• PHP extensions - Specific PHP modules

• External services - API access to third-party services

• System libraries - Server-side components

Dependency checking:

• PteroCA verifies dependencies at installation

• Warns if dependencies are missing

• Prevents enabling if critical dependencies unavailable

Installing dependencies:

1. Check plugin requirements

2. Install required plugins first

3. Install PHP extensions (via server admin)

4. Configure external service access

5. Then install dependent plugin

Permissions Required

Plugin Management Permissions

To manage plugins, users need:

• access_plugins permission, or

• admin role

Permission levels:

• View plugins - See plugin list and details

• Install plugins - Upload new plugin packages

• Configure plugins - Modify plugin settings

• Enable/disable plugins - Activate or deactivate plugins

• Uninstall plugins - Remove plugins

See Managing Permissions for details on configuring roles and permissions.

Troubleshooting

Plugin Won't Enable

Possible causes:

• Missing dependencies

• Incompatible PteroCA version

• PHP version too old

• Database migration failed

• Configuration errors

Solutions:

1. Check plugin health status

2. Review error logs

3. Verify dependencies installed

4. Update PteroCA or plugin

5. Check database permissions

6. Contact plugin developer

Plugin Causes Errors

If plugin breaks functionality:

Immediate action:

1. Disable the plugin immediately

2. Check if error persists

3. Review error logs

Diagnosis:

1. Check plugin compatibility

2. Review recent changes

3. Verify configuration

4. Test on staging environment

5. Check for plugin conflicts

Resolution:

1. Update plugin to latest version

2. Fix configuration issues

3. Report bug to plugin developer

4. Use alternative plugin

5. Uninstall if necessary

Plugin Configuration Not Saving

Possible causes:

• Permission issues

• Validation errors

• Database connection problems

• Cache issues

Solutions:

1. Check field validation

2. Verify database connection

3. Clear application cache

4. Check file permissions

5. Review error logs

Plugin Missing After Update

If plugin disappears after PteroCA update:

1. Check plugin compatibility with new version

2. Review update changelog

3. Reinstall plugin if compatible

4. Contact plugin developer for updated version

Best Practices

Plugin Management

Do:

• Test plugins on staging environment first

• Keep plugins updated to latest versions

• Disable unused plugins

• Review plugin permissions before installation

• Monitor plugin performance and logs

• Backup before plugin changes

• Document plugin configurations

Don't:

• Install untrusted plugins

• Enable all plugins simultaneously without testing

• Ignore plugin health warnings

• Use outdated plugins

• Skip reading plugin documentation

• Forget to configure plugins after installation

Security Considerations

Plugin security:

• Only install plugins from trusted sources

• Review plugin permissions carefully

• Keep plugins updated for security patches

• Disable unused plugins

• Monitor plugin activity in logs

• Use minimal permission sets

• Avoid plugins requesting unnecessary access

Performance Optimization

For better performance:

• Disable unused plugins

• Use lightweight plugins when possible

• Monitor plugin resource usage

• Optimize plugin configurations

• Remove conflicting plugins

• Keep only essential plugins enabled

Related Documentation

User Guides

• Plugin Settings - Configure plugin settings

• Plugins Overview - Complete plugin documentation

• Payment Configuration - Payment provider plugins

Developer Guides

• Getting Started - Build custom plugins

• Plugin Structure - Plugin architecture

• Plugin Manifest - plugin.json reference

• Event System - Plugin hooks and events

Administration

• Managing Themes - Theme management

• Managing Permissions - Access control

• Logs & Monitoring - Plugin error logs

Need Help?

For plugin management questions:

• Check FAQ

• Review Troubleshooting Guide

• Join Discord Community

• Contact technical support

• Contact plugin developer for plugin-specific issues