Comet Backup

Valid for versions 110 through the latest version

Version:

110

Last modified: 2026 January 22


Looking for this interface?
Note:

Your hosting provider can enable or disable this interface for resellers in WHM's Edit Reseller Nameservers and Privileges interface (WHM >> Home >> Resellers >> Edit Reseller Nameservers and Privileges).

Overview

Note:

WebPros International, LLC currently provides this feature in a limited release, with plans to expand its availability and functionality in future updates.

The Comet Backup interface allows you to easily back up and restore your users’ files, directories, and databases. This interface uses Comet Backup technology and WebPros Storage (powered by Wasabi) to provide data protection for disaster recovery and business continuity.

Important:

To use this interface, you must already have a Comet Backup license and a WebPros Account.

Activate Comet Backup

The first time that you access the Comet Backup interface, the Get Started with Comet Backup interface appears. To activate Comet Backup, perform the following steps:

  1. Click Activate Comet Backup. The Authentication Required interface appears.
  2. Click Authenticate with WebPros Account, then log in to your WebPros Account. The Select Storage Region interface appears.
    Note:

    Depending on your server’s license type, this interface may not appear. For more information, read our How to Purchase a Comet Backup License documentation.

  3. Select a storage region for the backups. For optimal performance, we recommend that you select the region that is closest to your server.
    Important:

    You cannot change the region after you activate Comet Backup.

  4. Click Continue Activation to activate Comet Backup. An Activation in Progress message appears. The message changes to Activation Complete after the process completes.
  5. Click Download Credentials to download your server’s credentials, then click Create Your First Backup Job to create a backup job.
    Warning:

    We strongly recommend that you download and store the server’s credentials in a safe and secure location. You must use these credentials to restore your backups. If you do not have these credentials, you will lose access to the backups because the credentials are part of the backup data’s encryption.

Create a backup job

The Create Backup Job interface allows you to create a simple backup configuration. To create a new backup job, click Create Backup Job. The Create Backup Job interface appears and displays the General Settings section.

Note:

If you need to return to a previous section before you create the backup job, click Previous Step.

General Settings

In the General Settings section, perform the following steps:

  1. Enter a name for the backup in the Backup Name text box and an optional description in the Backup Description text box.
  2. Select either the Manual or Scheduled backup type. If you select the Scheduled backup type, you must also select the backup frequency:
    • Daily — Select this option to run the backup every day.
    • Weekly — Select this option to run the backup every week, then select the days of the week that the backup will run.
    • Monthly — Select this option to run the backup every month, then select the dates of the month that the backup will run.
  3. Click Next Step. The Backup Options section appears.

Backup Options

In the Backup Options section, perform the following steps:

  1. Under the Backup Contains: heading, select the parts of the backup to save:
    • Account Configuration — The account data that is not in the home directories or databases.
    • Home Directory Files — The account home directories.
      • Include Email Contents — The account emails.
      • Exclude Junk Email Folder — The account emails that are not in the Junk folder.
    • Databases — The account databases.
  2. Under the Account Filters: heading, select the accounts to back up:
    • All — Back up all accounts.
    • Advanced — Select the accounts to back up.
  3. Under the Directories and Files to Exclude: heading, select whether to exclude directories and files from the backup:
    • No Exclusions — Do not exclude any directories or files.
    • Customize Exclusions — Exclude directories or files. Add a regular-expression pattern to match the directories or files to exclude from the backup. For example, to exclude temporary and log files from the backup, enter *.log *.tmp in the Add Customize Exclusions text box.
  4. Click Next Step. The Destinations section appears.

Destinations

Supported backup destinations

Comet Backup supports these backup destinations:

  • WebPros Storage — Back up to secure, reliable offsite storage. This is the recommended and default option.
  • Local Storage — Back up to a directory on a local server. The directory must reside on your cPanel & WHM server.
    Warning:

    This option offers limited protection and could result in data loss if the server fails.

Configure backup destinations

To configure your backup destinations, perform the following steps in the Destinations section:

  1. For each destination where you wish to store backups, click Activate.
    • If you select the Local Storage destination, enter the storage name, an optional description, and the path to the local server’s backup directory, then click Create Local Storage.
    • Depending on your server’s license, either the Local Storage or WebPros Storage destination may appear as the only destination option.
    • If you do not set up local storage, the WebPros Storage destination is the only destination option.
  2. Select the backup destinations that you have activated.
  3. Click Next Step. The Summary section appears.

Summary

In the Summary section, perform the following steps:

  1. Review the backup configuration that you created. To change any of the settings, click Edit in the section for that setting.
  2. To create the backup job, click Create Backup Job.
    Note:

    If you do not want to run the backup now, deselect Run backup now before you click Create Backup Job.

Display backup jobs

The Comet Backup interface displays the name of each backup job, along with information about its status, backup times and frequency, storage, and accounts and parts to back up. For example, this image displays the Daily account backups backup job:

Backup job information

These items display the following information about the Daily account backups backup job:

Item Information
Backup completed The backup completed successfully.
Backup enabled The backup job is enabled.
Last backup run The backup job last ran nine minutes ago.
Next backup run The backup job will run again in one day.
Note:
Clicking the time displays the exact date and time.
Destination and storage region The backup job backs up to the WebPros Storage destination in the us-central-1 storage region.
Note:
  • Clicking the destination name shows the amount of used and available storage space.
  • If you have set up more than one destination, the interface also displays a plus icon (Plus icon) and the number of additional destinations.
Daily The backup job runs daily.
All Accounts The backup job backs up all accounts.
Databases +2 The backup job backs up the account databases and two other parts.
Note:
Clicking Databases +2 shows the parts that the job backs up.

Search for backup jobs

You can search for backup jobs by entering either part of the backup job’s name or its frequency in the Search for backup jobs… text box. The interface displays all backup jobs that match the name or frequency that you entered.

Filter backup jobs

You can filter the backup jobs that the interface displays by clicking the filters icon (Filters icon), then selecting at least one of the following filters:

  • Status — Select either Enabled or Disabled backup jobs.
  • Process — Select one of the following process states:
    • Completed — The backup job has completed.
    • Cancelled — The system cancelled the backup job.
    • Cancelling — The system is cancelling the backup job.
    • Running — The backup job is running.
    • Starting — The backup job is starting.
    • Failed — The backup job failed.
    • None — No processes exist for the backup job.
  • Schedule — Select either Daily, Weekly, or Monthly backup jobs.

You can also order the display of the backup jobs by selecting one of the following filters:

  • Name — Order alphabetically by the backup-job name. Select either ascending (A-Z) or descending (Z-A) order.
  • Last Run — Order by the time of the last backup run. Select either ascending (oldest) or descending (most recent) order.
  • Next Run — Order by the time of the next backup run. Select either ascending (soonest) or descending (farthest in future) order.

Perform actions on backup jobs

You can perform actions on each of the backup jobs by clicking the action icon (Action icon) in the row for that job, then selecting one of the following options:

  • History — Display the history for the backup job.
  • Run Now — Manually run the backup job now.
    Note:

    This option does not appear for disabled backup jobs.

  • Modify — Make changes to the backup job configuration.
  • Duplicate — Make a copy of the backup job.
  • Disable or Enable — Disable or enable the backup job.
  • Delete — Delete the backup job.
    Note:

    If you delete a backup job, its backups will stay on the server. They may still appear in the backup-run history.

History

The Backup History section of the interface displays the following information for each backup run:

  • Job Name — The name of the backup job.
  • Start Time — The time that the backup started.
  • Job Type — Whether the backup ran automatically or manually.
  • Execution Time — How long the backup took to run.
  • Size — The size of the backup.
  • Status — Whether the backup completed or failed.

You can perform actions on each backup run by clicking the action icon (Action icon), then selecting one of the following options:

  • View Log — View a log and summary of the backup run.
  • Restore — Restore the backup from the run.
  • Download — Download the backup from the run.
  • Delete — Delete the entry from the history.

Restore a backup

To restore a backup, perform the following steps:

Note:

If you need to return to a previous section before you run the restore, click Previous Step.

  1. Click Restore Backup. The Restore Backup Job interface appears.
  2. Select the quantity of accounts to restore:
    • Single Account — Restore a single account.
    • Multiple Accounts — Restore more than one account.
  3. Select the accounts you wish to restore, then click Next Step.
  4. If you selected the Single Account option, select one of these restore types:
    • Full — Restore a full backup. Select the backup to restore.
    • Custom — Customize the backup. Select the parts of the backup to restore, along with the backup for each part:
      • Account Configuration — The account data that is not in the home directory or databases.
      • Databases — The account databases.
      • Home directory — The account home directory.
        • Include Email — The emails in the home directory.
  5. Click Next Step.
  6. Review the restore configuration. To change any of the settings, click Edit in the section for that setting.
  7. Click Restore Backup, then click Yes, I’m sure to confirm starting the restoration process. A Backup Restore in Progress message appears. The message changes to Backup Restore Complete after the restore completes.
  8. Click Copy or Download to copy or download the restore log file, or click Close to return to the main interface.
Warning:

If you select either the Multiple Accounts option or the Single Account option with the Full option, the system will restore full backups. This process will overwrite existing files, and you cannot recover them.

Additional Documentation