NOTICE: JetBackup 5 is now available in the Stable Tier. For more information, please visit our Jetbackup 5 Documentation.

SFTP

The SSH File Transfer Protocol (SFTP), also known as the Secure File Transfer Protocol, enables secure file transfer capabilities between networked hosts.
SFTP additionally provides remote file system management functionality, allowing applications to resume interrupted file transfers, list the contents of remote directories, and delete remote files.

*Due to technical limitations, incremental backups on SFTP destinations will first generate a total number of retentions worth of full backups, taking one backup job cycle to complete. JetBackup will then cycle through each full backup on subsequent backup job runs, pushing incremental changes on each corresponding full backup.

For a 7-day backup retention, JetBackup will first generate 7 different full backups for the first 7 days and then start pushing incremental changes on subsequent backup job runs based on the oldest backup generated/cycled.

Here are additional considerations with this limitation in mind:

  • Incremental backups will use higher disk space and save on server I/O and backup time once a full cycle of backups are generated.
  • Compressed backups will save on disk space.

An example configuration page for the destination:

create SFTP 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.
The path is relative to the remote user's home dir.
/home/USERNAME will be your starting point.
Write your path to where you want the backup to be stored.

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.

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.


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.


Maximum connection retries

The maximum number of failed connections attempts (Insert 0 for unlimited).


Maximum concurrent connections

The maximum number of connections at the same time (Insert 0 for unlimited).