Cpremote have a feature rich administration interface available in WHM. Only root user have the privilege to access the whm interface.

To access the settings go to WHM -> Cpremote -> Preferences -> Settings

The terms and values are explained below,

Term Description Values
Backup Status To enable or disable backup status Disable , enable
Backup Type The type of the backup Incremental, compressed, uncompressed
Parallel Backups To enable multi threaded parallel backups that will speed up backup operations Enable , Auto and Custom. The Auto will select automatic number of parallel backups. You can set a custom number of parallel backups too. This number will be used as a parallel backup count.
Daily Backups To enable daily backups Enable or disable
Daily Storage Pool To choose which storage pool you need to store the backups. All Pools will upload backups to all of your storage pools All pools, Pool name
Weekly Backup Status Enable or disable weekly backups Enable , disable
Weekly Storage Pool To choose which storage pool you need to store the backups. All Pools will upload backups to all of your storage pools All Pools, Pool name
Week Day to run the weekly backup Choose the week day in which you need to run the weekly backups Sunday , Monday etc,.
Monthly Backup Status To enable monthly backups for your server Enable , Disable
Monthly Backup Storage Pool To choose which storage pool you need to store the backups. All Pools will upload backups to all of your storage pools All Pools, Pool name
Date in which monthly backup need to run Select the monthly day option in which you need to run the backups 1st of the month , 15th of the month or 28th of the month
Retention Backups Status To enable 7 days retention backup system Enable or disable
Retention storage Pools To choose which storage pool you need to store the backups. All Pools will upload backups to all of your storage pools All Pools, Pool name
Select backup days The days in which retention backups need to perform Sunday , Monday ,etc,
Backup System Files To backup the system files. It works according to the daily, weekly, monthly and retention choice Enable , disable
Backup Entire Mysql Directory Take backup of all mysql databases. It works according to the daily, weekly, monthly and retention choice. Individual accounts will have a separate backup too. Enable , disable
Backup Suspended accounts To manage suspended accounts backups Enable or disable
Keep Terminated Accounts backups You can choose how many days cpremote need to keep the backups of terminated account. Next day or enter the number of days

You need to configure at least one storage pools for cpremote. You can configure any number of storage pools and have the choice to select the storage. This distributed storage pool feature is a unique backup storage feature of cpremote. Cpremote support Local Disk, FTP, SFTP, SSH and Amazon S3.

Local Disk Storage :

This is one of the fastest storage option. You can attach separate disk to your server and configure it as a storage pool.

Field Description Value / Sample
Pool name The name of the pool sda
Path The path to mount point of the disk /backup

Local disk storage support incremental, compressed and uncompressed backups. It helps to copy every files.

Local disk storage pool can also be used as a disaster storage pool.

Remote SSH:

You can configure a remote ssh account to store the backups. It is better to add a nearest ssh account in same LAN to get more speed. SSH is configured using ssh keys. You can deploy ssh key server manually or using the following command .

    
        # cpremotectl deploy sshkey
    
  
Field Description Value / Sample
Pool name The name of the pool foossh
Hostname Ssh account hostname or IP ssh.foo.com
Port number Ssh port number 22
User Ssh user name foo
Path Home directory of ssh user /home/foo

Remote ssh storage pool support incremental, compressed and uncompressed backups. It will copy every files. Remote ssh pool can be used as a disaster storage pool too.

Remote FTP:

You can configure a ftp account to store backups. It is better to add a nearest ftp server in same LAN to get more speed.

Field Description Value / Sample
Pool name The name of the pool fooftp
Hostname FTP hostname or IP ftp.foo.com
Port number FTP port number 21
User FTP user name foo
Password FTP user password foopassword123
Path FTP user folder /home/foo

Remote FTP storage pool also support incremental, compressed and uncompressed backups. If you choose incremental backups, then soft-links will be excluded from the backup process. You can’t use ftp pool for disaster storage pool.

Remote SFTP:

You can configure a remote sftp account to store the backups. It is better to add a nearest sftp account in same LAN to get more speed.

Field Description Value / Sample
Pool name The name of the pool foosftp
Hostname SFTP hostname or IP sftp.foo.com
Port number SFTP port number 22
User SFTP user name foo
Password SFTP user password foopassword123
Path SFTP user folder /home/foo

Remote SFTP storage pool support incremental, compressed and uncompressed backups. If you choose incremental backups, then soft-links will be excluded from the backup process. You can’t use sftp pool for disaster storage pool.

Amazon S3:

You can configure an amazon S3 account as storage pool.

Field Description Value / Sample
Pool name The name of the pool s3
AWS Access Key Aws access key mykey
AWS Secret Access Key Aws secret key mysecretkey
Bucket Name Name of your S3 bucket cpremote
User Name Aws s3 user foo
Folder Name A folder name inside the s3 bucket my.server.com

Amazon S3 storage pool support compressed and uncompressed backups. It doesn’t support incremental backups due to file name restrictions in S3. You can’t use this pool for disaster storage.

Cpremote have a number of alert management options. You can control the alerts yourself. To configure the alerts go to WHM -> Cpremote -> Preferences -> Alert Management

Item Description Value
Cpremote Alerts To enable or disable cpremote alerts Enable or Disable
Cpremote Admin Alert Email The admin email address to which backup alerts have to be send Enable or Disable
Storage Pool Failure Alerts Inform you if a storage pool fails Enable or Disable
Backup Completion Alerts Send alert during backup completion Enable or Disable
Account Backup Creation Failure Notifications Send alert if backup creation failed for a cpanel account Enable or Disable
Account Backup Upload Failure Notifications Send alerts if an account backup upload fail in a pool Enable or Disable
MySql Server Connection Error Alerts Send alerts if connection to your mysql server is failed Enable or Disable
Inactive Storage Pool Alerts Send alerts if you configured an inactive storage pool in backup Enable or Disable
Send backup restore alert notification to cpanel users’ contact email address Send restore alerts to the cpanel users contact email address Enable or Disable

Cpremote provides a set of alert template files inside the folder /etc/cpremote/templates/ . You can edit the template files as you wish.

This is a unique feature of the cpremote software. You can backup your entire server’s Operating system into another local disk or over an ssh account. This option will sync everything . This will be helpful to restore your data at the time of a disaster. It is recommended to add a secondary HDD to store the OS backups. You may probably need double the size of your current disk usage in a storage pool.

Disaster management only support Local Storage Pools and SSH Pools.

You can configure Daily and Weekly Disaster backups.

Item Description Value
Disaster Management Enable or Disable the Disaster backups Enable or Disable
Backup Home Dir Choose whether you need to backup /home partitions Enable or Disable
Exclude Root Directories from sync You can exclude a particular folder under / . The folders like /proc , /sys, /run , etc will be automatically excluded. Comma separated folder name under / . No slashes.
Daily Backup Status Enable Daily disaster backups Enable or Disable
Daily Storage Pool Select the Daily storage pool Pool name
Weekly Backup Status Enable Weekly Disaster backups Enable or Disable
Weekly Storage Pool Select the weekly storage pool Pool name
Week Day to run the weekly backup Select the day of the week in which you need to take the backup Day names

All Disaster backups are incremental backup . This will help to increase the speed and update only modified files.

Cpremote supports multiple languages. If the language file is available, it will be automatically detected during login time. You can manage the languages from WHM -> Cpremote -> Preferences - > Languages

To create language, use the English language file /usr/local/cpanel/whostmgr/cgi/cpremote/languages/language_en.php

To create a German language file do as follows;-

    
        # cd  /usr/local/cpanel/whostmgr/cgi/cpremote/languages/
        # cp  language_en.php  language_de.php
    
  

Now edit the file language_de.php

After that go to WHM -> Cpremote -> Preferences - > Languages and add the language

This language is for only WHM.

You can list all cpanel accounts from WHM -> Cpremote -> Accounts -> List account. From here you can enable or disable backups of individual cpanel accounts. You can also see the disk size of each cpanel accounts. If you don’t see the disk size it will be updated during next backup time.

All your active storage pools and its per account backups status will be listed here. You can see the individual cpanel accounts’ daily, weekly, monthly and retention backups in each pools with the backup name.

You can also see the date in which backup is taken and the size of the backup file. It will be automatically updated during every backup time.

This is another important feature of cpremote. You can have a number of restore choice with cpremote backups. To see the options go to WHM -> Cpremote -> Restore backups

The different restore options are explained below. All these restore options can also be done from the server terminal using the command line cpremotectl

Restore Full Accounts:

This option will restore Full account backups. It will overwrite an existing cpanel account and its files with the chosen backup. You can also choose multiple accounts and do a parallel restore. Parallel restore will work if you enabled parallel backups in settings.

Domain Restore :

You can restore a domain or subdomain using this option. It will synchronize the chosen domain with the chosen backup. Before restoring a domain, you need to make sure that domain exist under that specific cpanel user ; otherwise the domain validation will fail. Domain restore only restore the data, it doesn’t restore the databases. To restore a database you need choose the database restore option as explained below

Database Restore :

This option will restore a database of an account from the chosen backup. You can select the database name or enter the name.

Email Restore :

This option will help you to restore an email account under a cpanel user. You need to make sure that email accounts exist in that cpanel user. Email restore doesn’t delete your new emails. It will only sync the email from the chosen backup with your existing email account.

File or Directory Restore:

You can restore a specific file or directory under cpanel users’ home dir from the selected backup. The given file or path need to obey the following restrictions.

1) The path name doesn’t start with slash (/) or any special characters

2) The path name doesn’t end with slash or any special characters

3) The path name doesn’t contains special characters like & , $ , ! , + ,= , etc,