– Admin Panel Documentation

Jb5: General Information

Mon, 01 Jan 0001 00:00:00 +0000

For video tutorials, please click here:

Installation Guide

System Requirements

Operating System	Version
CentOS / RHEL / Oracle Linux	8, 9, 10 64-bit
AlmaLinux / CloudLinux / Rocky Linux	8, 9, 10 64-bit
Ubuntu (LTS)	22.04, 24.04 64-bit
Debian	11, 12, 13 64-bit

NOTICE: CentOS7, CloudLinux 7 and Debian 10 have reached EOL on June 30, 2024. JetBackup will only support these versions until v5.3.12. Ubuntu 18.04 will also only be supported until v5.3.12.

Supported Hosting Panels:

Minimum cPanel/WHM version 88 and above
- WHM Tweak Settings > Max cPanel process memory - 2GB minimum required

Minimum DirectAdmin version 1.60.4 and above
- The Feature Set Policy “Allow All Commands” OR a customized “Core Functions” Feature Set is required to backup accounts in DirectAdmin.
- Add the following commands to the Core Functions Feature Set in order to backup accounts in Direct Admin

CMD_FTP
CMD_ADDITIONAL_DOMAINS
CMD_EMAIL_POP

Minimum Plesk version 18.0.39 and above
- When changing the download directory, the pssaadm user must have permissions to access the new directory in order to download the backups via JetBackup.

Database Management System	Version
MySQL	8.0 or later
MariaDB	10.5 or later
MongoDB	5.0 or later
PostgreSQL	12 or later

We can only guarantee full compatibility for MySQL/MariaDB, MongoDB, or PostgreSQL DBMS versions that are actively being supported by the distributor.

NOTICE: JetBackup 5 v5.3+ utilizes MongoDB 6.0+ which requires use of the AVX instruction set. Please verify that your CPU meets this requirement. Makes sure that Port 27217 is open to allow MongoDB(Jetmongod) to function properly.

JetBackup 5 for Linux only supports panelless environments running on supported Operating Systems.

For JetBackup 4 for cPanel users looking to upgrade to JetBackup 5, please visit our UPGRADE GUIDE.

Install the JetApps Repository

To begin installation, you must first install the JetApps Repository.

Login to your server as the root user, then execute the following command on your terminal. This will install the appropriate JetApps Repository package for a supported operating system.

bash <(curl -LSs https://repo.jetlicense.com/static/install)

Install JetBackup 5

Execute the following to install JetBackup 5 on your server with the appropriate platform:

jetapps --install jetbackup5-cpanel edge

jetapps --install jetbackup5-directadmin edge

jetapps --install jetbackup5-interworx edge

jetapps --install jetbackup5-plesk edge

jetapps --install jetbackup5-linux edge

After successfully installing JetBackup 5, take time to review the Getting Started guide for help on setting up JetBackup for the first time.

For more information regarding JetBackup tiers and updates, please see the next section, JetBackup Updates.

JetBackup Updates

To change your JetBackup updates tier from the server’s terminal, please execute the following command specifying your preferred tier:

jetapps -t jetbackup5-cpanel edge

jetapps -t jetbackup5-directadmin edge

jetapps -t jetbackup5-interworx edge

jetapps -t jetbackup5-plesk edge

jetapps -t jetbackup5-linux edge

Here is a list of all available JetBackup tiers:

release
rc
edge
alpha

NOTE: We highly recommend installing the release tier in production servers to ensure that all features and functionality have been fully tested.

There is no option to DOWNGRADE your JetBackup version. For ALPHA/EDGE/RC Installations, you may change your current Tier in order to fetch future updates associated to your preferred Tier as soon as they are available.

To manually update JetBackup, please execute the following command through the terminal as the root user:

jetapps -u jetbackup5-cpanel edge

jetapps -u jetbackup5-directadmin edge

jetapps -u jetbackup5-interworx edge

jetapps -u jetbackup5-plesk edge

jetapps -u jetbackup5-linux edge

It is recommended to activate the auto update feature and this feature is enabled by default. To re-enable automatic updates, run the following command:

jetapps -p jetbackup5-cpanel yes

jetapps -p jetbackup5-directadmin yes

jetapps -p jetbackup5-interworx yes

jetapps -p jetbackup5-plesk yes

jetapps -p jetbackup5-linux yes

Remote MongoDB (Optional)

By default, JetBackup 5 installs and uses a local MongoDB instance (jetmongod) to handle indexing, job tracking, and internal operations. If you would like to use a remote MongoDB instance instead, you must configure the remote server before installing JetBackup.

NOTE: This setup can serve as a workaround for servers without AVX/AVX2 support. If you are using the default local jetmongod service, skip this section entirely.

To prepare a remote server for use as a MongoDB backend, run the following commands on the remote server:

bash <(curl -LSs https://repo.jetlicense.com/static/install)
bash <(curl -LSs https://repo.jetlicense.com/static/jetmongo-remote-install)

During installation you will be prompted to configure the following:

Authentication Database - Typically admin
MongoDB Host - The remote server’s IP address
MongoDB Port - Default is 27217
MongoDB Username - The user JetBackup will authenticate with (typically found /usr/local/jetapps/etc/.mongod.auth)
MongoDB Password - Password for the above user
MongoDB Database Name - Recommend using HOSTNAMEIP-jetbackup5

Once complete, proceed with your normal JetBackup installation and configure it to point to your remote MongoDB instance.

NOTE: For a full installation and configuration guide, see our Knowledge Base article.

Licensing

JetBackup registers and activates your license upon installation with your server’s Public IP. If you migrate/replace the server, you will need to reissue the license through your license provider. If your license is purchased directly through JetApps, please do the following:

Login to your JetApps client area, from the top menu navigate to “Services” > “My Services”, and choose JetBackup (click the “View Details” button).

Under “Management Actions”, click on “Reissue License”.

After the license has been Reissued, please verify that the license is active by inputting your IP at our License Verification Site.

Now all you need to do is to access the JetBackup through the GUI, and the license will be reissued using the new server details.

To force JetBackup to validate your license against our licensing servers please execute the following command from your server’s CLI as root user:

/usr/bin/jetbackup5 --license

Key-Based Licensing

As an alternative to IP-based licensing, JetBackup supports key-based licenses. This can be useful when your server’s public IP changes frequently or is not yet stable.

To set a key-based license, run the following command as root, replacing YOUR_LICENSE_KEY with your actual key:

/usr/bin/jetbackup5 --license-key YOUR_LICENSE_KEY

Note: JetBackup License(s) automatically validates every 48 hours.

Uninstall

To uninstall JetBackup from your server, execute the following command from your server’s shell CLI as root user:

jetapps --remove jetbackup5-cpanel

jetapps --remove jetbackup5-directadmin

jetapps --remove jetbackup5-interworx

jetapps --remove jetbackup5-plesk

jetapps --remove jetbackup5-linux

Plesk: To remove the empty JetBackup extension from the Plesk UI, please execute the following command

plesk bin extension --uninstall jetbackup5

To completely remove ALL JetBackup packages (including all JetApps plugins), execute the following command from your server’s shell CLI as root user:

CentOS / AlmaLinux / RHEL / CloudLinux:

yum remove jetapps-repo

Debian/Ubuntu:

apt-get remove jetapps-repo

Please note that these commands will remove ALL versions of JetBackup you currently have installed.

Jb5: Getting Started

Mon, 01 Jan 0001 00:00:00 +0000

For video tutorials, please click here:

Introduction

Once you have finished with the JetBackup 5 Installation, it is time to setup the software for the first time!

First, Log in to your Admin Panel and navigate to JetBackup. There are instructions on accessing JetBackup depending on your setup below. If you already know how to access JetBackup, please skip to Initial Setup below.

How to Access JetBackup 5

cPanel/WHM

To access JetBackup 5 in cPanel/WHM after installation, navigate to WHM Home > Plugins > JetBackup 5.

DirectAdmin

To access JetBackup 5 in DirectAdmin after installation, navigate to DirectAdmin (Admin Level) > Extra Features > JetBackup.

If you configured a custom hostname or port for your DirectAdmin Server, please visit Custom Nameserver/Hostname and Port for more information on how to load the JetBackup 5 Panel.

Interworx

To access JetBackup 5 in Interworx after installation, navigate to NodeWorx Home > SiteWorx > JetBackup 5

Please Note: JetBackup v5.3.16 is the latest version for Interworx

Plesk

To access JetBackup 5 in Plesk after installation, navigate to

Power User view: Plesk Home > JetBackup 5

Service Provider view: Plesk Home > Links to Additional Services > JetBackup 5

Linux

The JetBackup for Linux Panel can be accessed at https://{hostname/ip}:3035 with the same login as root. Please also ensure that Port 3035 is open on the server to allow GUI and API access. If you would like to connect the server to JetBackup Management Console, please ensure Port 3032 is open for secure communications to the Management Console.

To specify your own SSL Certificate(s), please click HERE.

IMPORTANT! For standalone Linux servers, account UIDs/GIDs must be 1000 and up. UIDs/GIDs below 1000 are reserved for system accounts, services, and other special accounts. Find out more information here: User account management with UIDs and GIDs

Utilize our Manage Databases plugin to assign databases to Linux Accounts in order to be included in Account Backups.

Tenancy/Access Levels

JetBackup uses the same permission structure as the hosting control panel. What a user can see or do in JetBackup depends on the role and access level they already have in the control panel.

Server Administrator

• Full access to the JetBackup Admin Panel

• Can configure global settings, storage destinations, backup schedules, retention, licensing, and reseller permissions

Reseller Accounts

• Access to the JetBackup User Panel by default

• Can view and restore backups for their own end users

If granted administrative privileges in the hosting control panel, resellers can access the Jetbackup Admin Panel (scoped).

End Users (Regular Accounts)

• Access to the JetBackup User Panel only

• Can view and restore their own backups (files, databases, and emails, based on permissions)

• No access to server-level or reseller-level settings

Server Admin
  └── JetBackup Admin Panel
      ├── Reseller (User Panel)
      │     └── End Users (User Panel)
      └── Reseller (Admin Access Enabled)
            └── JetBackup Admin Panel (Scoped)

JetBackup does not introduce a separate tenancy model. It inherits and enforces the access boundaries defined by the hosting control panel.

Initial Setup

When you open JetBackup for the first time, you will be greeted with the JetBackup End User License Agreement. Once you have reviewed and agree to the terms in our EULA, select "I agree to those terms" to accept the EULA agreement and proceed with the initial setup.

Disaster Recovery Wizard

After accepting the EULA agreement you will have the following options to start your JetBackup 5 Configuration.

New Installation

This option will reset any existing JetBackup 5 Configuration and load the panel with the default JetBackup 5 Configuration.

Recover from Disaster

This option will allow you to restore your JetBackup 5 Configuration from a Destination with Export JB Config Enabled before. Please ensure you also saved the Master Encryption Key for that JetBackup 5 Configuration.

Exit DR

This option will keep any existing JetBackup 5 Configuration, and load the JetBackup 5 Panel. NOTE: If this is your first time installing JetBackup 5, please use New Installation

If you are here to recover from a disaster (re-installing JetBackup after an entire data loss event), please visit Disaster Recovery Guide for subsequent steps.

If you have an existing JetBackup configuration on your server, please click on "Exit DR" to keep your existing configuration.

OTHERWISE, select "New Installation" to login to your JetBackup panel with a clean installation and default configuration.

Remote MongoDB (Optional)

NOTE: This setup can serve as a workaround for servers without AVX/AVX2 support. If you are using the default local jetmongod service, skip this section entirely.

To prepare a remote server for use as a MongoDB backend, run the following commands on the remote server:

bash <(curl -LSs https://repo.jetlicense.com/static/install)
bash <(curl -LSs https://repo.jetlicense.com/static/jetmongo-remote-install)

During installation you will be prompted to configure the following:

Authentication Database - Typically admin
MongoDB Host - The remote server’s IP address
MongoDB Port - Default is 27217
MongoDB Username - The user JetBackup will authenticate with (typically found /usr/local/jetapps/etc/.mongod.auth)
MongoDB Password - Password for the above user
MongoDB Database Name - Recommend using HOSTNAMEIP-jetbackup5

Once complete, proceed with your normal JetBackup installation and configure it to point to your remote MongoDB instance.

NOTE: For a full installation and configuration guide, see our Knowledge Base article.

Feature Showcase

After performing a New Installation you will then be presented with the Feature Showcase. Here we provide the newly generated Master Encryption Key for this JetBackup 5 Configuration to be used for Disaster Recovery. There will also be occasional announcements that appear on this page like our JetBackup 4 to JetBackup 5 Import Tool.

Dashboard

Once in the dashboard area, you can start adding a backup destination. This will serve as the storage location(s) for your backups.

Next, we highly recommend enabling Export JB Config on a destination to backup you JetBackup configurations and settings which allows for a more seamless Disaster Recovery.

Now you can start creating your backup job. To know what is right for you, you will need to characterize the type of backup you want.

Here are some common backup types:

Local to remote - Accounts are copied to a remote folder, no local backups are left behind.
Local to local - Accounts are copied to a specified local folder.
General files backup - Only backup files (any file on the server, doesn't have anything to do with any accounts).
Mysql backups - backup accounts' databases.

JetBackup Settings and Plugins

Take time to review your JetBackup Settings and Plugins to further adjust and fine-tune JetBackup to your needs! Here is a shortlist of settings we recommend for you to check out:

Privacy & Security - Set the User Agreement and Privacy Policy for all your users.
Delete orphan backups older than - Set the number of days JetBackup will keep backups for terminated accounts.
Manual Backup Settings - JetBackup has a separate backup retention and TTL settings for backups that are generated manually
Concurrent Tasks - Specify the maximum number of backup, restore and download tasks that JetBackup can execute simultaneously.
Server Master Encryption Key - JetBackup generates an encryption key to secure your JB Config backups. It's important to keep this key on a secure remote location.
Plugins Overview - Install Plugins to extend the functionality of JetBackup. Using Plugins, you can add supported Destinations, Notification Plugins for third-party messaging platforms, and Security Plugins.
- a. Manage Databases Plugin (Standalone Linux Only) - For servers without a control panel, install and configure the "Manage Databases" Plugin to auto-assign or manually assign databases and database users to accounts. NOTE: The "root" account is NOT listed as an account in Jetbackup 5. A new Linux user should be created to store files/folders and assigned databases/database users (via the Manage Databases Plugin) that you desire to backup.

How efficient would you like your backups?

Our best recommended setup is as follows:

Local to remote backups, using "SSH" as your storage destination. At first run, JetBackup will create a full backup for all accounts and on subsequent runs, only new or modified file changes will need to be backed up. Furthermore, If you activate "backup retention" - JetBackup will create "point-in-time incremental backups" which uses as little space as possible (using hardlinks).

So for a 30 day backup retention of a 2GB account, it will only consume 2GB + 30 Days of new/changed files (** At the moment, mysql is fully dumped as it doesn't support incremental backups).

Jb5: Dashboard

Mon, 01 Jan 0001 00:00:00 +0000

For video tutorials, please click here:

Once you open JetBackup 5, you will be greeted with the JetBackup interface and dashboard. The dashboard shows an overview of statistics, alerts and recent activities of JetBackup on your server.

JetBackup Admin Panel interface sections:

For instructions on installing JetBackup, please visit our Installation guide.

For first time users, check out our Getting Started guide to help you set up JetBackup.

The navigation sidebar provides access to the following sections and features in JetBackup:

Dashboard: get an overview of JetBackup’s statistics, alerts and recent activites on your server.
Accounts: view account backups and manage settings for each account.
Destinations: add and manage your backup destinations.
Backup Jobs: create and modify your backup jobs.
Clone Jobs: create and modify your backup jobs.
Restore & Download: manage and execute restores and downloads for account and directory backups.
Alerts: view and acknowledge alerts generated by JetBackup processes.
Queue: view progress and cancel queued JetBackup processes.
Logs: view general logs for all JetBackup-related processes.
Permissions: view and manage global and individual admin and user permissions.
Hooks: create pre/post hooks to tell JetBackup to trigger your custom script(s).
Security: choose various supported security plugins and set how JetBackup interacts.
Plugins: add and manage JetBackup plugins and repositories.
Settings: configure and fine-tune your JetBackup settings.

Statistics

Get an overview of JetBackup’s usage statistics.

New Alerts

The total number of JetBackup alerts within the last 24 hours.

Total Accounts

The total number of accounts on the server.

Total Jobs

The total number of backup jobs.

Total Backups

The total number of backups generated.

Total Accounts Usage

The amount of disk usage for all accounts on the server.

Jobs Running

The number of jobs currently running on the server.

General Information

Get an overview of the most recent activities and additional information regarding JetBackup on your server.

Recent Alerts

3 most recent alerts on the server.

Restore Queue Summary

A status overview off all queued restore tasks.

Latest Queue

List of queued items on your server (5 per page)

Destinations List

List of destinations on your server (5 per page)

Backup Jobs List

List of backup jobs on your server (5 per page)

Clone Jobs List

List of clone jobs on your server (5 per page)

Jb5: Accounts

Mon, 01 Jan 0001 00:00:00 +0000

For video tutorials, please click here:

In this section, you can view and execute actions on account backups and manage JetBackup settings for each account(s) you have ownership of on the server.

IMPORTANT! For standalone Linux servers, account UIDs/GIDs must be 1000 and up. UIDs/GIDs below 1000 are reserved for system accounts, services, and other special accounts. Find out more information here: User account management with UIDs and GIDs

Interworx resellers are virtual users, so they are not listed under the Accounts page.

Account Settings

Click on the preferred account on the Accounts Page to expand and view the available account specific options.

Manage Account

Click on the Manage Account button to modify account specific settings.

Email Address

Specify the email address that JetBackup notifications for the account will be sent to.

Max On Demand Backups

Set the maximum number of on-demand backups allowed to created for this account or use the global settings. [Max: 99]

Reset Encryption Key

Delete the account’s encryption key used for their backups. This option is only available when Remote Encryption Key is selected for the account’s encrypted backups.

IMPORTANT! Once you reset the account encryption key, ALL existing encrypted backups for the account will be inaccessible and subsequently deleted.

Account Queue Priority Group Override

The priority group you assign will position this account in its respective place in the queue. [Example: “High” will put account in the front of the queue. “Low” will put account in the back of the queue.]

Visit Queue Priority Groups to create and modify your priority group settings.

In JetBackup 5, there are 2 underlying priority systems at work which allows you to control how JetBackup prioritizes backups, restores & downloads. Both of which works so that the lower the value, the higher its priority on the queue. For more Information regarding JetBackup 5’s priority systems, please CLICK HERE.

Account Backup Jobs Excludes

This option allows you to specify files/folders to be excluded from a particular account. Please note that paths specified are relative to the account’s home directory (/home/{USER}). The format should be in the Glob Pattern.

This method can only be used to exclude files within an account’s home directory backup item. Please note that data like Emails, SSL Certificates, etc.. are processed into its own separate backup item(s) and cant be excluded using this method. To view a full list of backup items, as well as how to include/exclude them, please CLICK HERE.

Create Backup On Demand

Runs backup job only for the selected account using the job that was enabled in Backup on Demand Settings.

This is an on-demand backup of the account as it exists currently. If necessary, you can simply roll back to the recent on demand backup instead of restoring the last scheduled backup.

Backup on Demand Backups do not count towards your scheduled backup job rotation. To set the retention and TTL for Backup on Demand backups, please visit Backup on Demand Settings.

View Backups

Browse all backups corresponding to the selected account.

Available Options:

Full Backup

Under the Created column, click on the drop-down box (Choose Other Backup on advanced settings) to select the preferred full backup date you would like to queue a restore/download for.

Show Advanced Settings

To restore specific backup items, click the “Show Advanced Settings” button to customize which parts of the account you would like to include/exclude and queue a restore/download for. By default, all backup items are selected if available in your backup.

To include or exclude a backup item from the restore, click the Backup Item Tab and click the checkbox to the left of the backup item.

Items To Restore/Download

Panel Config
Home Directory Files
- Change Files Selection - Browse and select which files and folders you would like to include/exclude. Cron Jobs
Databases
Database Users
Zones
Certificates
Emails
FTP

Home Directory - Files Restore/Download

You can restore individual Files/Folders via the “Home Directory” tab in “Show Advanced Settings”. NOTE the Change Files Selection option is only available for Incremental Backups.

Change the backup date by clicking the “Choose Other Backup” button from the “Created” column. Then, select the files or folders you’d like to restore with the “Change Files Selection” button. By default, all Home Directory files are included.

You’ll then be prompted to select Files/Folders to restore via the File Browser.

Delete

Delete the selected snapshot. The command jetbackup5 --enable-delete-snapshot is required to be run on the server to enable snapshot deletion via the GUI. When enabled, a warning banner will be displayed on all pages.

Restore

Restore selected account backup items.

Restore Options:

Terminate account before restore (Only for non reseller accounts)
Merge live account data with backup data
This option will merge your backup data with the existing data on your account. Live data takes precedence over the restored data.
Suspend account after restore

Restore Conditions:

Conditions specified under the Restore Settings that would need to be accepted in order to proceed with the restoration.

Backups Private Encryption Key:

If the selected backup is encrypted and the owner chose to store their key remotely when opting for encrypted backups, you will need to provide their Private Encryption Key to proceed with the backup restore.

Download

Download selected account backup items.

Backups Private Encryption Key:

If the selected backup is encrypted, you will need to provide the Private Encryption Key generated by the account owner when opting for encrypted backups to proceed with the backup download.

Lock Backups

Lock the selected backup out from the Backup Job rotation it is associated with. This will prevent JetBackup from cleaning the backup per your backup retention settings.

Unlock Backups

Reinstate the selected backup back into the Backup Job rotation it is associated with. Unlocking a backup will cause it to be cleaned by JetBackup per your backup retention settings.

View Downloads

Browse downloads corresponding to the selected account. Clicking the download button will directly download the file to the local machine via the browser.

Assignable Accounts

JetBackup assigns each account with a universally unique identifier (UUID). This ensures that backups are assigned to the correct users and prevents conflicts from accounts that may have the same name across multiple servers from accessing dissociated backups. JetBackup allows you to reassign accounts with the correct UUID if it detects multiple UUID’s with the same username.

Note: Orphan accounts respect the Delete orphan backups older than setting. Addtionally, if the orphan account no longer has any backups and is inactive, then it will have a TTL of 14 days. An account is considered an Orphan Account if it meets the following criteria:

No owner on the server
Backups exists on the destination for the account
Account is inactive on the server

Accounts that are not Orphans, do not have any backups, and are inactive will respect a separate TTL of 60 days.

View Orphan Accounts

Orphan Backups are backups that have no associated active accounts.

Accounts that had multiple UUIDs (Assignable Accounts) before becoming an Orphan will appear as unique accounts for each UUID on the Orphan Accounts page. If an Account UUID has no associated backup and is “inactive” for 14 days, JetBackup will automatically remove this account from the JetBackup Database.

Manage Account Tags

Tags are used to help sort groups of accounts and set group priorities.

Create New Tag

Assign the Tag a name for internal use. You can assign the tag a custom color using Hexadecimal numbers. You may also use the built-in Random Hexadecimal Number Generator.

Change Tags

After selecting accounts, you may assign tags to accounts

Mass Assign Accounts to Tag

Select the desired accounts from the Accounts section, then click Change Tags. A popup will appear where you can select the tags you want to assign to the selected accounts.

Jb5: Destinations

Mon, 01 Jan 0001 00:00:00 +0000

For video tutorials, please click here:

Overview

A Backup destination serves as the storage location for your backup files (backup destinations can be remote or local). Below is a list and brief overview of each supported destination types so you can choose the most suitable destination for your specific needs or use case.

In general, it is almost always a best practice to make sure at least one copy of your server’s backups are located off-site (remote destination) in case of a disaster at your data center, home, or office.

Remote destinations are usually slower than local destinations to backup and restore from due to bandwidth requirements. With this in consideration, many clients choose to store at least one copy of backups locally and additional copies in at least one or more remote destinations.

Warning

We do not recommend manually relocating backups to another destination/path because backups may have a different format between destination types and this can cause unintended conflicts when JetBackup expects the original path when reindexing, leading to corrupted backups.

To prevent the potential corruption of your backups, please do not manually alter the backup files on the destination in any way.

Destination Types

When backing up data to your destination server, especially when handling a large number of files (inodes), sufficient memory on the destination server is critical for performance and reliability. We recommend adjusting your destination server’s system resources according to the expected backup workload.

Destination Type

Backup Type

JetBackup Storage

Accounts

✅ Incremental

✅ Archived

✅ Compressed

✅ Deduplication

Local

Accounts

✅ Incremental

✅ Archived

✅ Compressed

✅ Deduplication

SSH

Accounts

✅ Incremental	✅ Archived	✅ Compressed	❌ Deduplication
Unsupported Vendors
⚠️ Busybox

S3 Compatible

Accounts

✅ Incremental	✅ Archived	✅ Compressed	✅ Deduplication
Supported Vendors
✅ JetBackup Storage	✅ Amazon S3	✅ Digital Ocean Spaces
✅ IBM Cloud	✅ Google Cloud Storage	✅ Oracle Cloud
✅ Wasabi	✅ Scaleway Elements	✅ CloudFlare
✅ Vultr	✅ Custom Vendors
Unsupported Vendors
⚠️ Backblaze

FTP

Accounts

✅ Incremental	✅ Archived	✅ Compressed	❌ Deduplication
Unsupported Vendors
⚠️ OVH FTP

SFTP

Accounts

✅ Incremental

✅ Archived

✅ Compressed

✅ Deduplication

Google Drive

Accounts

✅ Incremental (Not Recommended)

✅ Archived

✅ Compressed

❌ Deduplication

Dropbox

Accounts

✅ Incremental

✅ Archived

✅ Compressed

❌ Deduplication

OneDrive

Accounts

✅ Incremental

✅ Archived

✅ Compressed

❌ Deduplication

S3 (New Backup Engine) vs SSH (Rsync): See more information about how our new backup engine works at Destination Benchmarks.

Note: Using destinations marked unsupported is NOT RECOMMENDED. Due to numerous consistent reports of sub-optimal performance and operational issues, we cannot guarantee support and seamless operation of JetBackup from use of unsupported destinations.

Desination Storage Formats

JetBackup 5 currently supports 2 types of storage formats, depending on the Backup Destination you choose.

Rsync-Based destinations (SSH, Local), utilize the file-level storage (file-level backups), which allows you to access your backups directly and conveniently from your destination in a human-readable format.
S3-Compatible destinations such as Amazon S3, Wasabi, Google Cloud Storage, etc.. utilizes our new Backup Engine that is using object storage format for backups. This new storage format applies JetBackup’s new Proprietary Backup structure that allows for more efficient backups, and incremental capabilities to ALL destinations.

Destination For

There are two different Destinations you can create at this time.

Backup - Use the destination for configured Backup Jobs.
Clone - Use the destination for configured Clone Jobs.

Please Note: Clone destinations can only be created using the SSH Destination Plugin at this time. When configuring the SSH Destination for a Clone Destination you will not need to set a Backup Directory and a ROOT private key or ROOT credentials are required.

Backup Types

Accounts - Backup Account Data from each account that you choose to include.
Directories - Select system files/folders to backup to the destinations.
Server Backup (BMR) - Creates a server-level, bootable ISO image containing the entire server’s OS, panel, configurations, and files, allowing you to restore a completely failed server to new hardware or a fresh install, bypassing the need to rebuild everything manually.

NOTE: Server Backup (BMR) excludes account home directory data. It is highly recommended to have a separate full account backup job configured that includes all accounts.

Backup Structures

Deduplication - Backup data using content-defined chunking to eliminate duplicate data.

Instead of comparing whole files or fixed-size blocks, files are split into variable-length chunks based on their content. Each chunk is uniquely identified by a cryptographic hash. If a chunk’s hash already exists in the backup repository, the chunk is not uploaded again—even if it appears multiple times in the same file or across different files and backup snapshots. When a file changes, only the modified chunks are stored, and unchanged data is referenced from previous backups. This minimizes storage space and bandwidth while maintaining complete, independent restore points for every backup.
Incremental - Backup new and changed data since the previous backup.

“Point-In-Time” incremental backups - For retentions on incremental backups, JetBackup generates “point-in-time” incremental backups that use as little space as possible (using hard links). For example, on a 2GB DirectAdmin account with 30-day backup retention, it will only consume 2GB + 30 Days worth of new/changed data.

For databases, JetBackup generates a full dump of the databases for the initial incremental backup. If the databases are modified, JetBackup will then generate a new full dump for the incremental backup. Otherwise, the previous snap of the database dump will be used in the incremental backup.
Archived - Backup data in an uncompressed archive (.tar file format). Uncompressed backups are faster to generate but require more space.
Compressed - Backup data in a compressed archive (.tar.gz file format). Compressed backups use less space but take more time to generate.

Read Only

This option allows you to add the destination as a “Read Only” destination. You can only restore and download existing backups from a read-only destination. Read Only is required if the Backup Directory is already owned by another destination/server. This option is only selectable upon creating the destination and will be automatically enabled for any destinations added during a Disaster Recovery.

Create New Destination

To create a new destination, click on “+ Create new Destination”. Please check the Destination Type you would like to create for specific instructions.

Local Destination Example:

Destination Settings

Click on the preferred destination listed in the Destinations section to expand and view the available destination settings.

Enable/Disable Destination

Click on Disable/Enable Destination to Disable/Enable your destination.

Manage Destination

Click on Manage Destination to modify your destination settings.

Please note that when editing your destination, JetBackup will try reverting to your previous destination configuration automatically if the destination fails to register with the new configuration.

Browse Destination Files

Browse files and folders stored in your destination.

Backup Visibility

This option allows you to set the visibility of backups/snapshots stored on the destination. When disabled, the backups from the destination will not be visible to your end-users.

Export JB Config

This option enables “JetBackup configuration” backup(s) which is required to perform critical JetBackup operations such as “Disaster Recovery” and recovering from database corruption.

“JetBackup configuration” backup(s) are lightweight, encrypted, and executed daily for up to 7 retained snapshots. The total compressed size of the JB Config Export Backups may vary depending on the number of backups indexed by JetBackup at the time the JB Config Export was generated. For more information, please see JetBackup Configuration Backup Job.

This backup is encrypted using the Master Encryption Key and is highly recommended to keep the key on a secure remote location (such as a password management software).

Please note that enabling Export JB Config will not execute the JetBackup configuration backup on demand. Please wait a minimum of 24 hours to ensure that JB config backup has executed.

Validate Destination

Validating a Destination checks whether your destination is valid and reachable.

Reindex Destination

Reindexing resyncs data between your server and the destination. Useful in case of adding a destination that already contains JetBackup generated backups or if changes in the destination were made manually.

Delete Destination

Deletes your destination permanently. Make sure that no backup jobs are assigned to the destination in order to delete it.

Additional Information

Object Storage and the S3 protocol

Object storage is a type of storage where data is stored as objects rather than blocks. This concept is useful for data backup, archiving, and scalability for high-load environments.

Objects are the entities of data storage in S3 buckets. S3 objects are comprised of three main parts; the content of the object (data contained in the object includiing directories or files), the unique object identifier (Unique string used to identify the item within the bucket.), and metadata. Metadata contains information such as name, size, date, security attributes, content type, and URL. Each object has an ACL or Access Control list which dictates who is permitted access to the object. S3 object storage has distinct advantages such as allowing you to avoid network bottlenecks as well as a high degree of scalability and data security.

For more information regarding the differences between Object Storage and a Traditional File System in terms of how JetBackup 5 stores your data, please click HERE.

Commonly used binaries for Local/SSH

JetBackup 5 uses rsync to generate backups and transfer them to Local and SSH Destinations. When adding these types of destinations please ensure that both the source server and destination server are able to run standard Linux commands like the following:

mkdir
ls
stat
rm
rsync
mv
cd
pwd

Please note: This is NOT an exhaustive list of required binaries.

How To Secure Local Backup Storage

Please make sure that your destination path is secure and has the appropriate privileges. For more information, please visit How To Secure Backup Storage.

Disk Info

Please note that the column Disk Info is updated every 6 hours by default and on completing a Reindex.

For S3 destinations, disk info will be displayed as N/A, as they are cloud-based and do not have a predefined or limited disk size.

Disabled Destinations

If a destination is disabled, it will be labeled disabled under Destinations Selection in Create New Backup Job. Having a disabled destination as part of an active Backup Job may cause a Partially Complete Backup Job. This can be verified when looking at the Backup Logs.

Invalid characters and file permissions

JetBackup can’t restore files and/or directories with certain special characters or permissions.

For a list of recommended special characters and file permissions to avoid, please visit: Characters to Avoid when naming Files and Folders

Jb5: Backup Jobs

Mon, 01 Jan 0001 00:00:00 +0000

For video tutorials, please click here:

Backup Jobs allows you to configure how JetBackup generates and manages your backups according to your backup job configuration. In this section, you will be able to create, modify and manage your Backup Jobs.

By default, ALL accounts (active and suspended) are included in a backup job. You can adjust which accounts are included by using account filters.

Create New Backup Job

To create a new backup job, click on "+ Create New Backup Job".

Example configuration page for the backup job:

Job Name

Specify a unique name for your backup job. This will be used internally for your convenience.

Creator

Specify the creator for this Backup Job. This grants the creator and its parent account(s) permission to modify and delete this Backup Job. Please note that the creator specified will also need Can Manage Backup Jobs permission granted under the Permissions section.

Destinations

Specify which destination(s) to transfer/store your generated backups to. You can find more details regarding supported destinations in the Destinations Overview section. Backup Jobs are able to backup to multiple destinations per job.

If a new destination is added, JetBackup will continue with incremental backups on the original destination and generate the initial full backups on the new destination.

Backup Type

JetBackup can perform the following types of backups. Here’s a brief explanation for each type:

Accounts - Copy files/folders from each account that you choose to include.

You can choose to include/exclude the following:
Panel Configurations
Home directory Files
Databases **(Incremental backups is not supported for this type)**
Database Users
Email Accounts/Structure **(Email Forwarder backup and restore currently supported for: cPanel)**
FTP Accounts
Cron Jobs
DNS Zones
SSL Certificates

In the case of an incremental job, all files included in this job are backed up incrementally with the exception of databases. Databases are regenerated and synced to the destination. Each job run will add the disk usage of each database dump file to the backup. If a database did not change from a previous backup, then the database dump file from the previous snap is used instead of creating a new database dump file.
When choosing the option to backup email structure, the backup will contain the email account structure without the email content. The Exclude Junk option will exclude trash, spam, junk and draft directories from the backup job.
To restore an Orphan Account, the Panel Config item is required to be included in the backup. If the Panel Config item is missing or not included, follow the steps provided in the FAQ

Account Backup Routine - Click to expand 👆

General Information

JetBackup treats each account as its own entity, each going through the following process:

Gathering the following information specified on the backup job configuration:
- Panel configurations
- Home directory Files
- Databases
- Database Users
- Email Accounts/Structure
- FTP Accounts
- Cron jobs
- DNS zones
- SSL certificates
Transfer the data to the destination.
Cleanup.

Incremental

In an incremental backup job, the steps that consume local disk space are:

Gathering account information from cPanel.
Dumping databases from SQL engines.

All other steps are done by transferring the data directly to the destination.

Compressed/Archived

In compressed/archived backup jobs, all information gathered by the different steps is appended to an archive file. If the job type is compressed then we'll compress the archive file, making it ready for transfer.

Please Note: In this mode the minimum required space is 110% of the largest account.

At this stage, we transfer the compressed/archived backup to the destination then remove the compressed/archived backup file on the local workspace.

Directories - Copy server files/folders that you choose to include (not necessarily related to user accounts).
Disaster Recovery (BMR) Backup - Creates a server-level, bootable ISO image containing the entire server’s OS, panel, configurations, and files, allowing you to restore a completely failed server to new hardware or a fresh install, bypassing the need to rebuild everything manually.

Exclude Databases

You can choose to exclude databases from the backup job. The excludes can be set to have the backup job only exclude databases that exceed a selected size threshold. To modify which database size threshold to exclude, select Edit Excludes. A popup will appear allowing you to modify the database size threshold you would like to exclude.

Backup Structure

Backup structures tells how backups are generated and stored. JetBackup supports the following backup structures:

Incremental - Backup new and changed data since the previous backup.
Archived - Backup data in an uncompressed archive (.tar file format). Uncompressed backups are faster to generate but require more space.
Compressed - Backup data in a compressed archive (.tar.gz file format). Compressed backups use less space but take more time to generate.
Deduplication - Optimizes backup storage by identifying duplicate data blocks and storing only a single copy, reducing disk usage without affecting backup integrity or restore ability.

Compressed/Archived backups only convert the homedir, database, and config file data to their respective formats.

Note: JetBackup 5 stores a Compressed/Archived Backup locally in the JetBackup Workspace before transferring to the destination. The minimal required space for these Backup Structures is 110% of the largest account.

For more information about the Backup structures supported for your destination, go to Destinations Overview.

Retry failed items

When enabled, the retry failed items option allows Jetbackup 5 to retry backing up any failed items during a backup job for one additional time.

Backup Naming Conventions

Backup directory names will differ, depending on two factors: Backup Type and Backup Structure

Backup Type

Backup Structure

Name	Backup Type
jetbackup_1_x_...	Accounts
jetbackup_2_x_...	Directories

Name	Backup Structure
jetbackup_x_1_...	Incremental
jetbackup_x_2_...	Archived
jetbackup_x_4_...	Compressed
jetbackup_x_8_...	Deduplication

JB Config Backup

jetbackup_3_4_...

JetBackup configuration

Encrypted Backups

Choose whether or not backups will be encrypted on the backup destination. This option is only available with Archived and Compressed Backup Structure. Please note that users/accounts that opts for encrypted backups exclusively will be automatically excluded from all other backup jobs with encrypted backups disabled.

Account Filters

Account Filters allows you to specify conditions on which to include/exclude on you Backup Job(s). By default (no filters added), all accounts (active and suspended) are included in the backup job. Multiple filters may also be applied and are combined by AND/OR statements.

AND - the condition on EACH filter(s) must be met in order for an account to be included in the backup job.

OR - the condition on EITHER filter(s) must be met in order for an account to be included in the backup job.

Newly excluded accounts will NOT have their snapshots cleaned(deleted) automatically unless the snapshots are Orphan/Manual Snapshots. These snapshots will remain on the destination(s) until the account is included or the snapshots fall under the Delete orphan backups older than/Manual Backups TTL.

Create Account Filters

In order to create an account filter, either click on “Manage Account Filters” > "+ Create New Filter" or through the Account Filters section under the Backup Job configuration page.

Example configuration page for a new filter:

Filter Type

Accounts Filter - Specify which accounts to Include/Exclude in the backup job.
Resellers Filter * - Specify which reseller accounts (includes the reseller’s sub accounts) to Include/Exclude in the backup job.
Suspension Filter - Specify whether to Include/Exclude suspended accounts in the backup job.
Encrypted Filter - Filter accounts to Include/Exclude based on whether they have Encrypted Backups Only enabled.
Disk Space Usage Filter - Filter accounts to Include Below/Above (or equals) a specified disk space usage in the backup job.
Inode Usage Filter ** - Filter accounts to Include Below/Above (or equals) a specified Inodes (files number) usage in backup job.
Packages Filter - Specify which accounts to Include/Exclude by cPanel Packages in the backup job.
Characters Range Filter - Specify which accounts to Include/Exclude by characters range in the backup job.
Regular Expression Filter - Specify which accounts to Include/Exclude by a regular expression pattern in the backup job.
Account Tags Filter - Specify which accounts to Include/Exclude based on the tags they are assigned.

Reseller Filters only affect the accounts that a reseller account owns, not the reseller account itself. Reseller accounts will be included in the affects of a Reseller Filter if the reseller account owns itself.

In order to use the Inode Usage Filter, your server/control panel must support a method for JetBackup to obtain inode usage (such as repquota).

Filter Name

Specify a unique name for your account filter(s). This will be used internally for your convenience.

Creator

Specify the creator for this account filter. This grants the creator and its parent account(s) permission to modify and delete this account filter. Please note that the creator specified will also need Can Manage Backup Jobs permission granted under the Permissions.

Filter Condition

Whatever to included or excluded accounts filtered by this filter.

Filter Examples

Examples of filter results where Filter 1 contains Account 1 & Account 3, and Filter 2 contains Account 2 & Account 3

Legend

✅ Included in backup
❌ Excluded from backup

Filter 1		Filter 2	Account 1	Account 2	Account 3	Others
Include	AND	Include	❌	❌	✅	❌
	OR		✅	✅	✅	❌
	AND	Exclude	✅	❌	❌	❌
	OR		✅	❌	✅	✅
Exclude	AND	Include	❌	✅	❌	❌
	OR		❌	✅	✅	✅
	AND	Exclude	❌	❌	❌	✅
	OR		✅	✅	❌	✅

Directories and Files to Include

Select which directories and files you would like to add to your Directories backup job. Click on “Select Files” to use the File Browser or “Insert Multiple” to add multiple paths manually. All includes are relative to the account home directory.

Directories and Files to Exclude

NOTE: Directories can be excluded on a per account basis rather than by Backup Job to provide more individualized control over exclusions. This is controlled in the Account Backup Jobs Excludes settings.

Excludes have higher priority than includes.

For example:

If /folder1 was excluded and /folder1/file1 was include, JetBackup will still exclude /folder1/file1
If /folder1 was included and /folder1/file1 was excluded, JetBackup will exclude /folder1/file1 as expected

Excluding files & folders from backup is a very important feature, and we recommend to use it. Each backup job has it’s own exclude list that can be specified and modified. The exclude list will be piped to our sync operation. The supported path format should be in glob pattern.

When using Rsync-Based destinations, rsync (by default) will traverse the excluded directory and all files in the directory but will not write any of the excluded files/directory to the destination if a wildcard is added after the directory you wanted to exclude.

For example:

/PATH/TO/DIRECTORY/EXAMPLE/* will exclude all contents in the EXAMPLE/ directory, but will create an empty EXAMPLE/ directory folder when restored.
/PATH/TO/DIRECTORY/EXAMPLE/ will completely exclude the EXAMPLE/ directory, and will not create an EXAMPLE/ directory folder when restored.

All excludes are relative to the account home directory. So, different patterns can be used to exclude directories. i.e.

*/lscache/* : Exclude the lscache directory on any level, starting on the 2nd level

lscache/* or /lscache/* : Exclude the lscache directory on 1st level only

lscache/* or **/lscache/* or */lscache/* : Exclude the lscache directory on any level

Specify a file/folder path on the field and click on “Add Path” to add on the exclude list or click on “Insert Multiple” to exclude in bulk.

Exclude files and folders in bulk:

Here are some recommendations for files/folders to exclude.

*.bkup
*.gz
*.jpa
*.log
*.sql
*.tar
*.tar.gz
*.wpress
*.zip
*/.wysiwygPro_*
*/backupbuddy_backups/*
*/cache/smarty/*
*/com_akeeba/backup/*
*/core.[0-9]*
*/error_log
*/var/amasty_fpc/*
*/var/backups/*
*/var/cache/*
*/var/debug/*
*/var/export/*
*/var/import/*
*/var/log/*
*/var/report/*
*/var/session/*
*/var/tmp/*
*/wp-content/cache/*
*/wp-content/wphb-cache/*
*/wp-content/uploads/wpcf7_captcha/*
*/wp-content/widget-cache/*
*/wptsc-cachedir/*
.MirrorSearch
.cpanel/*.sock
.trash
access-logs/*
backup-*.tar.gz
logs/*
public_ftp/*
public_/cache/*
site-*.tar.gz
softaculous_backups/*
tmp/*
lscache/*

Default Excludes

JetBackup 5 has certain files and folders that are excluded by default for the Home directory Backup Item depending on the panel installed. Please see the lists below to see which files and folders are excluded from all Accounts Backup Job.

NOTE: Some default exluded files/folders are backed up in other Backup Items. For example: The /mail folder for cPanel accounts will be integrated with the Email Account Backup Item. Having it excluded from Homedirectory backups will allow for efficient backups and avoid duplicates.

/etc/*/passwd
/etc/*/shadow
/etc/*/quota
/etc/*/@pwcache
/mail
/.cl.selector
/.cagefs
/.cpanel/email_accounts_count
/.cpanel/email_accounts.json

/imap
/.cagefs
/.cl.selector

Schedules

Backup Job Schedules tells JetBackup the time and frequency a backup job will be executed as well as the number of backups to keep for the corresponding schedule (backup retention).

JetBackup gives you the option to set multiple schedules for each backup job. There are no extra overhead between backups with multiple schedules running at the same time as JetBackup will automatically mark each coinciding backup with the appropriate schedule types.

NOTE: Changing between schedule types may remove backups generated from the previous schedule type. Please review how to properly make changes on your schedule.

Reducing the “Backup Retain” for your Schedule does NOT require the backup job to run before marking snapshots for deletion. Exercise caution when reducing the Backup retain for your backup job, as any snapshot outside the defined retain value will be marked for deletion by the Automated Snapshot Cleanup Task.

Create Schedule

You may create and/or modify Backup Job schedule(s) through the schedules section under the Backup Job configuration or by navigating to “Backup Jobs” > “Manage Schedules” > "+ Create New Schedule".

Example configuration page for a new schedule:

Schedule Name

Specify a unique name for your schedule. This will be used internally for your convenience.

Schedule Type

Hourly - Will be executed every X hours.
Daily - Will be executed on the days of the weehoose to execute the backup job.
Weekly - Will be executed once a week, on the day you choose to execute the backup job.
Monthly - Will be executed on the days of the month, from the 1st / 7th / 14th / 21st / 28th day you choose to execute the backup job.
After Backup job is done - The job depends on another Backup job to be finished, only then it will be executed. When this option is chosen, You can also set a “delay” in minutes/hours/days to wait before starting.

To safely change between schedule types, please add a new schedule on top of your existing schedule(s) and give your backup job ample time (the full retention length of your new schedule) to generate and correctly mark backups with the appropriate schedule type(s). You can then safely remove the previous schedule once the backup job runs for one full cycle of your retention.

Schedule Hours

With an Hourly Schedule Type, you may choose to execute the backup job every one/two/three/four/six/eight/twelve Hours.

Schedule Days

With a Daily/Weekly Schedule Type, you may choose which day(s) of the week to execute the backup job. With a Monthly Schedule Type, you may choose to execute the backup job from 1st/7th/14th/21st/28th of the month.

Backup Retain

Backup Retain specifies how many backups to keep with the corresponding schedule type.

Schedule Time

With an /Daily/Weekly/Monthly Schedule Type, you may specify the time of day (based on your server local time) on when to execute the backup job.

Schedule Delay

With a After Backup/Clone/cPanel job is done Schedule Type, you may set how much time to delay a backup job in minutes/hours/days before executing the backup job.

Schedule Time

The time that you want all schedules to be executed.

Monitor

The Backup Job monitor is a feature that will allow JetBackup 5 to send alerts to your configured Notification Integrations for each of the following conditions:

Notify me if there were no backups for X Days
Notify me if backup runs more than X Days

Job Monitor Alerts will marked with the Critical Level.

Backup Job Settings

Click on the preferred Backup Job listed in the Backup Job section to expand and view the available backup job settings.

Enable Backup Job

Click on “Enable Backup Job” to toggle between enabling and disabling your backup job.

Manage Backup Job

Click on ‘Manage Backup Job’ to modify your backup job configuration.

Run Backup Job Now (Manual Backups)

Execute your Backup Job manually and on-demand.

Manually running backup jobs does not count towards your scheduled backup job rotation. To set the retention and TTL for manually executed backups, please visit Manual Backup Settings

View Backup Logs

Click on ‘View Backup Job’ to see Logs associated to the selected Backup Job.

Duplicate Backup Job

Click on ‘Duplicate Backup Job’ to make a copy of the selected Backup Job.

Delete Backup Job

Click on ‘Delete Backup Job’ to Delete your job permanently.

Additional Information

Backup Cleanup/Retention

During each (Manual and Scheduled) Backup Job run, JetBackup marks all backups which exceed the retention rate and files that need to be removed. These files will then be cleaned up and deleted during the Backup Cleanup and Integrity Check process. The Backup Cleanup & Integrity Check Schedule adjusts the frequency at which the process is run.

Note: The backups/files that are marked for deletion are not removed at the end of a backup job (Manual and Scheduled) and will remain on the destination until the Backup Cleanup and Integrity Check process runs. Therefore, there may be a temporary increase in disk usage until the Backup Cleanup and Integrity Check process is completed.

We recommend setting the Backup Cleanup & Integrity Check Schedule to allow the process to run more frequently (minimum once per day) in order to minimize the amount of disk space used.

Difference between Backup Cleanup & Integrity Check and Snapshot Cleanup

The Backup Cleanup & Integrity Check task performs a cleanup of marked files for deletion, and verifies the integrity of the backups on the remote destination. Any empty account backup directories will be deleted.

The marked snapshots will be deleted by the Snapshot Cleanup task, which runs every 6 hours relative to when the JetBackup service started. This task removes backups that have exceeded their TTL or retention limits set by the backup schedule. Please note that the Snapshot Cleanup schedule is fixed and cannot be modified.

Optimizing your backups on supported destinations

“Point-In-Time” incremental backups - For retentions on incremental backups, JetBackup generates “point-in-time” incremental backups that use as little space as possible (using hard links). For example, on a 2GB DirectAdmin account with 30-day backup retention, it will only consume 2GB + 30 Days worth of new/changed data.

For databases, JetBackup generates a full dump of the databases for the initial incremental backup. If the databases are modified, JetBackup will then generate a new full dump for the incremental backup. Otherwise, the previous snap of the database dump will be used in the incremental backup.

Incremental Backup Job Behavior

The Initial FIRST run of Incremental Backup Jobs may take a significantly longer time to finish as JetBackup generates the initial FULL Backup of your accounts.
If a Backup Job remains processing and goes past its next expected schedule, JetBackup will recalculate the next run to the next “open” schedule upon completion.

You may set a Backup Fork TTL under your JetBackup Performance Settings to limit how long (in hours) a single Backup Fork can process one account backup.

Please note that manually running a Backup Job does not count towards your Scheduled Backups. JetBackup will generate a separate set of Backups (including the initial Full Backup) for both the Manual and Scheduled runs of your Backup Job.

Symlinks

A symlink or Symbolic Link is simply a shortcut to another file or folder. It is a file/folder that points to another file/folder. You can think of Symlinks as shortcuts sometimes created by root users.

Note: Hard links are currently not supported.

On destinations that utilize our jetindex engine (All non-legacy destinations), JetBackup does backup and restore symlinks in the home directory. This includes symlinks that point to a directory outside of the account’s home directory. Please note that for symlinks that lead outside of the account’s home directory, only the symlink will be included in the backup, and the files/folders ARE NOT included and therfore CANNOT be restored.

For legacy destinations (SSH, Local(legacy)), JetBackup will only restore symlinks that point to another file in the account’s home directory. Symlinks that point outside of the account’s home directory or to a separate mounted disk DO NOT get backed up and CANNOT be restored.

For both legacy and jetindex destinations, email accounts (files/folders) will be included in the backup regardless if the email contents are symlinked from a directory outside of the account’s home directory. When restored, the symlink will no longer exist, and the email account files/direcories will be in the account’s mail directory.

Why are my backups marked as damaged?

If any issues are discovered during the integrity check of the backups, JetBackup will label those snapshot(s) as “Damaged”. This indicates that one or more items in the selected backup are corrupted or did not transfer properly during backup and attempting to restore the account with these “Damaged” backups may result in unexpected errors/failures.

How to Verify if Backups Are Marked as “Damaged”

To determine if the backups are damaged, we must first run the Integrity Check. You may run the Integrity Check process manually by executing the command below.

jetbackup5api -F runIntegrityCheck

If the Integrity Check finds any issues with the backups, it will mark them as “Damaged”. Below are several methods to verify whether the backups have been labeled as “Damaged”

On the JetBackup interface navigate to Accounts > Username > View Backups. From this point, you’ll be able to review if any backups were marked as “Damaged”.

In the terminal, use the grep command to filter “found to be damaged” in the Integrity Check log files. The Integrity Check log files will be prefixed 64_LOGID.log
Utilize the JetBackup API to execute the following command, listing all backups for an account that matches the specified Backup Type/Contains. Any damaged backup will be indicated as Damaged: 1 in the result.

jetbackup5api -F listBackupForTypeName -D "type=1&contains=511&account_id={$ACCOUNT_ID}&name={USERNAME}"

_id: 663e892e0490bd0d35025a15
    parent_id: 663e89260490bd0d350259d5
    account_id: 663675ba98c5c818fd0b34d3
    destination: 663e7f7d0f17de7b54086f22
    destination_name: localv2
    name: demo1
    created: 2024-05-10T20:52:54+00:00
    path:
    backup_type: 1
    backup_contains: 511
    account: demo1
    account_data:
      _id: 663675ba98c5c818fd0b34d3
      username: demo1
      owner: admin
      owner_id: 663675b998c5c818fd0b34d2
      package: undefined
      suspended:
      reseller:
      root:
    size: 281996
    params:
    backup_structure: 1
    notes:
    location:
    safety:
    deleted:
    lock:
    lock_ttl:
    damaged: 1 <<< Backup is damaged
    disabled:
    schedules:
      0: 8
    hidden:
    encrypted:
    encryption_id:
    encryption_key_required:
    encryption_key_exists: 1

JetBackup Priority Systems

Backup Queue and Concurrent Backup Jobs

In Jetbackup 5, the Queue utilizes a First in First out method in processing each tasks. It batches each tasks by its appropriate priority value across each Task Type (Backup, Restore, Download, Clone) and can simultaneously process tasks depending on the number of Concurrent Tasks set under Performance Settings.

Limitations

Invalid Characters

JetBackup can’t restore files and/or directories with certain special characters or permissions.

For a list of recommended special characters and file permissions to avoid, please visit: Characters to Avoid when naming Files and Folders

Jb5: Clone Jobs

Mon, 01 Jan 0001 00:00:00 +0000

For video tutorials, please click here:

A Clone Job is a smart account cloning tool with 2 very distinct features. First, you can apply a recurring schedule so the cloning of the account can take place daily or even hourly if you want. Secondly, it is incremental in nature so that each recurring clone job that runs is only transferring over the new and updated files for each account.

JetBackup v5.2+ is required on both the source and destination servers.
JetBackup can only clone to servers that are equal or higher (>=) to the source version.
JetBackup will only copy the data to the failover server (Data is transferred one way only - from the source server out to the failover server)
If you initiated a failover - There is no automated way to sync back the data to the source server. Reverting back to the source server should be handled with caution and consideration.
JetBackup is only responsible for copying the data - TCP/IP Traffic Failover / Giveback should be handled externally (Floating IP, BGP Re-Route, DNS Failover etc..)
You may encounter issues when cloning across different panels due to differences in panel configurations and environments. Please work with a system administrator to review and ensure your server configurations/environment is as close to identical as possible to mitigate potential issues when cloning accounts.

The Clone Job Process is as follows:

Packages the Account on the Source Server using the JetBackup 5 pkgacct script skipping the Home Directory Backup Item.
Transfers the Account Backup to the Destination (Clone) server via Rsync
Initially ONLY Restores the Account Panel Config Backup Item on Destination Server using the JetBackup 5 restorepkg script
Restores remaining Account Backup Items (except Home Directory) on Destination Server using the JetBackup 5 restorepkg script
Sync the Account Home Directory from the Source Server to Destination Server using Rsync

NOTE: Cloning accounts are only supported between two servers using the same control panel. If you would like to Clone from a different panel, consider using the “Read-Only” destination method. Keep in mind that any panel-exclusive settings/features that don’t exist on the new control panel will not be restored (i.e. cPanel PostgreSQL databases won’t be restored if DirectAdmin doesn’t support creating PostgreSQL databases).

Ensure that the clone server configurations closely match the source server.

Create Clone Job

To create a new Clone Job, click on "+ Create New Clone Job"

Example configuration page for the Clone Job:

Job Name

Specify a unique name for your Clone Job. This will be used internally for your convenience.

Owner

Specify the creator for this Clone Job. This grants the creator and its parent account(s) permission to modify and delete this Clone Job. Please note that the owner specified (if not root) will also need Can Manage Clone Jobs permission granted under the Permissions section.

Destination

Choose a Clone Destination for this job.

Clone Type/Contains

At this time, Clone Jobs can only clone Accounts from source to destination. JetBackup 5 is able to do this by using the JetBackup 5 restorepkg CLI Tool on the Destination server to restore the account. A Clone Job will automatically contain all Account information by default.

You can choose to include/exclude the following:

Panel Configurations
Home directory Files
Databases *
Database Users
Email Accounts/Structure **
FTP Accounts
Cron Jobs
DNS Zones
SSL Certificates

Databases are regenerated and synced to the destination. Each job run will add the disk usage of each database dump file to the clone.

When choosing the option to clone only email structure, the clone will contain the email account structure without the email content.

Accounts Clone Routine

General Information

JetBackup treats each account as its own entity, each going through the following process:

Gathering the following information specified on the clone job configuration:
1. Panel configurations
2. Home Directory Files *
3. Databases
4. Database Users
5. Email Accounts/Structure
6. FTP Accounts
7. Cron jobs
8. DNS zones
9. SSL certificates
Compress Account Data on source server.
Transfer the data to the destination.
Restore Account data on the destination using JetBackup 5 restorepkg CLI Tool.
Cleanup.

NOTE: The Home Directory Files are synced to the destination using rsync after a successful restorepkg process to make the Clone Jobs Incremental by nature.

Default Owner/Package

Since the accounts are being cloned to a new/failover server, you have the option to apply a Default Owner/Package to the account upon Clone. Leave these fields blank to use the live account Owner/Package already set.

Suspend Account

The Suspend Account option allows JetBackup to suspend the cloned account on the destination server during the Clone Job.

NOTE: Some panels may not allow accounts to utilize Panel API when suspended. JetBackup 5 relies on the Panel API to properly restore the Account Items to the destination server.

When Suspend Account is enabled, account suspension notifications may be sent by your control panel. Check your panel notification settings to disable or adjust the frequency of these notifications.

Disabling Cron Jobs

This option will disable the use of cron jobs for specified accounts on the new server.

NOTE: After completing the clone job, to re-enable cron jobs for the selected account you must go into the cron.deny file and remove the user.

Account Filters

Account Filters allows you to specify conditions on which to include/exclude on you Backup Job(s). By default, all accounts are included in the clone job. Multiple filters may also be applied and are combined by AND/OR statements.

AND - the condition on EACH filter(s) must be met in order for an account to be included in the clone job.

OR - the condition on EITHER filter(s) must be met in order for an account to be included in the clone job.

Create Account Filters

In order to create an account filter, either click on “Manage Account Filters” > "+ Create New Filter" or through the Account Filters section under the Clone Job Configuration page.

Example configuration page for a new filter:

Filter Type

Accounts Filter - Specify which accounts to Include/Exclude in the clone job.
Resellers Filter - Specify which reseller accounts (includes the reseller's sub accounts) to Include/Exclude in the clone job.
Suspension Filter - Specify whether to Include/Exclude suspended accounts in the clone job.
Encrypted Filter - Filter accounts to Include/Exclude based on whether they have Encrypted Backups Only enabled.
Disk Space Usage Filter - Filter accounts to Include Below/Above (or equals) a specified disk space usage in the clone job.
Inode Usage Filter * - Filter accounts to Include Below/Above (or equals) a specified Inodes (files number) usage in clone job.
Packages Filter - Specify which accounts to Include/Exclude by cPanel Packages in the clone job.
Characters Range Filter - Specify which accounts to Include/Exclude by characters range in the clone job.
Regular Expression Filter - Specify which accounts to Include/Exclude by a regular expression pattern in the clone job

In order to use the Inode Usage Filter, your server/control panel must support a method for JetBackup to obtain inode usage (such as repquota).

Directories and Files to Exclude

Excluding files & folders from clone is a very important feature, and we recommend to use it. Each clone job has it's own exclude list that can be specified and modified. The exclude list will be piped to our sync operation. The supported path format should be in glob pattern.

Specify a file/folder path on the field and click on “Add Path” to add on the exclude list or click on “Insert Multiple” to exclude in bulk.

Exclude files and folders in bulk:

Here are some recommendations for files/folders to exclude.

*.bkup
*.gz
*.jpa
*.log
*.sql
*.tar
*.tar.gz
*.wpress
*.zip
*/.[wysiwygPro]_* 
*clonebuddy_clones/*
*/cache/smarty/*
*/com_akeeba_clone/*
*/core.[0-9]*
*/error_log
*/var/amasty_fpc/*
*/var_clones/*
*/var/cache/*
*/var/debug/*
*/var/export/*
*/var/import/*
*/var/log/*
*/var/report/*
*/var/session/*
*/var/tmp/*
*/wp-content/cache/*
*/wp-content/wphb-cache/*
*/wp-content/uploads/wpcf7_captcha/*
*/wp-content/widget-cache/*
*/wptsc-cachedir/*
.MirrorSearch
.cpanel/*.sock
.trash
access-logs/*
clone-*.tar.gz
logs/*
public_ftp/*
public_html/cache/*
site-*.tar.gz
softaculous_clones/*
tmp/*

Default Excludes

JetBackup 5 has certain files and folders that are excluded by default depending on the panel installed. Please see the lists below to see which files and folders are excluded from all Accounts Backup Job.

/etc/*/passwd
/etc/*/shadow
/etc/*/quota
/etc/*/@pwcache
/mail
/.cl.selector
/.cagefs
/.cpanel/email_accounts_count
/.cpanel/email_accounts.json

/imap

Schedules

Clone Job Schedules tells JetBackup the time and frequency a clone job will be executed.

JetBackup gives you the option to set multiple schedules for each clone job.

Create Schedule

You may create and modify schedule(s) through the Clone Job Configuration.

Example configuration page for a new schedule:

Schedule Name

Specify a unique name for your schedule. This will be used internally for your convenience.

Schedule Type

Hourly - Will be executed every X hours.
Daily - Will be executed on the days of the week you choose to execute the clone job.
Weekly - Will be executed once a week, on the day you choose to execute the clone job.
Monthly - Will be executed on the days of the month, from the 1st / 7th / 14th / 21st / 28th day you choose to execute the clone job.
After Backup job is done - The job depends on another Backup job to be finished, only then it will be executed. When this option is chosen, you can also set a "delay" in minutes/hours/days to wait before starting.
After Clone Job Done - The job depends on another Clone Job to be finished, only then it will be executed. When this option is chosen, you can also set a "delay" in minutes/hours/days to wait before starting.

To safely change between schedule types, please add a new schedule on top of your existing schedule(s) and give your clone job ample time (the full retention length of your new schedule) to generate and correctly mark clones with the appropriate schedule type(s). You can then safely remove the previous schedule once the clone job runs for one full cycle of your retention.

Schedule Hours

With an Hourly Schedule Type, you may choose to execute the clone job every one/two/three/four/six/eight/twelve Hours.

Schedule Days

With a Daily/Weekly Schedule Type, you may choose which day(s) of the week to execute the clone job. | With a Monthly Schedule Type, you may choose to execute the clone job from 1st/7th/14th/21st/28th of the month.

Backup Retain

Backup Retain specifies how many clones to keep with the corresponding schedule type. |

Schedule Time

With an /Daily/Weekly/Monthly Schedule Type, you may specify the time of day (based on your server local time) on when to execute the clone job. |

Schedule Delay

With a After Backup/Clone Job is done Schedule Type, you may set how much time to delay a clone job in minutes/hours/days before executing the clone job.

Schedule Time

The time that you want all schedules to be executed.

Monitor

The Backup Job monitor is a feature that will allow JetBackup 5 to send alerts to your configured Notification Integrations for each of the following conditions:

Notify me if there were no clone for X Days
Notify me if clone runs more than X Days

Job Monitor Alerts will marked with the Critical Level.

Clone Job Actions

Click on the preferred Clone Job listed in the Backup Job section to expand and view the available Clone Job Actions.

Enable Clone Job

Click on “Enable Clone Job” to toggle between enabling and disabling your clone job.

Manage Clone Job

Click on “Manage Clone Job” to modify your clone job configuration LINK REF.

Run Clone Job Now

Execute your Clone Job manually and on-demand.

View Backup Logs

Click on "View Clone Job" to see Logs associated to the selected Clone Job.

Duplicate Backup Job

Click on "Duplicate Clone Job" to make a copy of the selected Backup Job.

Delete Backup Job

Click on "Delete Clone Job" to Delete your job permanently.

Additional Information

Symlinks

For clone jobs, JetBackup uses rsync with the –safe-links option to transfer the account data to the destination server.

Only symlinks that are added with the relative path of the file/folder in the home directory are included and any symlinks containing the absolute path of a file/folder will not be included in the clone job. This will also apply to symlinks with absolute paths that point to a folder/file in the home directory.

Logs

To minimize the amount of memory usage, the clone job logs from the source server will include the path to the restore logs from the destination clone server instead of the full log output. You will be able to view the full restore log only from the clone server.

Updating Clone Packages

By default, the initial clone for each account will be assigned its corresponding original package to its clone destination. If the package changes for an account on the source server, the account on the clone destination will remain on its old package. To ensure that the packages for accounts on the clone destination is updated properly, kindly set the Restore package selection on the Clone server from “Live Account Package” to “Backed up package”.

Jb5: Encrypted Backups

Mon, 01 Jan 0001 00:00:00 +0000

For video tutorials, please click here:

JetBackup makes it easy to offer Encrypted Backups to your clients, keeping your user's data safer by adding an additional layer of security. This is specially useful for users that are required to be GDPR (General Data Protection Regulation) compliant by EU law.

To begin, create a backup job as you normally would, making sure to enable Encrypted Backups. Please note that this option is only available with Archived and Compressed Backup Structure.

Once you have your Encrypted Backup Job set up, review your Privacy & Security Settings to add your User Agreement and Privacy Policy as well as to set the number of days JetBackup will keep encrypted backups after an account is terminated. You may also give your clients the option to opt in and out of encrypted backups by enabling the Account Encryption Selection.

By default, users that have not specified their encrypted backup preferences will have their encryption keys stored locally. For users that opts for encrypted backups only, their accounts will be automatically excluded from all other backup jobs with encrypted backups disabled.

Jb5: Restore & Download

Mon, 01 Jan 0001 00:00:00 +0000

For video tutorials, please click here:

In this section, you can view, restore, download, lock, and unlock Account Backups and Directory Backups generated from your Backup Jobs. If you would like to backup specific items for a single account, please visit Account View Backups .

Single Account

The Single Account tab on the Restore and Download page will allow the customization of specific Backup Items to restore and download. Selecting an account will embed the Account View Backups Page for that account.

Multiple Accounts

The Multi Account tab on the Restore and Download page allows actions to be made on multiple Account Backups at once.

Use the Status column on the right to include/exclude specific accounts from the final action. Quickly exlude all accounts using the Exclude All Button at the top of the column.

NOTE:

The account backup must contain the Panel Config Backup Item to be listed for Multi Account Restore & Download.
In JetBackup 5, there are 2 underlying priority systems at work which allows you to control how JetBackup prioritizes backups, restores & downloads. Both of which works so that the lower the value, the higher its priority on the queue. For more Information regarding JetBackup 5's priority systems, please CLICK HERE.

Action Pane

Select Action

Restore - Restore selected backups and are added to the queue.
Download - Download selected backups and are added to the queue, then stored in downloads.
Lock Backups - Lock selected backups to exclude on each associated backup job rotation.
Unlock Backups - Unlock selected backups to include on each associated backup job rotation.

Filters

Filter Account Backups by:

Accounts - Select which accounts to execute the selected action. (Note: Only lists accounts on the server)
Account Status - Filter accounts by the account status (Any/Active/Orphan).
Lock Backups - Select to lock either a specific backup or all backups associated to the filtered accounts.
Unlock Backups - Select to unlock either a specific backup or all backups associated to the filtered accounts.

Show More Filters

Backup Date Range - Choose the range of dates when the backups were generated.
Backup Date Sorting - Sort between the oldest or newest backups from the specified date range.
Destination - Filter backups by the destination they are stored in.
Owned By - Filter backups by the account owner.
Account Suspended - Filter backups by account suspension status.
Backup Lock - Filter backups by whether its locked/unlocked.
Backup Encryption - Filter backups by whether its encrypted/unencrypted.
Backup Structure - Filter backups by structure.
Backup Contains - Filter backups by the content available.

Action Specific Options

Restore

What to Restore

Restore selected account backup items. Available Items:

Panel Configurations (Required)
Home directory Files
Databases *
Database Users *
Email Accounts
FTP Accounts
Cron Jobs
DNS Zones
SSL Certificates

NOTE: When selecting a Database for restore or download without selecting Database Users, ONLY the selected database(s) will be included. If you’re performing a “Databases” restore or download from the Databases (DB) Tab, please ensure the proper Database Users (DB Users) assigned to that Database are also selected BEFORE proceeding with the restore or download.

Restore Options:

Terminate account before restore (Only for non reseller accounts)
Merge live account data with backup data

This option will merge your backup data with the existing data on your account. Live data takes precedence over the restored data.

Suspend account after restore

Restore Conditions:

Conditions specified under the Restore Settings that would need to be accepted in order to proceed with the restoration.

Download

What to Download

Download selected account backup items. Available Items:

Panel Configurations (Required)
Home directory Files
Databases *
Database Users *
Email Accounts
FTP Accounts
Cron Jobs
DNS Zones
SSL Certificates

NOTE: When selecting a Database for restore or download without selecting Database Users, ONLY the selected database(s) will be included. If you’re performing a “Databases” restore or download from the Databases (DB) Tab, please ensure the proper Database Users (DB Users) assigned to that Database are also selected BEFORE proceeding with the restore or download.

Lock Backups

Lock Time

The lock days number. insert 0 to unlimited time.
This snapshot will be unlocked automatically after the X days.

Unlock Backups

Reinstate the selected backup back into the Backup Job rotation it is associated with.

Delete

Directories

In the directories tab, you can view and restore and download all generated directory backups.

Filter Directory Backups by:

Find Directory Searchbox - Search directory backups by directory name.

Restore Directory Backups

JetBackup adds a restore directory backup task to the Queue.

To guarantee the safety and integrity of your system, the Files and/or Directories selected will be restored with a temporary file/directory name at its original location.

For example, when restoring /etc folder, JetBackup will restore it at /etc.jetbackup.xxxx

YOU ARE RESPONSIBLE for completing the restoration process manually.

Please take necessary precautions before restoring core system files and/or directories to avoid any unintended issues with your server.

Files/Folders will be restored with their original Ownership/Permissions EXCEPT for the Parent Directory. For the Parent Directory, the default owner will be root and default permissions will be 0700.

Download Directory Backups

JetBackup adds a download directory backup task to the Queue. Generated downloads will be stored in the configured Download Directory.

Add Notes to Directory Backup

Double click to add a note for the backup.

Additional Information

JetBackup Priority Systems

Restoring Packages

During a restore, JetBackup determines which package to assign to the account (Currently assgined [Live] or Backed up) based on the Restore package selection setting. If the package does not exist on the server, then JetBackup will create the package in order to assign it to the account.

Jb5: Downloads

Mon, 01 Jan 0001 00:00:00 +0000

In the Downloads section, you can view all downloads completed from the queue. Prior to downloading from this page, you must generate a download using the instructions found here.

Completed downloads are stored in the Downloads Directory. Downloads can be accessed via terminal by a user with root access.
Downloads are created with the following format: download_XXX_XXX.tar.gz

Jb5: Disaster Recovery

Mon, 01 Jan 0001 00:00:00 +0000

Jb5: Alerts

Mon, 01 Jan 0001 00:00:00 +0000

For video tutorials, please click here:

In the Alerts section, you can view all alerts generated from JetBackup processes.

Alert Types

Information Alerts - Minor alerts that does not affect any JetBackup processes. Includes alerts about started + completed backup jobs, reindex, download, and restore processes and plugin updates.
Warning Alerts - Major alerts that might affect JetBackup processes. Includes alerts about Partially Completed backup jobs, reindex, download and restore processes. This could also include other warnings such as your trial license is about to expire, unable to connect to repositories, an account restore was aborted intentionally, etc.
Critical Alerts - Major alerts that will affect JetBackup features. You will be notified when backup jobs, restore, downloads, or reindex processes has failed/aborted/never finished, the backup job hasn't run for a few days. Additionally, an expired license/trial license and unable to validate license will be considered a critical alert.

Send Logs

Shows if an alert notification was sent successfully to your Notification(s) Plugin or not and shows the error that caused the failure.

Days to keep alerts

Under General Settings, you have the option to specify how long you would like to keep Alerts in JetBackup. JetBackup automatically deletes the alert(s) once it reaches the specified number of Days.

Jb5: Queue

Mon, 01 Jan 0001 00:00:00 +0000

For video tutorials, please click here:

In the queue section, you will be able to view all JetBackup processes (backups, restores and downloads) that are executed manually by you and users you have ownership of, as well as view their status (Completed, Failed, Cancelled, Pending, Processing). By default, JetBackup will run 3 items simultaneously. You can change the number of concurrent processes that JetBackup will execute under the Performance Settings.

Queue items will remain in the queue history depending on the configuration of the Debug Active setting.

Debug Active Enabled - 12 hours
Debug Active Disabled - 48 hours

Queue Types

Backup
Clone
Restore
Download
Security
Reindex

Queue Actions

View Group Items

View the individual items processed within the queued task.

View Log File

View the log generated from the queued task.

Stop Items

Terminate pending or processing items from the queue.

Retry Failed Items

Attempts to retry failed items from the queue.

Jb5: Logs

Mon, 01 Jan 0001 00:00:00 +0000

For video tutorials, please click here:

In the logs section, you will be able to view and download all general logs for JetBackup-related processes and check their corresponding status.

Log Types

You can browse specific log types with the filter drop-down menu.

All Logs

Displays JetBackup logs of all types. (default)

Backup Logs

Backup logs contains information regarding Backup Jobs processes.

Download Logs

Download logs contains information regarding Backup Download processes.

Restore Logs

Restore logs contains information regarding Backup Restore processes.

Reindex Logs

Reindex logs contains information regarding Destination Reindexing processes.

System Logs

System Logs contains information regarding JetBackup system processes such as JetBackup events and hooks.

Log Statuses

Completed

The action was successfully completed.

Partially Complete

Indicates that the task didn't finish processing all items completely.

Failed

The task failed to execute.

Aborted

Indicates that the task was stopped by the user or that there are no accounts to process(all accounts were filtered out).

Never Finished

Usually indicates that a problem occured and "killed" the process.

Processing

The task is currently running.

Log Options

Download Log File

Download selected Log file locally from the browser.

View Log File

View the Log associated to the processed task.

View Log Summary

View the Summary of the Log for the associated processed task. You can view the log snippet for a specific account by pressing on the account within View Log Summary.

Delete Log File

Deletes the selected log file from the server permanently.

Jb5: Permissions

Mon, 01 Jan 0001 00:00:00 +0000

For video tutorials, please click here:

With the Permissions Manager interface, you can view and manage JetBackup permissions for Global and Specific accounts on your server.

Permissions Type

Global Permissions

The permissions for all resellers/users.

Specific Permissions

You can change permissions for a specific account.

Permissions Options

If the permission is set to never, you can't override it. Otherwise Yes/No permissions can be overridden.

Yes - Grant permission for the corresponding option.
No - Deny permission for the corresponding option.
Never(Global) - Deny and disable ability to override permission for the corresponding option.
Inherit(Specific) - Inherit the permission from the global permission.

Restore to Defaults

Reset permissions to the Default values.

Default Permissions

All specific permissions are set to Inherit from global permissions by default.

Legend

✅ Yes
❌ No
⚠️ Can be Enabled
Never

Global Permissions

Permission Name		Permission Name
Has All Privileges	Never	Can Manage Accounts	✅
Can Restore Backups	✅	Can Download Backups	✅
Can Manage Full Backups	✅	Can Manage File Backups	✅
Can Manage Cron Job Backups	✅	Can Manage Email Account Backups	✅
Can Manage Database Backups	✅	Can Manage SSL Certificate Backups	✅
Can Manage Domain Backups	✅	Can Manage Configuration Backups	✅
Can Manage Backup Jobs	❌	Can Manage Destinations	❌
Can Manage Hooks	❌	Can Manage Permissions	Never
Can View Logs	❌	Can Manage Logs	❌
Can View Alerts	✅	Can Manage Directory Backups	❌
Can Manage FTP Account Backups	✅	Can Manage Clone Jobs	❌
Can Manage Server Backups (BMR)	❌	Can Access Socket API	❌

Enabling the "**Access Socket API**" allows JetBackup for WordPress administrators to access and restore hosting backups

Admin vs. End User Panels

Section	Admin	Reseller	End-User
Dashboard	✅	✅	✅
Accounts	✅	❌ ⚠️	❌
Destinations	✅	❌ ⚠️	❌
Backup Jobs	✅	❌ ⚠️	❌
Clone Jobs	✅	❌ ⚠️	❌
Restore & Download	✅	✅	✅
Downloads	✅	✅	✅
Alerts	✅	✅	✅
Queue	✅	✅	✅
Logs	✅	❌ ⚠️	❌
Permissions	✅	❌ ⚠️	❌
Hooks	✅	❌ ⚠️	❌
Security	✅	❌	❌
Plugins	✅	❌	❌
Settings	✅	❌	❌

Jb5: Hooks

Mon, 01 Jan 0001 00:00:00 +0000

Jb5: Security

Mon, 01 Jan 0001 00:00:00 +0000

For video tutorials, please click here:

Make JetBackup interact with various security plugins through specific hook points, allowing your security plugin to trigger JetBackup and automatically execute a file restore and/or lock the latest clean incremental account backup of the infected account to assure data protection.

Choose the security plugin you prefer to use through the Security Plugin drop-down menu:

Natively Supported Security Plugins:

Imunify360

Imunify360 helps you provide a secure and reliable web hosting service. It’s multi-layered defense architecture ensures precision targeting and eradication of malware and viruses. For more information, please visit the official Imunify360 website.

Note: KernelCare is included with the purchace of the Imunify360 license. Contact our support team for installation assistance, or feel free to contact Imunify360 Support for more information.

Actions

Choose what action(s) JetBackup will perform and at what point of detection once Imunify360 triggers an alert.

Restore Infected Action

JetBackup will restore the infected file from the most recent backup.

Lock Infected Action

JetBackup locks the last backup of the affected account.

Activation

To activate your license key from JetApps, please run the following command on your server terminal:

imunify360-agent register <License Key Here>

You can locate your Imunify360 License Key by logging into your JetApps Client Area and navigating to “Services” > “Click on your Imunify360 License”. From there you’ll find the License Key under License Details.

If you have an existing license from a different provider, please make sure to unregister the previous license before registering your new license by running the following command:

imunify360-agent unregister

Once registered, you can verify the license status using the following command

imunify360-agent status

Transfer License to Another Server

To move the Imunify 360 license to another server using the commands above:

Unregister the the license from the old server it is currently connected to Register the license on the new server If you no longer have access to the old server, please contact our support team so that they can assist you with this process.

BitNinja

BitNinja is a multi-layered security software that utilizes a variety of modules to prevennt incoming attacks and secure a safe web hosting environment. Its Malware Scanner can detect infected files and initate Backup Locks to protect your backups. For more information, please visit the official BitNinja website.

Actions

Choose what action(s) JetBackup will perform and at what point of detection once Imunify360 triggers an alert.

Post Script Trigger

JetBackup will trigger a Backup Lock after an infected file is detected:
- Post Detection: Backup Lock immediately after deting the infected file.
- Post Quarantine: Backup Lock after the infected file is quarantined.
- Post Honeypotify: Backup Lock after the infected file is replaced with a honeypot file.

Cooldown Time

Set the period between locking backups. (per account)

Lock Period

Set how long backups will be locked in days. (per account backup)

Installation Guide

To install BitNinja on your Linux Server, kindly log in to your JetApps Client Area to retrieve the License key. Use the one-line command to install BitNinja on your server.

curl https://get.bitninja.io/install.sh | sudo /bin/bash -s - --license_key=<License Key Here>

Paste the command to your server’s terminal and hit enter, following with Y once you are prompted to confirm the installation.

Note: If you need to activate a new license, you must uninstall the current installation

Uninstall

yum remove 'bitninja*'

apt-get purge 'bitninja*'

Jb5: Plugins

Mon, 01 Jan 0001 00:00:00 +0000

Jb5: WordPress Integration

Mon, 01 Jan 0001 00:00:00 +0000

In the “WordPress Integration” section, you have the option to control whether JetBackup for WordPress is installed either by integration with WP-Toolkit, Softaculous, or WordPress Manager (DirectAdmin). In this section, you can also exclude domain patterns from installation, enter a Partner Token for automatic JetBackup WP Pro licensing during deployment, and a quick toggle to allow Socket API Access for all users. You can choose to install on new or existing sites, or only allow the Socket API access to allow users who install JetBackup WP to restore backups generated in JetBackup 5.

JetBackup WP offers easy to use backup and restore functionality designed with WordPress end users in mind, and features the new ability to restore JetBackup 5 backups from the WP Admin interface for FREE. For more information, visit https://www.jetbackup.com/jetbackup-for-wordpress/

Enable New Installation Hooks

You can choose which vendors to enable for automatic WordPress plugin deployment on new WordPress sites. JetBackup will use the selected vendors to automate plugin installation on your WordPress sites. Options that are unchecked will NOT be used for new installations OR Mass deployment.

This option controls which vendors are enabled for the “Deploy on all WordPress Sites Now” option. For example, if you enable WP Toolkit and click “Mass deploy on all sites”, it will only run on WordPress sites indexed by WP Toolkit.

Note that the WordPress site must meet the minimum requirements for JetBackup WP. (PHP 7.4+, WordPress 6.0+)

Sites to Exclude

Exclude Patterns for the new installation hooks or mass deployment. Note that the pattern should include a path to be valid.

Partner Token

(JetBackup Partners Only)

Allows saving a Partner Token to generate a single-domain JetBackup WP Pro License and install it with the WordPress deployment. This feature is available to JetBackup Partners only - for more information on how to generate a token, refer to the JetLicense documentation.

Allow Socket API for All Users

Toggles the “Allow Socket API Access” permission to “Yes” globally. The Socket API allows secure restore-only access to JetBackup 5 backups within the JetBackup WP user interface.

We recommend keeping this option enabled to allow the Socket API for any clients that install JetBackup WP themselves. While this option functions independently and does not require New Installation Hooks or Mass deployment, the WordPress administrator will need to manually enable the “JetBackup 5 Integration” in JetBackup WP.

Deploy on All WordPress Sites Now

Deploy on all WordPress sites using enabled New Installation Hooks vendors. This will use the selected vendor to list all WordPress paths, and then install JetBackup WP securely through the WordPress marketplace using WP-CLI. If a Partner Token is provided, the key will be automatically generated and installed in JetBackup WP.

Jb5: Settings

Mon, 01 Jan 0001 00:00:00 +0000

For video tutorials, please click here:

This section allows you to configure and finetune your JetBackup 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.

End Users Can Use Damaged Backups

Enabling this option will allow end users to see and use the damaged backups. Please note that although the backups will be marked damaged on the admin side, the damage status will not be visible on the end user’s side.

Use Community Languages

Enable to use translations from our community languages CDN instead of local translation files. For more information, CLICK HERE

Workspace Directory

Specify the directory that JetBackup will use to store all the temporary files.
[ default: /usr/local/jetapps/usr/jetbackup5/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/jetbackup5/downloads ]
To prevent issues with system performance, we recommend creating a new directory in the destination and to NOT move the original folder.

Note for Plesk Installations: When changing the download directory, the pssaadm user must have permissions to access the new directory in order to donwload the backups via JetBackup.

Delete orphan backups older than

Orphan backups are account backup files that are not associated with any active account. If an account is terminated, all associated backups will be set to orphan status and in turn become orphan backups. JetBackup will automatically remove these backups if the creation dates (when the backups were generated) are older than the number of days specified in this field. [default: 180 days]

NOTE: When a backup is changed to orphan status, its creation date will still be the date that it was generated. It will NOT be the date that the account was terminated.

Downloads TTL

Set the preferred number of days to store downloads generated in JetBackup. [ default: 0 days (Don't delete) ]

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]

Manual Backups Retain

Specify the maximum number of manually generated backups that JetBackup will maintain, for each backup job. [Max: 99] [ default: 14 backups ]

Manual Backups TTL

Set the number of days JetBackup will keep manually generated backups. [ default: 0 days (Don't delete) ]

NOTE: Manual Backups will be DELETED based on the Manual Backups TTL, regardless of the account's status (Active/Orphan).

Time Format

Set the time display format for the JetBackup UI to 12 or 24 hour based. [ Default: 12 hours based (e.g. 11:00PM) ]

Performance

Concurrent System Tasks

Set the maximum number of concurrent system tasks that may run simultaneously for the Backup Cleanup/System Integrity Check Task. Please note that for each account, JetBackup will open a fork on the server. (Maximum 10 accounts)

Concurrent Restore / Download / Reindex Tasks

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

Concurrent Backup / Clone Tasks

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

Concurrent threads and destination workers work together to make the backups faster and more reliable. It allows multiple connections to the storage destination, speeding up the backup process. Destination workers help manage these connections, ensuring data is transferred smoothly. Please take into account your storage provider's rate limits in configuring these settings - If you notice that your backup job transfer speeds keeps getting rate limited, try lowering down your threads and workers settings to 1 then gradually increase it to determine the appropriate settings that works best with your destination.

Important: Each fork created for concurrent restores/downloads/backups can use up to 100% CPU usage per core.

Backup Fork TTL

Set the maximum time a Backup Fork can run in hours. The fork will automatically abort once it reaches the specified TTL, regardless of its current status.

Only enable this setting if you know how long the largest account on your server takes to complete its backup. Setting this too low may potentially result in some account backups being aborted prematurely.

Backup Cleanup & Integrity Check Schedule

Note: During each Backup Job run, JetBackup marks all files/backups that needs to be removed. These files will then be cleaned up and deleted during the Backup Cleanup and Integrity Check process.

To prevent potential conflicts, avoid initiating a backup job while an Integrity Check is in progress.

Set how often the backup cleanup and integrity check task should run in days. This task performs cleanup of files marked for delete, and verifies the integrity of the backups on the remote destination. Any empty account backup directories will be deleted.

If problems are detected with the backup integrity, those snapshot(s) will be marked as "damaged" in the UI and will ensure any missing data detected from the damaged snapshot(s) are uploaded on the subsequent scheduled backup run.

In the case of an invalid index file, JetBackup will attempt to fix it using the snapshot index files. If the snapshot index files are missing or corrupted, then the snapshot directory will be deleted along with the associated export files.

Minimum is once per day, with a maximum of every 90 days. [ Default: 7 Days ]

Limit Accounts Downloads

Select the number of downloads that you permit to keep for each account.

Queue Priority Groups

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

NOTE: JetBackup prioritizes restores by the account type out of the box along with the Queue Priority Groups setting that controls backup, restore and download priority. For more Information regarding JetBackup 5's priority systems, please CLICK HERE.

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"

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

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.

Resource

Set server resource limits of JetBackup processes using CGROUPS Please note that 100% is one core. For more information on analyzing your current server load please visit Load WIKI

CPU Limit

Limit the CPU Usage of JetBackup Processes. [ min: 5%, default: unlimited ]

IO Read Limit

Limit the IO Read Usage of JetBackup Processes. [ default: unlimited ]

IO Write Limit

Limit the IO Write Usage of JetBackup Processes. [ default: unlimited ]

NOTE: Limiting IO read/write can indirectly cause increased IO usage. On IO constrained servers it is recommended to adjust other backup settings (rsync bandwidth limit, concurrent tasks/threads) before setting IO limits.

Restore

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.

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

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.

Specify the permission glob pattern, 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".

Limit Restore per account

Limit the number of restores an account can perform within a certain time period. To disble the limit, enter 0 in either one of the fields. [ Default: Disabled ]

Restore package selection

Choose whether to use the Live Account Package or the Backed Up Package when restoring accounts. The default when restoring a full account is to keep the currently assigned (live) package instead of re-assigning the package that account was using when the backup was generated. [Default: Live Account Package]

Lock account homedir while restoring files

Choose whether to lock the account home directory with 000 permissions when performing a Home Directory restore, or only lock the directories/files being restored via umask. Locking the home directory ensures other processes are not able to read/write to the home directory while the restore is in progress. [ Default: Yes ]

NOTE: When performing large home directory or files restores, locking the home directory for an extended period of time may may cause various permission denied errors while the restore is in progress. You can disable the home directory lock if you encounter errors in the panel during restore.

Privacy & Security

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/users the option to choose the Backup Type they prefer.

NOTE: A backup job will be aborted if all clients/users assigned to the job select a preferred backup type (Only encrypted, No backups) that would exclude all accounts from that job.

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 ]

MFA Config

Enable MFA Enabled to globally enable or disable Multi-Factor Authentication (MFA) for all users.

Enable Force MFA on all accounts to require all users to configure and use MFA. Users without MFA configured will be prompted to set it up on their next login.

Enable Require MFA on CLI API to enforce MFA authentication when using the JetBackup CLI API.

NOTE: Enabling Require MFA on CLI API may impact automation or scripts that rely on API access.

Panel

Panel Options

Panel options may vary based on the control panel you're using. See the "Control Panels" column for the Panels a setting applies to.

To create API Access Tokens for the Linux Panel, see API Access Tokens (Linux).

Setting Name

Description

API Access Tokens (Linux)

In order to communicate with the JetBackup API on Linux (Standalone) servers, you must first create an API Access Token. After creating the Token, you can pass it in the request header to authenticate and run API commands on your server.

API Access Tokens can be created in the following configurations:

Any user allowed from defined IP address.
Any user allowed from any IP Address.
Specific user allowed from any IP address.
Specific user allowed from defined IP address.

Running an API command as a certain user will use their set permissions. Please refer to Permissions to assign to modify permissions assigned to an account. Please use caution when creating an unrestricted token, and keep the token saved in a secure location. For security, we recommend restricting by account and IP address.

curl -kv -H "Authorization: Bearer user1:oXBbdPuFmEtJZGYV6XQlLaxGdWm4InOQ" "https://HOST_NAME:3035/?api=1&function=getMyAccount"

NOTE: Failed/Invalid authentication will return HTTP status code 401 Unauthorized.

Create New Access Token

Description:

Enter a description for the Access Token. Used internally for your convenience. (Required)

IP Address:

Enter an IP Address to restrict token use to that IP address. Leave blank to allow all IP addresses to access the API using this token.

Account:

Restrict the Access Token to a specific Account. (Can be root)

If blank, allows you to use that token to run API commands as the user using that accounts permissions.

Please refer to Permissions to assign or modify permissions assigned to an account.

Access Token Details

Delete Access Token

Remove the selected access token.

Manage Access Token

Modify the selected Access Token Details.

Created

The date/time the token was created.

Token

The access token used to authenticate remote API calls, and a short description. This will only be displayed once when creating the token.

IP Address

The IP of the machine the user will be doing remote API calls from.

Account

The account the API token is restricted to perfoming remote API calls as.

Last Access

The most recent time and IP address from when the token was used.

Backup on Demand

Backup on Demand gives your users the ability to create a point-in-time full account snapshot of their account(s). On-demand backups are useful right before making any changes to a user's site, email, databases, etc. If necessary, they can conveniently roll back to the recent on-demand backup instead of restoring the last scheduled backup.

The following settings control the global Backup on Demand settings.

Backup Job

Choose the backup job to use for backups on demand. The backup job must be enabled to be selected.

Maximum Backups per Account

The global maximum On Demand backups allowed for each account. [Max: 99]

You can adjust Account specific Backup on Demand settings under Manage Account.

How Long Keep Snapshots

Set the amount of days to keep backup on demands on destinatons.

Automatically disable backup on demand in the following cases

JetBackup will disable the option of creating snapshots for Users and Resellers if they meet the conditions specified in this section.

Please Note: The first condition that hits will trigger the disable.

Disk Space: If an account is greater than or equal to the set Disk Space limit, they will not be able to generate a Backup on Demand.
Inodes: If an account has more inodes than the set limit, they will not be able to generate a Backup on Demand.

Please ensure your server is able to report Disk Space Usage, and Inodes for each account. For JetBackup 5 Linux users, please see: Disk Usage/Inode Usage N/A on JetBackup 5 for Linux. Panel versions of JetBackup will gather the details from the Panel API.

Notification

Click on "+ Create New Notification Integration" to set up your notifications. Under Integration Type, you can select the Notification Plugin you would like to use to send JetBackup alerts. JetBackup comes with the Email Notification Integration installed by default. Below is a sample setup of an Email Integation:

Create New Notification Integration (Email)

Integration Type

The Type of Notification Integration you would like to set up.

Integration Name

Specify a unique identifier for your Notification Integration. This will be used internally for your convenience.

Owner

Specify the owner for this Notification Integration. This grants the owner and its parent account(s) permission to modify and delete this Notification Integration.

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

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

Jb5: Localization / Translation Guide

Mon, 01 Jan 0001 00:00:00 +0000

Getting Started

JetBackup supports multiple languages, and you can localize and translate our language files to your desired language. You can enable Use Community Languages to use translations from our community languages CDN or adjust your local translation files manually.

Please note: There is a known issue in version 5.3.9 or lower where some regional languages will not be translated. This issue has been resolved in v5.3.10+. (Expected to be released to Stable tier July 2024)

Community Languages

When Use Community Languages is enabled, JetBackup will use translations from our community languages CDN instead of local translation files. Any local translation files will be ignored.

To view the available languages and contribute to community translations (A free Localazy account will be needed), please visit:

https://locales.jetbackup.com

Local Translation

The process to translate JetBackup will depend on your panel version, cPanel/WHM or DirectAdmin. Please pay special attention and ensure you're copying files to the paths that correspond with your Panel.

Language File Structure

The translation structure for the .json files in cPanel and DirectAdmin panels is 'key':'value'. You only need to change the value to your translation. JetBackup uses these .json files for each UI text element. For example, to translate the word "And" to German, you would edit "And":"And", to the German the translation of: 'And':'Und'

cPanel & WHM

CPanel/WHM Interface Translation

These are the paths you will need to begin translating:

/usr/local/jetapps/var/www/jetbackup5/docroot/app/lang/en/{SECTION.json}

/usr/local/jetapps/var/www/jetbackup5/docroot/app/lang/override/xx/

Step 1 - Copying the Language Files

The "en" folder contains the default English language files for JetBackup and each file corresponds to a section in the JetBackup WHM interface. These files will be used as a starting point for translating JetBackup.

To begin translating JetBackup, copy all the files inside the English folder to the "/override/xx" folder.
Rename "xx" with your preferred language code.

The "override" folder does not exist by default. You may need to create the override folder if it doesn't exist.

For all WHM sections available for translation, please check the following directory: /usr/local/jetapps/var/www/jetbackup5/docroot/app/lang/en

To view a list of locales/language codes available in cPanel, please refer to
https://docs.cpanel.net/whm/locales/view-available-locales/.

Step 2 - Start Translating

Once you have your override folder set up, you may start translating each section in your language folder by editing the associated {SECTION}.json file.

For example, to translate the JetBackup Dashboard to Spanish:

Create the "es" folder inside the "override" folder
(/usr/local/jetapps/var/www/jetbackup5/docroot/app/lang/override/es)
Copy
/usr/local/jetapps/var/www/jetbackup5/docroot/app/lang/en/dashboard.json
to
/usr/local/jetapps/var/www/jetbackup5/docroot/app/lang/override/es/dashboard.json
Edit the override/es/dashboard.json file in your preferred text editor and begin translating.

Here is an example snippet:

{
   "Total Accounts" : "Cuentas Totales",
   "Total Jobs" : "Trabajos Totales",
   "Total Backups" : "Copias de Seguridad Totales",
   "Jobs Running" : "Trabajos en Ejecución",
   "New Alerts" : "Nuevas Alertas",
   "Total Accounts Usage (%s)" : "Uso Total de Cuentas (%s)"
}

Time

You can change the date format showing on the WHM GUI by editing /usr/local/jetapps/var/www/jetbackup5/docroot/app/lang/en/date.json. To view the available format click on
https://momentjs.com/docs/#/displaying/

date: {
         /** See the moment date format documentation: https://momentjs.com/docs/#/displaying/ **/
         short: "D MMM YYYY",
         shorttime: "D MMM YYYY hh:mm A",
         long: "ddd, MMM D, YYYY",
         longtime: "ddd, MMM D, YYYY, hh:mm A"
      }

DirectAdmin

JetBackup can be translated in DirectAdmin using the guide below. Please note that this guide only goes into detail on translating JetBackup. If you'd like to translate other areas of the DirectAdmin interface, you will need to follow their documentation here: https://help.directadmin.com/item.php?id=704

Please exercise caution when downloading external files!

DirectAdmin Panel Translation

These are the paths you will need to begin translating for the DirectAdmin Panel:

/usr/local/directadmin/plugins/jetbackup5/images/app/lang/en/{SECTION.json}
/usr/local/directadmin/plugins/jetbackup5/images/app/lang/override/xx/

Step 1 - Copying the Language Files

The "en" folder contains the default English language files for JetBackup and each file corresponds to a section in the JetBackup DirectAdmin interface.

To begin translating JetBackup, copy all the files inside the English folder to the "/override/xx" folder.
Rename "xx" with your preferred language code.

You may need to create the override folder if it doesn't exist. Please note that for DirectAdmin, you will need to create an override folder in the 2 file paths listed above.

For all sections available for translation, please check the following directory: /usr/local/directadmin/plugins/jetbackup5/images/app/lang/en/

For a list of language codes, please refer to http://www.lingoes.net/en/translator/langcode.htm.

Step 2 - Setting Permissions

Once you have your override folder set up, you will need to set the file ownership and permissions.

Your override folder in /usr/local/jetapps/var/www/jetbackup5/docroot/app/lang/ should be owned by root:root and permissions should be 644 for files, 755 for Directories.
Your override folder in /usr/local/directadmin/plugins/jetbackup5/images/app/lang/ should be owned by diradmin:diradmin and permissions should be 644 for files, 755 for Directories.

If the file ownership and permissions are not set properly, the interface will revert to the default English version regardless of any translated files.

Step 3 - Start Translating

Once permissions have been set, you may start translating each section in your language folder by editing the associated {SECTION}.json file.

For example, to translate the JetBackup Dashboard to Spanish:

Create the "es" folder inside the "override" folder (/usr/local/directadmin/plugins/jetbackup5/images/app/lang/override/es/)
Copy /usr/local/directadmin/plugins/jetbackup5/images/app/lang/en/dashboard.json to /usr/local/directadmin/plugins/jetbackup5/images/app/lang/override/es/dashboard.json
Edit the override/es/dashboard.json file in your preferred text editor and begin translating.

Step 4 - Changing the Language in DirectAdmin

After translating the files, you will need to ensure the panel language for DirectAdmin is set properly. This can be done on a per-user or global basis.

To change the language on a per-user basis, perform the following steps:

** You may replace the "admin" text in the below path with the user account you'd like to edit.

Depending on the user type, edit these configuration files.
- Users: /usr/local/directadmin/data/users/admin/user.conf
- Resellers: /usr/local/directadmin/data/users/admin/reseller.conf
Add language=xx to the conf file and save your changes.
Restart the JetBackup5 and DirectAdmin services.

To change the language on a global basis, perform the following steps:

Open the file /usr/local/directadmin/conf/directadmin.conf in your preferred text editor.
Add language=xx to the file and save your changes.
Restart the JetBackup5 and DirectAdmin services.

NOTE: This will not translate the DirectAdmin UI, only JetBackup 5 will be translated globally. To add a language in DirectAdmin, click here.

Here is an example snippet from dashboard.json after translating to Spanish:

{
   "Total Accounts" : "Cuentas Totales",
   "Total Jobs" : "Trabajos Totales",
   "Total Backups" : "Copias de Seguridad Totales",
   "Jobs Running" : "Trabajos en Ejecución",
   "New Alerts" : "Nuevas Alertas",
   "Total Accounts Usage (%s)" : "Uso Total de Cuentas (%s)"
}

Jb5: Command Line Tools

Mon, 01 Jan 0001 00:00:00 +0000

JetBackup 5 API commands

To utilize the JetBackup 5 via CLI, please refer to our documentation here. Our API allows you to execute many tasks that you would perform on the JetBackup GUI plus more features. You would be able to use the API to manually run jobs, create destinations, manage settings, etc.

JetApps CLI

The JetApps CLI commands allow you gather information on JetBackup packages as well as update/install/remove JetBackup Packages. See the table below for all available JetApps Flags or run the following command on your terminal

/usr/bin/jetapps --help

Options

The JetApps CLI has the following options:

Option	Description	Flag
list	List all installed and available jetapps packages	`-l / --list`
list-installed	List all installed jetapps packages	`-d / --list-installed`
info	Print information about jetapps package	`-i {package} / --info {package}`
install	Install a jetapps package on your system	`-s {package} {tier} / --install {package} {tier}`
update	Update a jetapps package on your system	`-u {package} / --update {package}`
chtier	Change a jetapps package tier	`-t {package} {newTier} / --chtier {package} {newTier}`
chupdate	Change a jetapps package auto update status	`-p {package} {yes/no} / --chupdate {package} {yes/no}`
remove	Remove a jetapps package from your system	`-r {package} / --remove {package}`
version	Print jetapps cli tool version	`-v / --version`
help	Print the help screen to the terminal	`-h / --help`

JetBackup 5 pkgacct

The JetBackup 5 pkgacct CLI command will allow you to backup an account locally in a .tar.gz file located in the Workspace Directory

To run pkgacct, run the following command as root user:

/usr/bin/jetbackup5 --pkgacct {ACCOUNT} [options]

Options

The pkgacct command accepts the following options:

Option	Description	Example
{ACCOUNT}	REQUIRED: The username of the account you wish to backup.	`jetbackup5 --pkgacct user1`
-oSkip	Give the backup items of the account that you do NOT want to include in the backup. config - Panel Configuration homedir - Home Directory Files db - Database dbuser - Database Users email - Email Accounts and Structure ftp - FTP Accounts cron - Cron Jobs dns - DNS Zones ssl - SSL Certificates	`-oSkip config,homedir`

JetBackup 5 restorepkg

The JetBackup 5 restorepkg CLI Command will restore an account using a JetBackup 5 Compressed Backup.

To run restorepkg, run the following command as root user:

/usr/bin/jetbackup5 --restorepkg {PKG_PATH} [options]

Options

The restorepkg command accepts the following options:

Option	Description	Example
{PKG_PATH}	REQUIRED: The absolute path to the .tar.gz backup of the account you wish to restore.	jetbackup5 --restorepkg /PATH/TO/TAR/jetbackup-acct.tar.gz
-oOwner	Set the new owner manually, Default Owner.	-oOwner {USERNAME}
-oPackage	Set the new package manually, Default Package.	-oPackage {PACKAGE_NAME}
-oMerge	Merge backup data with live account data, Default No	-oMerge {Yes/No}
-oTerminate	Terminate account before restore Default No (only if account exists)	-oTerminate {Yes/No}
-oReseller	Set the account as reseller, Default No (only if account is orphan or -oTerminate provided)	-oReseller {Yes/No}e>
-oSuspend	Set the account as susepended after the restore, Default No.	-oSuspend {Yes/No}
-oIP	Set the new IP Address manually, Default IP.	-oIP {IP_ADDR}

JetBackup 5 JB Config Export and Import

The JetBackup 5 Export CLI Command will generate a compressed JB Config file containing all the data from the JetBackup MongoDB and Installed Plugins/Repositories and store it in the /usr/local/jetapps/usr/jetbackup5/exports/ directory.

JetBackup will generate a Daily Export JB file and keep up to 7 stored snapshots. The Daily Export files are located in /usr/local/jetapps/usr/jetbackup5/dailyexports/{EXPORT_FILE} directory.

The JetBackup 5 Import CLI Command will extract and import the data from an exported JB Config file.

/usr/bin/jetbackup5 --export

/usr/bin/jetbackup5 --import {PATH/TO/EXPORT_FILE}

Options

The export/import command accepts the following options:

Option	Description	Example
{PATH/TO/EXPORT_FILE}	REQUIRED FOR IMPORT: The absolute path to the .tar.gz JB Config export file.	jetbackup5 --import /PATH/TO/TAR/jetbackup5_export_XXXXXXXXXX.tar.gz

jb5login (Linux Panel)

The jb5login script generates a single-use session login URL for the active ssh user.

/usr/bin/jb5login

To create a single-use session login URL for a specific user, use the following:

/usr/bin/jetbackup5api -F panelAPI -D "call=createUserSession&user={USERNAME}"

Jb5: FAQ & Troubleshooting

Mon, 01 Jan 0001 00:00:00 +0000

Frequently Asked Questions (FAQ)

What is the fastest backup destination method?

The fastest backup destination will be the Local storage (provided that it's on a separate device).

For best performance, it is also recommended to exclude files/folders, and disable backup for suspended accounts.

How do I improve my Backup/Restore performance?

If you're experiencing poor performance during your backup/restore procedures, consider adjusting the concurrent tasks setting through Settings->Performance section. This feature allows you to adjust the number of backup or restore tasks performed simultaneously. Please note that simply increasing this value may not guarantee faster performance. External factors such as rate-limiting by your storage provider could influence the speed of these processes.

Additionally, you may want to consider the geographic distance between the source server and the destination server. The greater the distance, the more likely factors like high latency, packet loss, and other elements may affect the backup/restore performance.

In some cases, such as SSH destinations where root access is not under your control, configuring the Concurrent Tasks to a range of 1-2 may increase speed in the backup and restore process.

Does JetBackup provide backup storage?

We now offer JetBackup Premium Cloud Storage, fully optimized for effortless integration with JetBackup 5. This service ensures reliable and secure backup solutions tailored to your needs.

JetBackup Premium Cloud Storage is our Best-in-Class Cloud Storage Solution providing unparalleled performance, effortless integration, ironclad security, and enterprise-level compliance at a fraction of the cost of competitors.

You can find the full documentation here.

How do I perform a cross-panel migration?

JetBackup is able to seamlessly migrate your accounts between supported panels (cPanel, Plesk, DirectAdmin).

The recommended method to do so after installing JetBackup on both the source and destination server is:

Perform a Full Account backup of the account(s) that you want to migrate on the source server using a remote destination.
Add the remote destination as a Read-Only Destination on the destination server.
Restore the account(s) on the destination server. They can be found by viewing Orphan Accounts or filtered as Orphan Accounts in Restore & Download. If an account with the same username already exists on the destination server, then reassign the UUID of the account to access the backups from the remote destination and restore.

Why are my backups marked as damaged?

If any issues are discovered during the integrity check of the backups, JetBackup will label those snapshot(s) as "Damaged". This indicates that one or more items in the selected backup are corrupted or did not transfer properly during backup and attempting to restore the account with these "Damaged" backups may result in unexpected errors/failures.

How to Verify if Backups are Marked as "Damaged"

To determine if the backups are damaged, we must first run the Integrity Check. You may run the Integrity Check process manually by executing the command below.

jetbackup5api -F runIntegrityCheck

If the Integrity Check finds any issues with the backups, it will mark them as "Damaged". Below are several methods to verify whether the backups have been labeled as "Damaged"

In the terminal, use the grep command to filter "found to be damaged" in the Integrity Check log files. The Integrity Check log files will be prefixed 64_LOGID.log

grep -Rn 'found to be damaged' /usr/local/jetapps/var/log/jetbackup5/queue/

Utilize the JetBackup API to execute the following command, listing all backups for an account that matches the specified Backup Type/Contains. Any damaged backup will be indicated as Damaged: 1 in the result.

jetbackup5api -F listBackupForTypeName -D "type=1&contains=511&account_id={$ACCOUNT_ID}&name={USERNAME}"

_id: 663e892e0490bd0d35025a15
    parent_id: 663e89260490bd0d350259d5
    account_id: 663675ba98c5c818fd0b34d3
    destination: 663e7f7d0f17de7b54086f22
    destination_name: localv2
    name: demo1
    created: 2024-05-10T20:52:54+00:00
    path:
    backup_type: 1
    backup_contains: 511
    account: demo1
    account_data:
      _id: 663675ba98c5c818fd0b34d3
      username: demo1
      owner: admin
      owner_id: 663675b998c5c818fd0b34d2
      package: undefined
      suspended:
      reseller:
      root:
    size: 281996
    params:
    backup_structure: 1
    notes:
    location:
    safety:
    deleted:
    lock:
    lock_ttl:
    damaged: 1 <<< Backup is damaged
    disabled:
    schedules:
      0: 8
    hidden:
    encrypted:
    encryption_id:
    encryption_key_required:
    encryption_key_exists: 1

Can I manually move my backups?

We don't recommend manually relocating backups to another destination/path because backups may have a different format between destination types or cause unintended conflicts when JetBackup expects the original path when reindexing and lead to corrupted backups.

How to Manually Restore an account from SSH/Local destinations

NOTE: These instructions only apply for backups stored in SSH(Legacy) and Local(Legacy) destinations that utilizes file-level storage. For backups stored in S3 Compatible | SSH/SFTP (SSHv2) | Localv2 Destinations, please use the JetBackup 5 Restore Interface.

The steps to manually create a compressed archive in SSH/Local destinations that can be used with jetbackup5 CLI commands is listed below:

Find the account path on the storage destination, ie /path/to/backup/{USER}_{UUID}/snap.1

[root@server {USER}_617969f43c597a40442a3391]# ll
drwx------. 12 root root   4096 Dec 24 15:28 snap.1
drwx------. 12 root root   4096 Dec 24 15:00 snap.2

Copy only the contents of the snap.x folder to a new folder called backup/ in that same directory using cp -av snap.1/* ./backup. The new folder MUST be named backup/ in order for the restore to function properly.

[root@server snap.1]# ll
drwx------  2 root root   28 Nov 20 20:00 certificate
drwx------ 38 root root 4096 Nov 20 20:00 config
drwx------  2 root root    6 Nov 20 20:00 database
drwx------  2 root root    6 Nov 20 20:00 database_user
drwx------  2 root root   29 Nov 20 20:00 domain
drwx------  2 root root    6 Nov 20 20:00 ftp
drwx--x--x 13 root root 4096 Nov 17 19:29 homedir
drwx------  5 root root   53 Nov 20 20:00 jetbackup.configs
-rw-r--r--  1 root root 4281 Nov 20 20:00 jetbackup.index

# Output will be similar to the below:
‘snap.1/’ -> ‘./backup’
<snipped>
‘snap.1/config/{USER}123.tar.gz’ -> ‘./backup/config/{USER}.tar.gz’

Compress the entire ./backup directory you just created with tar -czvf jetbackup5-{USER}.tar.gz /path/to/store/archive .
Using your preferred method, transfer the backup to your other server that has JetBackup 5 installed.
Then, run jetbackup5 --restorepkg jetbackup5-{USER}.tar.gz -v to restore the backup with verbose output. The restore should be completed successfully on the new server.

# Output will be similar to the below:
[24/Dec/2021 15:48:31 +0000] [PID 2804] JetBackup Version: 5.2.5 Panel Version: cPanel 5.2.5 (EDGE)
[24/Dec/2021 15:48:31 +0000] [PID 2804] Starting restorepkg script
[24/Dec/2021 15:48:31 +0000] [PID 2804] Decompressing backup
[24/Dec/2021 15:48:31 +0000] [PID 2804] [DEBUG] Tar Command: tar -x -z  -f jetbackup-{USER}.tar.gz -C /usr/local/jetapps/usr/jetbackup5/workspace/restorepkg/16403609112vUcYw2e1
[24/Dec/2021 15:48:31 +0000] [PID 2804] Parsing index file
<snipped>
[24/Dec/2021 15:48:42 +0000] [PID 2804] Executing panel post restore
[24/Dec/2021 15:48:58 +0000] [PID 2804] Restore completed
Restore completed

Some useful links on this topic:
Single Account Restore & Download
DisasterRecovery

How to Restore an Orphan Account without the Panel Config Backup Item

Hosting Panel

Create an account with the same username as the Orphan Account you wish to restore.

JetBackup

Reassign the UUID of the new account to be able to access the Orphan Account backups.
Select which backup items from the backup to restore.

Can I delete backups directly from JetBackup?

The recommended options to delete backups are:

Set up the appropriate retentions and filters on your Backup Job(s) associated with the backups you prefer to delete as well as adjust your Manual/Orphan Backup TTL settings and let JetBackup execute its automatic cleanup.
Utlize the JetBackup API to delete backups specified by a set time range, backup job, or destination. Please note that some of the parameters for the deleteAccountSnapshots API are only available starting from a specified version.

Additionally, it is possible, though NOT RECOMMENDED, to manually delete backups directly at your destination. The backup job and account backup directories can be identified by their naming convention. Backup job directories include the backup type and structure followed by the backup job ID. Account backup directories include the account name followed by the account ID.

Once backups have been deleted manually the destination must be reindexed before JetBackup will reflect the change made at the destination. This can be done in 2 ways:

Reindexing the Destination via the JetBackup5 GUI
Execute the following command on your server terminal:

   jetbackup5api -F reindexDestination -D '_id={DESTINATION_ID}

{DESTINATION_ID} should be replaced with the ID of the destination being reindexed.

NOTE: For destinations that utilize the Object Storage format and JetBackup’s Propietary backup structure (All destinations excluding Local[Legacy]/SSH ), it is not possible to delete a single snapshot. Instead when manually removing the backups from the storage destination, all backups for an account must be deleted on the Destination/Bucket. More info on the differences between Object Storage and traditional file structures can be found HERE.

What happens to existing retained backups if I change the backup structure?

When you switch the backup structure on the backup job (e.g., from Compressed to Incremental), JetBackup will create a new folder to store the Incremental backups.

Directory naming:

Compressed backups use the format jetbackup_x_4_...
Incremental backups use the format jetbackup_x_1_...

Old backups remain in their original folders, but no new backups will be added there. To avoid potential issues with the old backup job ID, it’s recommended to create a new backup job for the new structure.

How to add External MongoDB Configuration

In order to add you own external MongoDB Configuration please edit the file located at /usr/local/jetapps/etc/jetbackup/config.inc and add the following fields:

define('MONGODB_PORT', '1234');
define('MONGODB_HOST', '1.1.1.1');
define('MONGODB_USER', 'user');
define('MONGODB_PASS', 'pass');
define('MONGODB_DATABASE', 'db');

Once the file has been saved, restart the mongod service using the following command:

/usr/bin/systemctl restart jetmongod

How does JetBackup Prioritize which tasks to run first?

There are 2 underlying priority systems at work in JetBackup 5, both of which works so that the lower the value, the higher its priority on the queue. The systems are as follows:

A. Account Type Restore Priority - For restore tasks at the backend, JetBackup 5 prioritizes account types and assigns an associated (hard-coded) priority value as such:

Admin Accounts: 1000
Reseller Accounts: 10000
User Accounts: 100000

This ensures that when there are multiple accounts queued for restore, the parent accounts (admin > reseller > user) are restored first before their corresponding child accounts. Please note that this system only affects the restore process.

B. Queue Priority Groups - This allows you to specify and group accounts by priority at the admin level, allowing you to finetune how JetBackup prioritizes tasks for each account. This can be reached by navigating to Settings > Performance Tab > Queue > Manage Queue Priority Groups Button.

When adding/modifying a queue priority group, you have the option to set priorities by the following tasks:

backup priority
restore priority
download priority

You also have the option to associate an Account Tag for a priority group.

Now with regards to assigning priorities to accounts, you can navigate to the Accounts page, select the desired account then click Manage Account. Once on the modify account page, you can either set the Account Queue Priority Group Override setting or assign an Account Tag with the associated queue priority group.

To set an example, let's say we have the following configured in JetBackup 5:

Queue Priority Groups with corresponding priority values

High - 10
Normal - 50
Low - 99

Accounts with assigned Queue Priority Groups

admin_acct1 - High
rslr_acct1 - Normal
rslr_acct2 - Low
usr_acct1 - Normal
usr_acct2 - Low

Here will be the priority values for each account on the following tasks:

Account	Restore	Backup & Download
admin_acct1	1010 (1st)	10 (1st)
rslr_acct1	10050 (2nd)	50 (2nd/3rd)
rslr_acct2	10099 (3rd)	99 (4th/5th)
usr_acct1	100050 (4th)	50 (2nd/3rd)
usr_acct2	100099 (5th)	99 (4th/5th)

Troubleshooting

The JetBackup 5 Services

One major change from JetBackup 4 to JetBackup 5 is the introduction of JetBackup 5 Daemons. All JetBackup 5 processes (backups/restores/downloads/etc) are handled via the following services:

jetbackup5d
- The jetbackup5d service is our main service which handles all queue processing, automated tasks, and display. Check its status using the following command:

/usr/bin/systemctl status jetbackup5d

jetmongod
- The jetmongod service is JetBackup's MongoDB service. This stores all information regarding the JetBackup Configuration. Check its status using the following command:

/usr/bin/systemctl status jetmongod

jetlighttpd
- The jetlighttpd service is only available on JetBackup 5 for Linux servers. This service generates the JetBackup 5 UI for Linux Systems that do not have a control panel. Check its status using the following command:

/usr/bin/systemctl status jetlighttpd

If you ever notice any issues/errors with these services it may be a good idea to restart the services. Please note that restarting either of these services will abort any Processing Queue Items. Restart the services using the following command:

/usr/bin/systemctl restart {jetbackup5d/jetmongod/jetlighttpd}

JetBackup 5 Supplemental Log Locations

JetBackup 5 stores supplemental logs on the server for many different processes. The JetBackup 5 Log directory can be located at /usr/local/jetapps/var/log/jetbackup5. From here, the log file structure is as follows:

/usr/local/jetapps/var/log/jetbackup5/
├── jetbackupapi.log
├── jetbackupd.log
└─── queue
    ├── #_{ID}
    │   └── {ITEMID}.log
    ├── #_{ID}.items
    └── #_{ID}.log

jetbackupapi.log
- The jetbackupapi.log contains the list of all jetbackup5api calls that were made via the terminal or GUI.
jetbackupd.log
- The jetbackupd.log is the log that contains information regarding the jetbackup5d service. Any errors on the service will appear here.
queue
- The queue log directory contains the logs for all Queue Items. The # indicates the Queue Type and the {ID} is the Log Item ID.

Characters to Avoid when naming Files and Folders

While JetBackup supports almost any characters for filenames (UTF-8), there are special characters/symbols that are generally best avoided as there are specific limitations across various filesystems and storage destinations which can cause unintended issues with your backups.

This list is not exhaustive and is meant to help determine and avoid errors regarding filenames and your backups.


# pound	% percent	& ampersand	{ left curly bracket
} right curly bracket	\ back slash	< left angle bracket	> right angle bracket
* asterisk	? question mark	/ forward slash	blank spaces
$ dollar sign	! exclamation point	' single quotes	" double quotes
: colon	@ at sign	+ plus sign	` backtick
\| pipe	= equal sign

File Permissions to Avoid

Some backup destinations may have issues with certain file permissions. e.g. Sticky Bits - in some cases, we have received reports of files with the sticky bit permission causing the following error: Error: rsync: [generator] failed to set permissions ... Inappropriate file type or format . In such cases, our recommendation is to set an appropriate permission for the problematic files.
NOTE: S3 Compatible Destinations are able to backup and preserve permissions and does not have any limitations with file permissions.*

A couple of examples of file permissions to avoid below
-rw---x--t
-rwsr-Sr-T

How To Secure Backup Storage

Prior to adding a destination to JetBackup, we advise securing the backup directory, so that only the allowed users can access that folder.

In order to do that, please connect to the destination via console/GUI, and make the directory in which you want to store your backups. For example:

mkdir [-p] /mnt/backup_vol/jetbackup

Then we advise securing that destination so only one user can access it's content (except root)

useradd <jetbackup>
chown jetbackup:jetbackup /mnt/backup_vol/jetbackup
chmod 700 /mnt/backup_vol/jetbackup

Right now, only users root and jetbackup can access this directory.

Please search online, how to secure a backup folder for your particular file system (EXT, NTFS, FAT, etc..) on your system (Linux, macOS, BSD, etc..)

For more information, and a good start point please visit File System Permissions

Some useful links on this topic:
Linux Users and Groups

Now, when adding that destination in JetBackup GUI, the specified Backup Directory should be the directory you have just created and secured: ie /mnt/backup_vol/jetbackup

Can I use NFS for backup storage?

Yes, you may use NFS v3 or v4.1 mounted on a directory in your server and configure it as a Local destination.

Please note that custom NFS/Mount configurations can cause issues with JetBackup. Due to the many custom NFS/mount configurations available, we only provide support for NFS v3 or v4.1 mounted with default options.

NOTE: JetBackup utilizes rsync when backing up to an NFS destination. Ensure your version of NFS has full support for rsync.

I terminated an account and the backup has been deleted. How can I restore it?

Jetbackup will store the backups for a deleted account as an Orphan under “Accounts -> View Orphan Accounts”. These backups by default will be stored for 180 days unless the setting is changed under “Settings -> General -> Delete Orphan Backups”.

There is no valid destination assigned to this backup job/Local and Remote verification id doesn't match

If you receive the following error when running a backup job:

Backup job "BackupJob_NAME" (#63938921012871b09d045862) has been aborted due to the following error: There is no valid destination assigned to this backup job

and the logs display:

[ERROR] Destination "Local": Local and Remote verification id doesn't match. Looks like there is a conflict between local and remote data. Please reindex this destination then try to run this backup job again

To resolve this, reindex the affected destination.

Can't Connect to SSH Destination

If you are able to login to the destination server via SSH and recieve this message

Could not chdir to home directory /PATH/TO/HOME/DIRECTORY: No such file or directory

then check if the SSH user has a valid home directory. The SSH user MUST have a home directory so that JetBackup can connect to the SSH destination.

Clone Jobs are not updating account packages.

cPanel

Why can't I restore a suspended account in cPanel/WHM?

You may encounter the following errors when restoring an account in JetBackup:

[ERROR] Error while trying to get data from uapi. Error: Failed to parse adminbin request: Account is suspended at /usr/local/cpanel/Cpanel/AdminBin/Server.pm line 101.

Error while trying to get data from uapi. Error: Could not remove entries belonging to “email@example.com” from the “testaccount” Horde database., Failed to parse adminbin request: Account is suspended at /usr/local/cpanel/Cpanel/AdminBin/Server.pm line 101.

cPanel/WHM restricts many API commands for an account when the account is suspended, including those used by JetBackup for restore. These errors indicate that a restore is failing because the account is currently suspended in cPanel/WHM.

To properly restore the account, please ensure the account is unsuspended in cPanel/WHM prior to queueing the restore in JetBackup. You can manage Suspended accounts in WHM via the "WHM -> Account Information -> List Suspended Accounts" interface. From this interface, you can also unsuspend an account.

List Suspended Accounts Documentation (cPanel/WHM)

How to restore accounts with unregistered domains?

WHM by default sets the Allow unregistered domains as disabled. This can cause the restore of accounts that have unregistered or expired domains to fail. This can be seen in the Restore Log as the following message: Please make sure that the domain is registered with a valid domain registrar.

In order restore the account, you can temporarily enable this setting by navigating to WHM -> Domains -> Allow unregistered domains and changing the value to on. Requeue the restore and once complete you may disable this setting again.

How to Lock Suspended Account's Backups

The following Bash script, based on the blog post JetBackup: Better Safe Than Sorry, allows you to automatically lock backups for a set number of days when an account gets suspended and subsequently unlocks when it gets unsuspended. When the script is triggered (via cPanel hooks), it subsequently locks LOCK_BACKUPS number of backups for a LOCK_PERIOD number of days.

Here are the steps to create the Bash script and register to the cPanel/WHM Hooks System:

Create an executable bash file

touch /root/lock_unlock_acct.sh
chmod +x /root/lock_unlock_acct.sh

Copy the following script to the bash file you created on Step 1.

#!/bin/bash
STAGE=$1
LOCK_PERIOD=360
LOCK_BACKUPS=1
LOCK_REASON="locked-by-hook"

ACCT=$( cat /dev/stdin  | grep -oE '"args":{[^}]*"user":"[^"]+"' | sed "s#^.*\"user\":\"\([^\"]\+\)\"#\1#g" )
#ACCT=$( cat /dev/stdin )

HOOK_LOG="/usr/local/jetapps/var/log/jetbackup5/jetbackupd.log"

if [ $STAGE = "suspend" ]; then


        ACCOUNT_ID=$( /usr/bin/jetbackup5api -F listAccounts -D "find[username]=$ACCT&find[active]=1" | grep -E '^\s*_id:' | awk '{print $2}' )

        #GET LATEST LOCK_BACKUPS NUMBER OF SNAP IDs
        sIFS=$IFS
        IFS=$'\n'
        snaps=($( /usr/bin/jetbackup5api -F listBackupForTypeName -D "name=$ACCT&account_id=$ACCOUNT_ID&contains=511&type=1&sort[created]=-1" | grep -E "^\s*parent_id:" | awk '{print $2}' ))
        snapsitems=($( /usr/bin/jetbackup5api -F listBackupForTypeName -D "name=$ACCT&account_id=$ACCOUNT_ID&contains=511&type=1&sort[created]=-1" | grep -E "^\s{6}_id:" | awk '{print $2}' ))
        IFS=$sIFS

                TOTAL_SNAPS=${#snaps[@]}
                [[ $TOTAL_SNAPS -lt $LOCK_BACKUPS ]] && LOCK_BACKUPS=$TOTAL_SNAPS

        for (( i=0; i<$LOCK_BACKUPS; i++ )); do
                #LOCK SNAP BY ID
                /usr/bin/jetbackup5api -F manageBackupLock -O json -D "_id=${snaps[$i]}&locked=1&lock_ttl=$LOCK_PERIOD"
                /usr/bin/jetbackup5api -F manageBackupNotes -O json -D "_id=${snapsitems[$i]}&notes=$LOCK_REASON"
        done
fi

if [ $STAGE = "unsuspend" ]; then
        ACCOUNT_ID=$( /usr/bin/jetbackup5api -F listAccounts -D "find[username]=$ACCT&find[active]=1" | grep -E '^\s*_id:' | awk '{print $2}' )
        #GET LOCKED SNAPS BY THE LOCK REASON AND THE ACCOUNT NAME
        sIFS=$IFS
        IFS=$'\n'
        snaps=($( /usr/bin/jetbackup5api -F listBackupForTypeName -D "name=$ACCT&account_id=$ACCOUNT_ID&contains=511&type=1&sort[created]=-1" | grep -E "^\s*parent_id:" | awk '{print $2}' ))
        snapsitems=($( /usr/bin/jetbackup5api -F listBackupForTypeName -D "name=$ACCT&account_id=$ACCOUNT_ID&contains=511&type=1&sort[created]=-1" | grep -E "^\s{6}_id:" | awk '{print $2}' ))
        IFS=$sIFS

        for (( i=0; i<$LOCK_BACKUPS; i++ )); do
                #UNLOCK SNAP BY ID
                /usr/bin/jetbackup5api -F manageBackupNotes -O json -D "_id=${snapsitems[$i]}&notes="
                /usr/bin/jetbackup5api -F manageBackupLock -O json -D "_id=${snaps[$i]}&locked=0&lock_ttl="

        done
fi

/usr/local/cpanel/bin/manage_hooks add script "/root/lock_unlock_acct.sh suspend" --manual 1 --category Whostmgr --event Accounts::suspendacct --stage post
/usr/local/cpanel/bin/manage_hooks add script "/root/lock_unlock_acct.sh unsuspend" --manual 1 --category Whostmgr --event Accounts::unsuspendacct --stage post

Linux

How to Add/Change SSL Certificates on JetBackup 5 for Linux

SSL certificates adds another layer of security when accessing your JetBackup 5 for Linux Panel by encrypting sensitive information such as your login credentials as they are sent between your server and browser.

JetBackup generates its own SSL certificate automatically upon installation.

To add your own SSL certificate, edit the JetBackup configuration file located here:

/usr/local/jetapps/etc/jetlighttpd/conf.d/jetbackup5.conf

Change the following line on the config file:

ssl.pemfile = "/usr/local/jetapps/etc/ssl/private/jetbackup5.pem"

And specify the path to your SSL certificate:

ssl.pemfile = "{SSL_CERTIFICATE_PATH}"

For SSL Certificates provided by Let's Encrypt, it is possible to assign more lines in the config file as follows:

ssl.privkey = "/PATH/TO/####.domain.net/privkey.pem"
ssl.pemfile = "/PATH/TO/####.domain.net/cert.pem"
ssl.ca-file = "/PATH/TO/####.domain.net/chain.pem"

Save the config file then restart the jetlighttpd service:

systemctl restart jetlighttpd

If using a single .pem file, the file must contain both the Private Key and Certificate with the following format:

-----BEGIN PRIVATE KEY-----
...
-----END PRIVATE KEY-----
-----BEGIN CERTIFICATE-----
...
-----END CERTIFICATE-----

How to Add/Change the Panel Port on JetBackup 5 for Linux

In addition to SSL configuration, the same file controls the port JetBackup 5 listens on:

/usr/local/jetapps/etc/jetlighttpd/conf.d/jetbackup5.conf

To change the port, add (or edit) the following variable in the config file:

var.jetbackup_port = "1234"

Replace 1234 with your desired port number.

Save the config file then restart the jetlighttpd service:

systemctl restart jetlighttpd

Disk Usage/Inode Usage N/A on JetBackup 5 for Linux

Since JetBackup 5 for Linux does not have an associated panel to gather account information, JetBackup 5 must calculate these details manually. In order to do this, you must have the repquota tool installed on your linux server. For more information on how to install the repquoata tool, please visit their documentation: repquota.

Once repquota is installed and configured run the following command to verify:

repquota -a

You should get a list of all the linux users on your system along with their configured Disk Usage/Inode Usage Limits. After verifying the command works properly, restart the jetbackup5d service to resync the accounts.

/usr/bin/systemctl restart jetbackup5d

PostgreSQL - Failed to connect when assigning Databases

Some postgres installations may have authentication issues as it defaults to scram-sha-256 authentication type. You can verify if there's an authentication issue with your PostgreSQL installation when you try to assign a database with the postgres engine on JetBackup's Manage Database Plugin.

SCRAM authentication for PostgreSQL requires the libpq v10 PHP package or above installed. As a workaround, you may switch your authentication type to md5. On a PostgreSQL v13 installation for example, you need to set the following configuration files then restart the postgres service:

/var/lib/pgsql/13/data/postgresql.conf:

password_encryption = md5             # md5 or scram-sha-256

/var/lib/pgsql/13/data/pg_hba.conf:

host    all             all             127.0.0.1/32            md5
host    all             all             ::1/128                 md5
host    replication     all             127.0.0.1/32            md5
host    replication     all             ::1/128                 md5

DirectAdmin

Custom Nameserver/Hostname and Port

JetBackup 5 uses the following DirectAdmin Configurations by default when installed:

hostname (Default hostname of the server)
port (Default port for DirectAdmin 2222)

With DirectAdmin Servers it is possible to customize these two configurations. In order to load JetBackup 5 on DirectAdmin with a custom Hostname/Port please add the following lines to the JetBackup 5 DirectAdmin Configuration File located at /usr/local/jetapps/etc/jetbackup5/.da.conf

hostname=HOST/IP
port=PORT

The provided username length is too long

When restoring an account in DirectAdmin, there are instances when the account's username is longer that the default max username length set in DirectAdmin which prevents the backup from getting restored, receiving The provided username length is too long error.

To resolve this issue, please make sure that you set the appropriate size for the max_username_length parameter under the /usr/local/directadmin/conf/directadmin.conf file. (Username length setting)

Misconfiguration Could Affect Restores

DirectAdmin allows the “Admin” user to perform any actions on the server and associated users/resellers. Resellers that own user accounts, however, cannot perform the same actions to override package configurations to their users. The DirectAdmin API will ignore any setting passed that the resellers weren’t permitted to enable for their users. A common issue is when SSL/CGI is disabled on a reseller’s package, the “Admin” user can modify the setting and enable SSL/CGI for that user.

This will uncover the misconfiguration where the User had features enabled that the Resellers Settings (which apply to all their owned accounts) did not permit. It’s crucial to consider the reseller limits when modifying a user Admin, as overlooking this could lead to extensive manual work to resolve issues in the event of a disaster.

Plesk

An error occurred during domain update

You may encounter the following errors when restoring an account in JetBackup:

[ERROR] Failed making utility Call to Plesk. Error: [DATE] 53340:65780abbe1688 ERR [util_exec] proc_close() failed ['/usr/local /psa/admin/bin/usermng' '--mod-user' '--old-user=example.example._naza1c1jhjo' '--new-user=example.example._naza1c1jhjo'] with exit code [255]

An error occurred during domain update: An error occurred during changing of hosting settings: System user update is failed: Unable to execute usermng: usermng: PAM password change failed: 20, Authentication token manipulation error

To resolve this issue, please check the /etc/pam.d/plesk_usrmng_encrypted file and comment out the line password required pam_deny.so. The resulting file contents should be:

#password required pam_plesk.so try_first_pass
#password required pam_deny.so
password required pam_plesk.so try_first_pass
##############################################
OR
##############################################
password required pam_plesk.so try_first_pass

NOTE: The password required pam_deny.so line does not exist on a clean installation of Plesk.

Why are forwarded/redirected domains not being backed up or listed?

Domains with Hosting Type "Forwarding" (redirected to another domain) are not listed in JetBackup as an account. Instead, they are included in the backup of the customer account (subscriber) that they are assigned to.

Please note that the forwarded domain will NOT be backed up with the domain that they are redirected to.

Jb5: Additional Resources

Mon, 01 Jan 0001 00:00:00 +0000

– Admin Panel Documentation

Jb5: General Information

Installation Guide

System Requirements

Install the JetApps Repository

Install JetBackup 5

JetBackup Updates

Remote MongoDB (Optional)

Licensing

Key-Based Licensing

Uninstall

Jb5: Getting Started

Introduction

How to Access JetBackup 5

cPanel/WHM

DirectAdmin

Interworx

Plesk

Linux

Tenancy/Access Levels

Initial Setup

Disaster Recovery Wizard

New Installation

Recover from Disaster

Exit DR

Remote MongoDB (Optional)

Feature Showcase

Dashboard

JetBackup Settings and Plugins

How efficient would you like your backups?

Jb5: Dashboard

Navigation Sidebar

Statistics

New Alerts

Total Accounts

Total Jobs

Total Backups

Total Accounts Usage

Jobs Running

General Information

Recent Alerts

Restore Queue Summary

Latest Queue

Destinations List

Backup Jobs List

Clone Jobs List

Jb5: Accounts

Account Settings

Manage Account

Email Address

Max On Demand Backups

Tags

Reset Encryption Key

Account Queue Priority Group Override

Account Backup Jobs Excludes

Create Backup On Demand

View Backups

Full Backup

Show Advanced Settings

Delete

Restore

Download

Lock Backups

Unlock Backups

View Downloads

Assignable Accounts

View Orphan Accounts

Manage Account Tags

Create New Tag

Change Tags

Mass Assign Accounts to Tag

Jb5: Destinations

Overview

Warning

Destination Types

Desination Storage Formats

Destination For

Backup Types

Backup Structures

Read Only