The install_plugin Script

Valid for versions 100 through the latest version

Version:

82

100


Last modified: September 15, 2021

Overview

The /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 /usr/local/cpanel/scripts/uninstall_plugin script.

Important:
  • Only the root user can run this script.
  • If the plugin installation file does not contain a install.json file, 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]

Options

Use the following options with this script:

Option Description Example
filepath Required.
The cPanel plugin’s installation archive file. The file must be one of the following formats:
  • .tar.gz
  • .bzip2
  • .zip
  • An uncompressed directory.
/path/to/plugin.tar.gz
--theme The cPanel theme to install the plugin to. This option defaults to the jupiter theme. --theme=jupiter

Additional Documentation