Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Localtab Group


Localtab
activetrue
titleAdditional Local Directory


SettingDescription
Destination Name

Required

Enter a destination name for your backup file. This name appears in your destination table.

Transfer System Backups to this Destination

Select this checkbox to transfer system backups to this additional destination.

Backup Directory

Required

Enter the directory path, relative to the account's home directory, in which you wish to store backups.

Mount Backup Drive as Needed

Select the checkbox to mount a backup drive. This setting requires a separate mount point and causes the Backup Configuration process to check the /etc/fstab file for a backup mount.

If a mount exists with the same name as the staging directory, the Backup Configuration process mounts the drive and backs up the information to the mount. 

After the backup process completes, the system dismounts the drive. 

If you deselect the checkbox, the Backup Configuration process does not check the /etc/fstab file for a mount.



Localtab
titleAmazon S3™


Warning
titleImportant:

To use this destination type, you must possess an Amazon S3 account. To create an account, follow the directions in Amazon's Sign Up for Amazon S3 documentation.


SettingDescription
Destination Name

Required

Enter a destination name for your backup files. This name appears in your destination table.

Transfer System Backups to this Destination

Select this checkbox to transfer system backups to this additional destination.

Warning
titleWarning:

Only transfer system backup files over encrypted connections.


Folder

Enter the name of the directory where you wish to store backups.

Bucket

Required

Enter the name of the bucket in which you wish to store your backup.

Note
titleNote:

You must first create your bucket in the Amazon S3 management console.


Access Key ID

Required

Enter the access key ID in this text box. Your server uses the access key to authenticate with the Amazon S3 account.

Note
titleNote:

For more information about access keys for Amazon S3, read Amazon's Managing Access Keys for Your AWS Account documentation.


Secret Access Key

Required

Enter the secret access key in this text box.

Note
titleNote:

For more information about secret access keys for Amazon S3, read Amazon's Managing Access Keys for Your AWS Account documentation.


Timeout

Required

The maximum amount of time, in seconds, that you want the server to wait for a response from the remote server before it generates errors.

  • You must enter a number between 30 and 300.
  • If the server does not respond before the time expires, it makes two additional attempts to contact the server.
  • If the server does not respond after those attempts, the system administrator receives an email that notes the failed attempts. The system will retry the transfer when it runs the backup process again.



Localtab
titleCustom


Warning
titleWarning:

We strongly recommend that only advanced users create custom backup destinations.


SettingDescription
Destination Name

Required

Enter a destination name for your backup files. This name appears in your destination table.

Transfer System Backups to this Destination

Select this checkbox to transfer system backups to this additional destination.

Warning
titleWarning:

Only transfer system backup files over encrypted connections.


Script

Required

Enter your custom transport script's absolute path.

Note
titleNote:

For more information on custom transport scripts, read the How to Create a Custom Transport Script for Backups documentation.


Backup Directory

Required

Enter the directory path, relative to the account's home directory, in which you wish to store backups.

Remote Host

Required

Enter the hostname or IP address of the remote server.

Warning
titleImportant:
  • Do not include http://, https://, a trailing port, or path information.
  • Do not use local hosts or loopback addresses.


Remote Account Username

Required

The username of the account on the remote server.

Remote Password

Required

The password for the account on the remote server. Unless you specify a new password, your server will use the existing password.

Timeout

Required

The maximum amount of time, in seconds, that you want the server to wait for a response from the remote server before it generates errors.

  • You must enter a number between 30 and 300.
  • If the server does not respond before the time expires, it makes two additional attempts to contact the server.
  • If the server does not respond after those attempts, the system administrator receives an email that notes the failed attempts. The system will retry the transfer when it runs the backup process again.



Localtab
titleFTP


Warning
titleWarnings:
  • Include Page
    LIB:_FTP Server Backups
    LIB:_FTP Server Backups
  • We strongly recommend that you use Pure-FTPD or ProFTPD on remote FTP servers. Unexpected results may occur with some FTP server software.

    • If you use Pure-FTPD, ensure that the DisplayDotFiles yes statement resides in the /etc/pure-ftpd.conf file.
    • If you use Pro-FTPD, ensure that the ListOptions -a statement resides in the /etc/proftpd.conf file
  • If you use the Very Secure FTP daemon (vsftpd), ensure that you set the force_dot_files setting to yes in the /etc/vsftpd.conf file. For more information about vsftpd, read the vsftpd documentation.


SettingDescription
Destination Name

Required

Enter a destination name for your backup file. This name appears in your destination table.

Transfer System Backups to this Destination

Select this checkbox to transfer system backups to this additional destination.

Warning
titleWarning:

Only transfer system backup files over encrypted connections.


Backup Directory

Enter the directory path, relative to the account's home directory, in which you wish to store backups.

Note
titleNote:

This setting is optional.


Remote Host

Required

Enter the hostname or IP address for the remote server.

Warning
titleImportant:
  • Do not include http://, https://, a trailing port, or path information in the address that you enter.
  • Do not use local hosts or loopback addresses.


PortEnter the port to use to communicate with the remote server. By default, FTP destinations use port 21.
Remote Account Username

Required

Enter the username of the account on the remote server.

Remote Password

Required

Enter the password for the account on the remote server.

Timeout

Required

The maximum amount of time, in seconds, that you want the server to wait for a response from the remote server before it generates errors.

  • You must enter a number between 30 and 300.
  • If the server does not respond before the time expires, it makes two additional attempts to contact the server.
  • If the server does not respond after those attempts, the system administrator receives an email that notes the failed attempts. The system will retry the transfer when it runs the backup process again.

Passive FTP

Select whether to use passive FTP.

Note
titleNote:

FTP servers behind NAT firewalls require this setting.




Localtab
titleGoogle Drive™


Warning
titleImportant:

To use this destination type, you must possess a Google Drive account. To create a Google Drive account, visit the Google® Create your Google Account page.

For more information about how to use Google Drive for backup transfers, read our How to Set Up the Configure Google Drive APIas a Backup Additional Destination documentation.

SettingDescription
Destination Name

Required

Enter a destination name for your backup files. This name appears in your destination table.

Transfer System Backups to this Destination

Select this checkbox to transfer system backups to this additional destination.

Warning
titleWarning:

Only transfer system backup files over encrypted connections.


Folder

Enter a directory where you would like to store backups, relative to the remote account's directory root. The system will store backups under this directory in subdirectories which use a date-based naming convention.

Client ID

Required

Enter the client ID for the access credentials.

Client secret

Required

Enter the client secret for the access credentials.

Generate CredentialsClick this button to generate the necessary credentials from your client ID and client secret.
Timeout

The maximum amount of time, in seconds, that you want the server to wait for a response from the remote server before it generates errors.

  • You must enter a number between 30 and 300.
  • If the server does not respond before the time expires, it makes two additional attempts to contact the server.
  • If the server does not respond after those attempts, the system administrator receives an email that notes the failed attempts. The system will retry the transfer when it runs the backup process again.



Localtab
titleRsync


Note
titleNote:

You can only use the Rsync transport with incremental backups.


SettingDescription

Destination Name

Required

Enter a destination name for your backup files. This name appears in your destination table.

Transfer System Backups to this Destination

Select this checkbox to transfer system backups to this additional destination.

Backup Directory

Enter the directory path, relative to the account's home directory, in which you wish to store backups.

Remote Host

Required

Enter the hostname or IP address of the remote server. 

Warning
titleImportant:
  • Do not include http://, https://, a trailing port, or path information in the address that you enter. 
  • Do not use local hosts or loopback addresses.


Port

The port to use to communicate with the remote server. By default, Rsync destinations use port 22

Remote Account Username

Required

The username for the account on the remote server.

Authentication Type

Required

Select how you wish to authenticate to the remote server:

  • Key Authentication — Select this option to use key-based authentication. We strongly recommend that you use this method.
  • Password Authentication — Select this option to use password-based authentication.

Key Authentication Options

If you selected Key Authentication for the Authentication Type setting, perform the following actions:

Enter the full path of the private key on this server in the Private Key text box.

  1. Click on a key's name in the Private Keys list to add that private key's filepath to the Private Key text box.

  2. To generate a new private key, click Generate a New Key and then Generate Key. A success message will appear at the bottom of the interface.

  3. The private key resides in the /root/.ssh/keyname file, where keyname represents the key's name. The private key's corresponding public key resides in the /root/.ssh/keyname.pub file.

Enter the passphrase for this server in the Passphrase text box.

Password Authentication Options

If you selected Password Authentication for the Authentication Type setting, enter the password for the account on the remote server in the Remote Password text box.
Timeout

Required

The maximum amount of time, in seconds, that you want the server to wait for a response from the remote server before it generates errors.

  • You must enter a number between 30 and 300.
  • If the server does not respond before the time expires, it attempts to contact the server two additional times.
  • If the server does not respond after those attempts, the system administrator receives an email that notes the failed attempts. The system will retry the transfer when it runs the backup process again.

Note
titleNote:

The interface currently only recognizes the default value of 30 seconds.




Localtab
titleS3 Compatible


Warning
titleImportant:

To use this destination type, you must possess an account with your S3-compatible provider.


SettingDescription
Destination Name

Required

Enter a destination name for your backup files. This name appears in your destination table.

Transfer System Backups to this Destination

Select this checkbox to transfer system backups to this additional destination.

Warning
titleWarning:

Only transfer system backup files over encrypted connections.


Folder

Enter the name of the directory where you wish to store your backup.

S3 Endpoint

Required

Enter the fully qualified domain name (FQDN) for the remote server where your bucket resides.

Note
titleNote:

The system backs up files to the destination server through a secured connection via SSL/TLS. The FQDN that you enter must be the same as the FQDN on the server's SSL/TLS certificate, or the connection will fail.


Bucket

Required

Enter the name of the bucket where you wish to store your backup.

Note
titleNote:

You must first create the bucket through your S3-compatible provider.


Access Key ID

Required

Enter the access key ID in this text box. Your server uses the access key to authenticate with your S3-compatible account.

Note
titleNote:

You must first generate an access key ID through your S3-compatible provider.


Secret Access Key

Required

Enter the secret access key in this text box.

Note
titleNote:

You must first generate a secret access key ID through your S3-compatible provider.


Timeout

Required

The maximum amount of time, in seconds, that you want the server to wait for a response from the remote server before it generates errors.

  • You must enter a number between 30 and 300.
  • If the server does not respond before the time expires, it makes two additional attempts to contact the server.
  • If the server does not respond after those attempts, the system administrator receives an email that notes the failed attempts. The system will retry the transfer when it runs the backup process again.



Localtab
titleSFTP


SettingDescription
Destination Name

Required

Enter a destination name for your backup file. This name appears in your destination table.

Transfer System Backups to this Destination

Select this checkbox to transfer system backups to this additional destination.

Warning
titleWarning:

Only transfer system backup files over encrypted connections.


Backup Directory

Required

Enter the directory path, relative to the account's home directory, in which you wish to store backups.

Remote Host

Required

Enter the hostname or IP address of the remote server. 

Warning
titleImportant:
  • Do not include http://, https://, a trailing port, or path information in the address that you enter. 
  • Do not use local hosts or loopback addresses.


PortEnter the port to use to communicate with the remote server. By default, SFTP destinations use port 22.
Remote Account Username

Required

Enter the username of the account on the remote server.

Authentication Type

Required

Select how you wish to authenticate to the remote server:

  • Key Authentication — Select this option to use key-based authentication. We strongly recommend that you use this method.
  • Password Authentication — Select this option to use password-based authentication.

Key Authentication Options

If you selected Key Authentication for the Authentication Type setting, perform the following actions:

Enter the full path of the private key on this server in the Private Key text box.

  1. Click on a key's name in the Private Keys list to add that private key's filepath to the Private Key text box.

  2. To generate a new private key, click Generate a New Key and then Generate Key. A success message will appear at the bottom of the interface.

  3. The private key resides in the /root/.ssh/keyname file, where keyname represents the key's name. The private key's corresponding public key resides in the /root/.ssh/keyname.pub file.

Enter the passphrase for this server in the Passphrase text box.

Password Authentication Options

If you selected Password Authentication for the Authentication Type setting, enter the password for the account on the remote server in the Remote Password text box.

TimeoutThe maximum amount of time, in seconds, that you want the server to wait for a response from the remote server before it generates errors.
  • You must enter a number between 30 and 300.
  • If the server does not respond before the time expires, it makes two additional attempts to contact the server.
  • If the server does not respond after those attempts, the system administrator receives an email that notes the failed attempts. The system will retry the transfer when it runs the backup process again.



Localtab
titleWebDAV


SettingDescription
Destination Name

Required

Enter a destination name for your backup files. This name appears in your destination table.

Transfer System Backups to this Destination

Select this checkbox to transfer system backups to this additional destination.

Warning
titleWarning:

Only transfer system backup files over encrypted connections.


Backup Directory

Required

Enter the directory path, relative to the account's home directory, in which you wish to store backups.

Remote Host

Required

Enter the hostname or IP address of the remote server. 

Warning
titleImportant:
  • Do not include http://, https://, a trailing port, or path information in the address that you enter. 
  • Do not use local hosts or loopback addresses.


Port

The port to use to communicate with the remote server.

By default, WebDAV destinations use port 80. Secure connections use port 443.

cPanel & WHM uses port 2077 for non-SSL connections and port 2078 for SSL connections.

SSL Enabled

Select this checkbox to enable SSL. WebDAV destinations require that you enable SSL encryption.

Remote Account Username

Required

The username for the account on the remote server.

Remote Password

Required

The password for the account on the remote server.

Timeout
The maximum amount of time, in seconds, that you want the server to wait for a response from the remote server before it generates errors.
  • You must enter a number between 30 and 300.
  • If the server does not respond before the time expires, it makes two additional attempts to contact the server.
  • If the server does not respond after those attempts, the system administrator receives an email that notes the failed attempts. The system will retry the transfer when it runs the backup process again.

Note
titleNote:

The interface currently only recognizes the default value of 30 seconds.




...