NOTICE: JetBackup 5 is in the EDGE Tier. Please handle with caution. Any information on this document is subject to change as we continue to develop and push updates.

Settings

This section allows you to configure and finetune your JetBackup settings.

General Settings

General Settings

Debug Active

Enable JetBackup to generate more detailed logs which includes additional informative data and PHP errors.

Error Reporting

When enabled, JetBackup will silently send error reports (email) to JetApps support team. By setting this to "YES", you are helping us find bugs and improve JetBackup.

Workspace Directory

Specify the directory that JetBackup will use to store all the temporary files.
[ default: /usr/local/jetapps/usr/jetbackup/workspace ]
To prevent issues with the system performance, we recommend moving the original folder to the new destination instead of creating a new directory.

Download Directory

Specify the directory that JetBackup will use to store all file and/or directory downloads associated to any accounts.
[ default: /usr/local/jetapps/usr/jetbackup/downloads ]
To prevent issues with system performance, we recommend creating a new directory in the destination and to NOT move the original folder.

Delete orphan backups older than

Orphan backups are account backup files that are not associated with any active account.
JetBackup will automatically remove these backups if they are older than the number of days specified in this field. [ default: 180 days ]

Days to keep logs history

Specify the number of days JetBackup will keep logs. [ default: 30 days ]

Days to keep alerts

Specify the number of days JetBackup will keep alerts. [ default: 60 days ]

Manually Backups Retain

Specify how many copies of backups generated from manually executing a backup job JetBackup will keep.
[ default: 14 backups ]

Manually Backups TTL

Set the number of days JetBackup will keep manually generated backups. [ default: 0 days/disabled ]

Performance

Performance Settings

Concurrent Restore/Download Accounts Tasks

Set the maximum concurrent account restores and/or downloads that can run simultaneously. Please note that for each account, JetBackup will open a fork on the server. (Maximum 10 accounts)

Concurrent Backup Accounts Tasks

Set the maximum concurrent account backups that can run simultaneously. Please note that for each account, JetBackup will open a fork on the server. (Maximum 10 accounts)

Queue Priority Groups

Queue priority groups allows you to specify and group accounts by priority, allowing you to finetune how JetBackup prioritizes tasks for each account. To manage and create queue priority groups, click on "Manage Queue Priority Groups"

Queue Priorities

To add a new queue priority group, click "+Create New Queue Priority". On the subsequent page, specify a unique queue priority group name and corresponding priority value (the lower the value, the higher the priority) then hit "Save"

Add New Queue Priority

For more information on how to set the queue priority for each account(s), please visit Manage Account.

Queue Priority Settings

Queue Priority Settings

Manage Queue Priority

Click on Manage Queue Priority to modify the queue priority settings.

Delete Queue Priority

Click on Delete Queue Priority to delete your queue priority.

Make sure that the queue priority group is not assigned to any account(s) and is not set as the default priority group in order to delete it.

Set as Default

Set the priority group as the default value.

Directory Queue Priority Group

Set the queue priority group for directory-based tasks in relation to accounts queue priority groups.

MySQL Settings

MySQL Dump max allowed packet

The maximum packet length to send to or receive from the server.

MySQL Dump force flag

Continue even if we get an SQL error.

MySQL Dump opt flag

Same as --add-drop-table, --add-locks, --create-options, --skip-opt.

MySQL Dump skip lock table flag

Continue even if we get a lock table error.


Restore

Restore Settings

Restore Conditions

Create conditions that users will be required to accept when executing backup restores.

To create new restore condition, click on "Manage Restore Conditions" and click "Create New Restore Condition" on the following page.

Restore Conditions Page


Specify the condition text that you would like to show in the Restore Action Pane then hit "Save".

Create Restore Condition


File Permissions

Create file permission rules for restoring Homedir and Email files and folders.

To create new File Permissions, click on "Manage File Permissions" and click "Create New File Permission" on the following page.

File Permissions Page


Specify the permission regular expression, file category, restored file and directory ownership(owner and group) and permisssions(file and directory) to be applied and choose whether to apply the permission rule recursively then hit "Save".

Create File Permission


Privacy & Security

Privacy & Security Settings

Server Master Encryption Key

JetBackup uses an encryption key to secure valuable data. This key is required during Disaster Recovery to successfully decrypt and import JB Config backups. Please be advised, there is no way to restore from DR without this key and it's important to keep this key on a secure remote location.

User Agreement

Displays your User Agreement to clients.

Privacy Policy

Displays your Privacy Policy to clients. For client's subject to GDPR, also specify your backup destination information in this section.

Account Encryption Selection

Enable Account Encryption Selection to give clients the option to choose the Backup Type they prefer.

With this option disabled, Encrypted Backups for each account will have their associated Encryption Key stored locally.

The right to be forgotten

Specify the number of days JetBackup will keep backups for TERMINATED accounts, after which ALL DATA associated to the account will be automatically deleted (including backups, logs and etc...). [ 0 to disable ]

Panel

Panel Settings

Default Package

Specify the default package JetBackup will assign when restoring an account if the package information on the account's backup is not found on the panel.

Default IP Address

Specify the default IP address JetBackup will assign when restoring an account if the IP address information on the account's backup is not found on the panel.

Default Owner

Specify the default owner JetBackup will assign when restoring an account if the owner information on the account's backup is not found on the panel.

Notification

Notification Settings

JetBackup comes with the Email Notification Integration installed by default. Click on "Activate" to set up your email notifications.

Email

email notification

Notification Alert Levels

Select which alert types (Information/Warning/Critical) and frequency(Real Time/Once a Day) you would like to receive notifications. For more information about alert types, please visit Alerts.

Recipients

Specify the email address(es) you prefer to send notifications to. Sends to the default server contact e-mail if left blank.

Email Server

Select to either use the Local PHP Mailer or SMTP for JetBackup notification.
SMTP Settings:
  • SMTP From Email - Reply-to email address.

  • SMTP Host - SMTP email server hostname.

  • SMTP Port - SMTP email server port.

  • SMTP Username - SMTP username.

  • SMTP Password - SMTP password.

  • SMTP Secure - SMTP encryption protocol. (None/SSL/TLS)

    • Verify SSL - SSL verification on SMTP connection.
  • SMTP Timeout - Authentication connection timeout in seconds.

Notification Plugins

On top of email notifications, you also have the option to install and activate additional notification plugins to integrate with JetBackup. Click Here for a list of notification plugins available by default and instructions on how to setup each.


Binary Locations

Binary Settings

rsync Binary Location

/usr/local/jetapps/usr/bin/rsync

psql Binary Location

psql

pg_dump Binary Location

pg_dump

pg_restore Binary Location

pg_restore

mysql Binary Location

mysql

mysqldump Binary Location

mysqldump

mongorestore Binary Location

/usr/local/jetapps/usr/bin/mongorestore

mongodump Binary Location

/usr/local/jetapps/usr/bin/mongodump

tar Binary Location

tar

gzip Binary Location

gzip

gunzip Binary Location

gunzip