Cpremote have a feature rich administration interface available in WHM. Only root user have the privilege to access the whm interface. There is no reseller interface available at this moment.It is a todo for next major release.
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 |
| Continuous Data Protection (CDP) | You can enabled Cpremote CDP server | Disable , enable |
| General Data Protection Regulation(GDPR) | Enable GDPR encryupted backups | Disable , enable |
| User Storage Pool | To enable cpanel end user storage pools | Disable , enable |
| Allow User Schedule | Allow cpanel user to schedule backups | Disable , enable |
| 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. |
| Backup System Files | To backup the system files. It works along with the default backup schedule | Enable , disable |
| Backup Entire Mysql Directory | Take backup of all mysql databases. It works along with the default backup schedule | Enable , disable |
| Backup Suspended accounts | To manage suspended accounts backups | Enable or disable |
| Clean The Backups | To constrol your storage pool size. How many days you need to keep the backups | Enter the number of days |
| 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 |
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.
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;-
root@galaxy:$ cd /usr/local/cpanel/whostmgr/cgi/cpremote/languages cp language_en.php language_de.php
root@galaxy:$ 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 and backups from WHM -> Cpremote -> List all -> List Accounts (Enable / Disable Backups ). 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.
From this menu you can view all your storage pools backups. There is also an option to restore the backups and view the backup details. Each storage pools will list backups of all schedules. Due to the large amount of data the last 7 days backups will be listed. You can change the list days by customising cpremote core configuration file from /usr/local/cpremote/lib/cpremote/conf.py
From this menu you can view all your scheduled job backups. There is also an option to restore the backups and view the backup details. Each schedule will list all backups. Due to the large amount of data the last 7 days backups will be listed. You can change the list days by customising cpremote core configuration file from /usr/local/cpremote/lib/cpremote/conf.py
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
There are two type of restore options available
The different restore options are explained below. All these restore options can also be done from the server terminal using the command line cpremotectl
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.
This is a unique feature of cpremote . You can search any backup and restore with a single click
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
This option will restore a database of an account from the chosen backup. You can select the database name or enter the name.
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.
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,
You can restore the DNS zone of every domain
You can restore the cron jobs of users
This option will allow restore of deleted email account
This option will allow restore of deleted databases
This is a new feature in cpremote. You can schedule backup downloads. This option will allow you to view the download logs and download progress.
This option will allow you to download backups to a specific server location. You can chose individual backups or bulk backup downloads
This option will show you the progress and status of backup download. The details include backup the task id,backup id , cpanel user , where is downloaded , Time and date of download job, status and the log file.You can also delete the download progress logs.
This option show the log files of your download schedule. You can download the log file itself or delete the log file.
The new cpremote have unlimited schedule options with a lots of schedule category. You need to enable the default schedule to start the backup process. There are lots of schedule option available they are,
This option will list all your schedules. You also run the backups instantly. The additional clone schedule feature will help you to clone a schedule with a different time. You can also delete schedules. There is also an option to listthe backups from schedule
To access the default backup schedule go to WHM -> Cpremote -> Schedule backup -> Create Default Backup Schedule
The terms and values are explained below,
| Term | Description | Values |
|---|---|---|
| Default Backup Status | To enable or disable backup status | Disable , enable |
| Select Backup Schedule Time | Select a backup time | Enter the time |
| Backup Type | The type of the backup | incremental,compressed,archived |
| Upload User Backup(s) Copy To User Pool | Place a copy into user storage pool if available | Disable , enable |
| 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 Backup Status | Enable the daily backup status | Disable,Enable |
| 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, |
You can schedule individual users full cpanel backups from this option. Select the user set the schedule time and select storage pools.
If you need to take a regular database backup for a specific database. This option will help you
This option will help you to schedule database backups of all databases
You can schedule and individual email address backup
You can schedule all email accounts backups
This option will help to schedule dns bakup of a domain
This option will help you to schedule all dns backups
You can configure a per user cron job backup schedule
This option will help you schedule all cron job
This option will help you to schedule backup a specific website
You can set a folder backup in this option. Any folder in your server can be chosen. You can also assign a user to that folder so that those users can restore those backups.
The cpremote task manager will help to monitor the task and track each tasks. All restore , transfer or download tasks will be logged and monitored here.
The list jobs option in Task manager will help you to see the specific tasks. Each ask can be identified as unique task id. You can view the pid, task details, start time, end time , status. You can also delete the task files. To stop a task , you may kill the specific pid.