The install_plugin Script
Valid for versions 82 through the latest version
Last modified: February 9, 2021
/usr/local/cpanel/scripts/install_plugin script installs a cPanel plugin to a cPanel theme. When you run this script, it uses the archive file’s
install.json file to install a plugin to the
dynamicui.conf file. The cPanel Home interface uses the
dynamicui.conf file to display icons and groups.
To uninstall a plugin, use the
- Only the
rootuser can run this script.
- If the plugin installation file does not contain a
install.jsonfile, the installation process will fail.
- This script does not extract the plugin from the archive file.
Run the script
To run this script on the command line, use the following format:
/usr/local/cpanel/scripts/install_plugin /filepath [options]
Use the following options with this script:
||Required. The cPanel plugin’s installation archive file. The file must be one of the following formats:
||The cPanel theme to install the plugin to. This option defaults to the