How do I install the WHM, cPanel and DirectAdmin plugins?
After the main install, run cpanel-plugin/whm/install.sh and cpanel-plugin/cpanel/install.sh on cPanel, or directadmin-plugin/install.sh on DirectAdmin. The plugins are optional: the console on port 8087 does everything the admin plugins do. Plesk has no plugin.
Before you start
BackupWall must be installed first. Run the plugin installers from the release folder, as root. They work with the default settings (/opt/backupwall, port 8087). The plugin installers need the bundled Python 3.11, so do not install BackupWall with BUNDLE_PYTHON=false if you plan to use them.
WHM and cPanel
bash cpanel-plugin/whm/install.sh # administrators
bash cpanel-plugin/cpanel/install.sh # end users (run the WHM one first)
- Run the WHM installer. The full admin console appears in WHM → Plugins → BackupWall, limited to root-level WHM users. It refuses to run on cPanel older than v100.
- Run the cPanel installer. It stops with a message if the WHM one has not been run. Account owners get a BackupWall tile under Files in the Jupiter theme.
- If the tile is missing for a user, open WHM → Feature Manager and check that the feature
backupwallis on for that user's feature list.
Files: /usr/local/cpanel/whostmgr/docroot/cgi/backupwall and /usr/local/cpanel/base/frontend/jupiter/backupwall. The WHM plugin key is /var/cpanel/backupwall/service.key.
DirectAdmin
bash directadmin-plugin/install.sh
- Admin level: Extra Features → BackupWall.
- User level: Extra Features → BackupWall (own backups, restores, downloads).
- The installer restarts DirectAdmin and adds
backupwall-download-proxy.timer, which sets up the/backupwall-downloadreverse proxy so downloads can resume. - If your admin account is not called
admin, runDA_ADMIN=youradmin bash directadmin-plugin/install.sh. - Files:
/usr/local/directadmin/plugins/backupwall. Only the Evolution skin was checked.
Plesk
There is no Plesk plugin yet. Use the console at https://<server-ip>:8087.
After an upgrade
Run the plugin installers again so the panels get the new console. Run only the ones you use. An update from Settings → Software updates does not change the plugins; run the installers again after any update that changed them, and reload the panel page once.
Uninstall the plugins
bash cpanel-plugin/cpanel/uninstall.sh
bash cpanel-plugin/whm/uninstall.sh # add --purge to also delete the plugin key
bash directadmin-plugin/uninstall.sh # restarts DirectAdmin
The plugin uninstallers do not delete the API key they created inside BackupWall; delete it under Settings → API keys.