Please bear in mind that this guide only explains how to install Acronis BackUp third-party Plugin. Additionally, there is 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.
- System requirements:
-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)
This command runs the installation script.
- Installing the backup agent:
- Register beta account. The registration form: http://www.acronis.com/en-us/support/beta-cloud/register-partner.html
- Create a New Customer group under the Partner account previously created. Remember the username / password you created as it will be needed during the plugin installation.
- Once you have created the new Customer group, log in to WHM as root and navigate to Home >> Plugins >> Acronis Backup and install the Backup Agent. When configuring the backup agent, be sure to use the beta URL (https://beta-cloud.acronis.com). Enter the username / password created associated with the customer group and install the agent. Here are the steps again:
1. Log into WHM UI.
2. Click Plugins >> AcronisBackup.
3. 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.
4. Follow the installation wizard. 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 numbers of these ports and the hostnames for which a port should be open. Open the ports, 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 as described in the Installing the backup agent on Virtuozzo host(p. 14)section 12.1 on this document.
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 (p. 17) section on this document.
The backup agent can also be installed by using the command line:
- 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.