Please note, this guide is provided as is, and is guidance directly from Acronis, a third-party software vendor. cPanel Technical Support Staff will be limited in their abilities to assist with the installation of third-party software.
We have no information regarding the provision and configuration of Acronis, as such tasks fall strictly within the responsibilities of a general system administrator and as a result beyond the scope of our support.
The purpose of this guide is purely informational and as such cPanel, LLC will not assume responsibility for any potential adverse outcomes that might arise from its adoption. You may, therefore, wish to seek assistance from a qualified system administrator or Acronis' official support channels regarding this issue, as they would have the tools and knowledge in order to adjust this for you. You can refer to these links for more information:
This document describes how to install and use the Acronis Backup plugin for WHM and cPanel. The plugin integrates WHM and cPanel with Acronis Backup or Acronis Cyber Cloud. With the plugin, a WHM user can:
- Back up an entire cPanel server to the cloud storage with the disk-level backup
- Recover the entire server including all of the websites
- Perform granular recovery of websites, individual files, mailboxes, mail filters, mail forwarders, accounts, and databases, including the databases created outside of WHM
- Enable self-service recovery for cPanel accounts once the plugin is installed and configured, the server is backed up on a predefined schedule.
A backup can also be started on demand. The backup schedule can be configured in the Acronis web console. Recovery can be performed from the WHM and cPanel interfaces. It is not possible to back up individual websites. However, the rights for self-service recovery can be granted to each account separately.
- PHP version 5.6 or later.
- Granular recovery of databases is supported only for local MySQL. Granular recovery of PostgreSQL databases is not supported.
- Besides the plugin, a backup agent must be installed on the same machine. If cPanel is running on a Virtuozzo container, the backup agent must be installed on the Virtuozzo host instead of the container.
Installing the plugin
To install the Acronis Backup plugin for WHM and cPanel, run the following command:
sh <(curl -L https://download.acronis.com/ci/cpanel/stable/install_acronis_cpanel.sh || wget -O - https://download.acronis.com/ci/cpanel/stable/install_acronis_cpanel.sh)
Installing the backup agent
First, register beta account here: http://www.acronis.com/en-us/support/beta-cloud/register-partner.html
Next, create a New Customer group under the Partner account previously created. Remember the username and password you created as it will be needed during the plugin installation.
After the Customer Group has been created, you need to set up the backup agent:
Log into WHM
Click Plugins >> AcronisBackup.
Specify the credentials of the account to which the machine should be assigned. Make sure that you specify the credentials of an account created within the customer group (Customer administrator, Unit administrator, or User). Do not specify partner administrator credentials.
Follow the on-screen prompts.
During the installation, the software checks if the ports required for communication with the cloud are open. If some of the ports are closed, the software shows the hostnames and ports the software needs to access.
If you need to open ports, do so, then close the wizard and restart the installation. Completing the installation may take several minutes. You can leave the page during this process.
To back up the Virtuozzo container, the backup agent must be installed on its host.
If you have enabled two-factor authentication (2FA) for your Acronis Cyber Cloud account, the backup agent must be installed according to the instruction provided in the Installing the backup agent using a registration token section of Acronis' documentation.
Uninstalling the plugin
To uninstall the Acronis Backup plugin for WHM and cPanel, run the following command:
yum remove acronis-backup-cpanel
Removing the extension will also uninstall the backup agent from the cPanel server. The backup accounts you created and the backed-up data will be left intact.
Enable Self-Service Recovery
To enable self-service recovery for cPanel users, Acronis Backup must be enabled in for them in Feature Manager.