WARNING: JetBackup 4 is set to reach its End-of-Life (EOL) on July 1st, 2024. For More Information, please visit: JetBackup 4 EOL Announcement.
NOTICE: JetBackup 5 is now available in the Stable Tier. For more information, please visit our Jetbackup 5 Documentation.

SSH

Remote SSH (using rsync) our preferred and recommended destination type. Since it supports all features, you can make the most of it when backing up.

Technical Limitations:

Since we are using some extra Linux based commands besides rsync, this destination must have a "Real" operation system at the other end (Redhat, Centos, Debian etc). So a "NAS Backup box" with rsync enabled will not be supported.

Additionally, FUSE File Systems are known to have rsync errors that can cause unstable backups to those partitions. Therefore, JetBackup cannot support SSH Destinations to a FUSE File System. S3FS, Google Drive FUSE, and SSHFS are examples of these FUSE File Systems.

This page shows how to add a SSH backup destination on JetBackup 4.

We first create an unprivileged user (using root for the backups is not recommended) on the backup destination server, then added the server & login details to JetBackup in the "Add destination" screen.

NOTE: SSH Keys are created automatically by JetBackup and transferred to the destination server after creation.


An example configuration page for the destination:

create SSH destination


Destination Name

A generic name for your internal ease of use, so it will be easier to recognize the backup destination roll, in case you have more than one. Max length is 40 characters.


Choose Backup Engine

JetBackup will need to index and read files from this destination. Since each backup engine has it's own file structure, JetBackup will need to know what to look for in the destination when indexing the backups.

Selecting cPanel as the Backup Engine allows JetBackup to index cPanel generated backups on the destination which allows you and your clients access and restore from these backups through the JetBackup interface. For full incremental backups generated with the cPanel Engine, JetBackup intelligently indexes these backups to its appropriate parts(Databases, Emails etc.) allowing you and your clients to restore full and individual parts of the backup.

With this option selected, you can schedule when to reindex the destination for backups. It is recommended to schedule it after the cPanel backup is done to ensure the most accurate data.

Please note that this does not let JetBackup generate backups using the cPanel Engine.


Backup Directory

This will be our starting point when accessing this destination.
There are two ways to get to each directory: Relative, Absolute
Let say your home dir is '/home'
Relative path ./ will point to the absolute path /home/USERNAME
- on the same principle FOLDER will be the remote user's home dir subdirectory /home/USERNAME/FOLDER.
Make sure that you always have the right permission to the path you're using.

Please make sure that your destination path is secure and has the appropriate privileges.
For more information click on How To Secure Local Backup Storage.

Free Disk Space Limit

This option checks if the destination's disk space has reached the specified limit before it executes the backup. When enabled, JetBackup will not perform the backup when the used disk space is over the specified limit.


Remote Host

A simple hostname or IP address to access the remote backup server.


Port

Your remote port. Default port is 22.


Remote Username

The remote user to login with. It is recommended to create a dedicated user for backups and not use root user.


Remote Password

Password for the provided ssh user.
JetBackup will create all necessary keys for remote login on the remote server.


Private key

The path to the private key.
The password is stronger, so if there is a password, the key will not be in use.
Since we are using rsync for backups, we will need to set up access keys between the servers, so we can log in to the remote server without prompting for a password.
If empty, it will be automatically created by JetBackup.
To find a guide for that, search for ssh without password.


Connection Timeout

Timeout for the connection. The default value is 30 (The Connection Time Out in seconds), you can increase this if the connection to the remote server is poor and you might face longer timeout issues.


Rsync Bandwidth Limit

Limit rsync bandwidth.


Rsync Prefer IPv4/IPv6

Choose your preferred IP version.