> ## Documentation Index
> Fetch the complete documentation index at: https://ownpay.org/docs/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> OwnPay is licensed under AGPL-3.0 and is completely free - no licensing fees.
> Production docs URL: https://ownpay.org/docs - append .md to any page URL for clean markdown.
> OwnPay requires PHP 8.3+, MySQL/MariaDB, and Redis.
> MCP server available at https://ownpay.org/docs/mcp for programmatic documentation queries.
> Use root-relative links (e.g. /quickstart) for internal navigation - do NOT include /docs prefix.
> Plugin development: consult /developer/plugin-types/ pages for correct interfaces and manifests.

# Plugins - Install and Manage Platform Extensions

> Manage modular platform extensions, install custom addons, and toggle gateway and theme plugins from the OwnPay admin plugins screen.

The Plugins manager allows administrators to extend OwnPay's core capabilities. Extensions are packaged as plugins and are grouped into three categories: **Gateways** (API connectors), **Addons** (additional platform features), and **Themes** (layout designs).

## Getting here

1. Log in to the OwnPay admin dashboard as the super-administrator
2. Under the **SYSTEM** section in the left sidebar, click **Plugins**

## Page sections

### 1. Plugin category tabs

* **All:** Shows all plugins on the server
* **Gateways:** Lists only payment processor connectors
* **Addons:** Displays helper integrations (`mail-gateway`, `sms-gateway`, `telegram-bot`)
* **Themes:** Shows visual templates
* **Trash:** Displays uninstalled plugins queued for deletion

### 2. Search and filter bar

* **Search Textbox:** Locate plugins by name or slug
* **Status Dropdown:** Filter by `Active`, `Inactive`, or `Not Installed` status states

### 3. Plugin profile cards

Each card displays:

* **Branding Icon:** Visual logo of the extension
* **Details:** Extension name, type tag, version, and description
* **Controls:** Click **Install & Activate** (or **Deactivate** if active) to modify execution states

### 4. Upload plugin wizard

Located by clicking the **Upload Plugin** link in the header. Allows developers to upload a custom packaged `.zip` plugin file directly to the server.

## Step-by-step: installing and activating a plugin

1. Navigate to the **Plugins** manager
2. Search or browse to locate the extension (e.g., **Telegram Bot**)
3. Click the **Install & Activate** button
4. The system will extract the package, run configuration migrations, and change the status

## Best practices

* Deactivate plugins you are not using to improve system performance
* Check for version compatibility in the manifest description before uploading manual updates
* Do not upload zip archives from untrusted sources, as plugins run with administrative permissions
* Do not rename plugin folder directories directly via FTP/file manager

## Common mistakes and troubleshooting

| Symptom                                   | Cause                                         | Fix                                                                                         |
| ----------------------------------------- | --------------------------------------------- | ------------------------------------------------------------------------------------------- |
| Plugin fails to activate                  | Manifest validation or footgun scan failed    | Check the plugin's `manifest.json` for syntax errors and remove blocked PHP functions       |
| Plugin not appearing in admin             | Plugin folder not in `modules/` directory     | Ensure the plugin is placed in `modules/gateways/`, `modules/addons/`, or `modules/themes/` |
| Checkout page broken after plugin install | Plugin conflicts with theme or another plugin | Deactivate the last installed plugin and report the issue                                   |

## Related pages

* [Payment Gateways](/user-guide/gateways/gateways) - Configure credentials for activated gateways
* [Themes](/user-guide/appearance/themes) - Manage active visual styles
* [System Update](/user-guide/system/system-update) - Upload master platform core updates


## Related topics

- [Developer Quickstart - Build Your First Payment Integration](/docs/developer/quickstart.md)
- [Node.js SDK - TypeScript-First Payment Integration](/docs/developer/integration/nodejs.md)
- [Retrieve Device Connection Status](/docs/api-reference/retrieve-device-connection-status.md)
- [OwnPay API Overview - REST API for Multi-Brand Payments](/docs/api/overview.md)
- [Addons - Activate Utility Plugins and Integrations](/docs/user-guide/system/addons.md)
