Install and Upgrade Plugins
Built-in Plugins
NocoBase built-in plugins are automatically updated with the core version and require no manual action.
Commercial Plugins
For detailed installation and upgrade instructions, please refer to: Commercial Plugin Activation Guide
Third-party Plugins
Online Plugin Installation
NocoBase supports online plugin installation through the interface, but the current experience is not ideal. Reasons include:
- Due to Node.js process runtime limitations, after installing or updating plugins, you need to stop the process and then run the
upgradecommand for the changes to take effect; - In multi-app scenarios, online installation struggles to handle plugin synchronization across multiple sub-applications simultaneously;
- Batch plugin updates are not supported;
- Online installation or updates can easily cause abnormal application process termination.
Therefore, it is recommended to use command-line or manual upload methods to install and upgrade plugins. We recommend integrating this with CI/CD workflows, using command-line methods to download, extract, and upgrade plugins, ensuring consistency and reliability for each update deployment.
Installing Plugins via Command Line
If the plugin is already installed and needs to be upgraded, run the following command:
Manual Upload and Extraction
Please download the plugin package to your local machine first, then manually upload and extract it to the ./storage/plugins directory. If the plugin is already enabled, execute the following command to complete the plugin upgrade after uploading and extracting.
⚠️ Note: To avoid cache issues, please ensure that the NocoBase application is stopped before execution.
Correct Way to Extract a Plugin
The following example demonstrates how to correctly extract a plugin package to the specified directory:
This command will extract the plugin to the specified directory without creating an extra package directory layer.