– Destinations

Jb5: Local

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

For video tutorials, please click here:

Local(Legacy) & LocalV2

There are two local destination types that each use different backup formats.

Local(Legacy): This is a Rsync-Based destination type that stores your backups in a human-readable format and allows you to access the files directly in the destination.
LocalV2: This destination uses our Jetindex engine that is available in v5.3+. It utilizes the object storage format and stores the backups in JetBackup’s Propietary Backup structure which increases backup effiency and improves incremental functionality.

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

NOTE: When authenticating, JetBackup 5 will attempt to run a sequence of standard Linux Commands on the destination. Please review the common Linux commands and ensure the destination/user fully support these commands.

Creating the Destination

This guide shows how to add a Local backup destination to JetBackup.

Designate the Backup Directory for JetBackup to generate backups in and Save.

An example Local configuration page for the destination:

Destination Name

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

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.

Owner

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

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. Select from the preset limits or input a custom disk space usage limit.

Maximum Concurrent Threads - (only available for localV2)

This option allows you to set the number of worker threads that can be used by the destination for upload/download/get/delete requests. This will be shared evenly across the number of Concurrent Tasks set for Backup or Restore/Download. As the tasks complete, the available threads will be allocated to the remaining active tasks up to the set limit. You can lower this value if you receive rate-limit errors from the remote destination.

Backup Directory

This will be our starting point when accessing this destination. Always use the absolute path and make sure to start with “/”.

For example: /PATH/TO/FOLDER.

Note: The absolute path must be unique and can not be used by two different Destination Configurations. If a backup directory is already owned by another JetBackup Destination, you may create a “Read Only” Destination to that path.

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

If you are setting up a local Destination pointing to a directory mounted with NFS, only NFSv3 and NFSv4.1 are supported. 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.

Rsync Bandwidth Limit

This option allows you to specify the maximum data transfer rate.

Jb5: SSH

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

For video tutorials, please click here:

Since we are using some additional Linux based commands besides rsync, this destination must have a “Real” operation system at the other end (Redhat, Centos, Debian etc). When authenticating, JetBackup 5 will attempt to run a sequence of standard Linux Commands on the destination. Please review the common Linux commands and ensure the destination/user fully support these commands. For Example: A “NAS Backup box” with rsync enabled will not be supported.

Please Note: Rsync.net Cloud Storage and Hetzner Storage Boxes are supported SSH destinations.

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.

Creating the Destination

This guide shows how to add an SSH backup destination to JetBackup.

First make sure that you have the appropriate SSH destination plugin installed and enabled.

Then create an unprivileged user (using root for the backups is not recommended) on the backup destination server, and add the server & login credentials to JetBackup in the “Add destination” screen.

*SSH Keys are automatically generated by JetBackup and transferred to the destination server.

An example SSH configuration page for the destination:

Destination Name

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

Read Only

Owner

Free Disk Space Limit

Backup Directory

This will be our starting point when accessing this destination. There are two ways to get to each directory: Relative and Absolute

Relative path “./” will point to the Absolute path of the SSH/Linux user home directory “/home/USERNAME” Make sure that you always have the right permission to the path you’re using.

Note: The absolute path must be unique and can not be used by two different Destination Configurations. If a backup directory is already owned by another JetBackup Destination, you may create a “Read Only” Destination to that path.

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

For users using rsync.net or Hetzner Storage Boxes, the Backup Directory path must be a Relative Path and begin with ./ Otherwise, you may receive an Access Denied error when trying to save the destination.

For Clone Destinations, a Backup Directory is NOT required.

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. The user is REQUIRED to have a home directory.

For Clone Destinations, ROOT credentials of the destination or an authorized ROOT private key are required.

Authentication Type

Private key

The path to the private key

Since we are using rsync for backups, we will need to set up access keys between the servers so that we can log in to the remote server without prompting for a password. If empty, it will automatically be created by JetBackup.

To find a guide for that, please search for ssh without password.

Please visit the following links for specific instructions on how to generate Private keys for Rsync.net or Hetzner Storage Box.

Remote Password

Password for the provided ssh user.

JetBackup will create all necessary keys for remote login on the destination server.

Connection Timeout

Timeout for the connection. The default value is 60 (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

This option allows you to specify the maximum data transfer rate.

Rsync Prefer IPv4/IPv6

Choose your preferred IP version.

Jb5: JetBackup Storage

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

For video tutorials, please click here:

Creating the Destination

This guide shows how to add a JetBackup Storage backup destination to JetBackup.

JetBackup Storage has two distinct account types, each using a different destination setup:

Integrated Storage accounts are simplified, bucket-only accounts created directly through JetBackup using the “Quick Access” signup. They do not expose a standard S3 console for managing buckets/bucket settings, keys, etc. — instead, access is granted via a Quick Access Code generated through the JetBackup Client Area. Use this destination type if you created your storage account through the Get Quick Access Code button on this page. You do not need to create an Access/Secret Key pair; the Quick Access Code handles authentication automatically.

S3 Storage accounts are full JetBackup Storage accounts with standard S3-compatible API and console access, giving you full control over bucket creation, users, regions, and Access/Secret Key management. Because these accounts expose standard S3 credentials and all S3 features, they must be configured using the S3-Compatible Destination instead of this page. Use the guide Integration with JetBackup 5 to create your Access/Secret Key pair and associated bucket. Do not use the Quick Access Code button when using Self-Managed JB Storage accounts — it will create a separate Integrated S3 account instead.

NOTE: Kindly ensure Bucket settings such as Bucket Versioning, Object Lock/Governance Mode, Object Lifecycle are disabled as these settings are UNSUPPORTED and can be expected to cause issues with your backups.

An example JetBackup Storage configuration page for the destination:

Destination Name

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

Read Only

Owner

Maximum Concurrent Threads

Get Quick Access Code

Use the “Get Quick Access Code” button on the page to use an Integrated JetBackup Storage account. A popup will be displayed prompting you to enter your JetBackup Client Area (billing.jetbackup.com) login credentials or creating a new account. The Access Code will be displayed upon selecting the Region, or a pre-existing bucket. Copy and paste the code in this box to quickly create and authenticate to the destination.

During first-time signup, choose a Region that’s geographically close to your server for the best backup performance as the region cannot be changed on Integrated JB Storage Accounts.

Advanced Options for JetBackup Storage Destinations

Expand these options by clicking “Show advanced settings.”

Backup Directory

This will be our starting point when accessing this destination. Always use the absolute path and make sure to start with “/”.

For example: /PATH/TO/FOLDER.

Only the following characters are allowed for the Backup Directory Path: A-Z a-z 0-9 and /.

Verify SSL

Whether SSL verification is enabled/disabled on the JetBackup Storage destination. [ default: Yes ]

HTTP Retries

Controls how many retries will be attempted if the destination returns an error for an HTTP call (upload / download / delete). [default: 3 retries]

Note: Increasing the number of retries may also increase your backup time accordingly as JetBackup tries to upload for a maximum set number of times until either getting a successful response from JetBackup Storage or reaching the set number of retries.

Large files upload chunk size

Select the multipart upload chunk size for large files. Lower this value if you find large files are failing to upload. [default: 5120 MB]

Keep Alive timeout

The time in seconds, that the host will allow an idle connection to remain open before it is closed. [default: 60 seconds]

Max Keep Alive Requests

The maximum number of requests that can be sent on a single connection before closing it. Choose “Determined by remote vendor” to fetch the maximum keep alive requests automatically. [default: 100]

Low Speed Timeout

Require at least 1 byte in the configured interval otherwise the connection is considered slow and connection is aborted. Increase this for slow or unstable connections. [default: 120 seconds]

Upload Verification

Ensures the uploaded file is successfully stored on the remote destination by reconnecting and verifying its presence using getObject.

WARNING: Enabling this feature may result in significant performance downgrade due to additional verification steps on each uploaded file.

Additional information

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 JetBackup Storage buckets. JetBackup Storage objects are comprised of three main parts; the content of the object (data contained in the object including 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. JetBackup Storage has distinct advantages such as allowing you to avoid network bottlenecks as well as a high degree of scalability and data security.

JetBackup Storage vs Traditional File System Comparison

JetBackup Storage uses object storage where data is stored as objects with unique identifiers, compared to standard file storage where your data are stored in files and directories and are human-readable.

As an example, this is how a snap is structured on JetBackup 5’s backup format, organized per backup item plus additional metadata for JetBackup’s use:

.
├── snap.1
│   ├── certificate
│   ├── config
│   ├── cronjob
│   ├── database
│   ├── database_user
│   ├── domain
│   ├── email
│   ├── ftp
│   ├── homedir
│   ├── jetbackup.configs
│   └── jetbackup.index
├── snap.2
 ....

Once this data is transferred to a JetBackup Storage Destination, this is then converted and stored as objects and will look something similar to the following:

.
├── export
│   ├── snap.1
│   ├── snap.2
│    ....
├── files
│   ├── 6258c0a30008839f00001146
│   ├── 6258c0a30009115600001148
│   ├── 6258c0a3000914d000001149
│   ├── 6258c0a30009180b0000114b
│   ├── 6258c0a300091a820000114c
│   ├── 6258c0a300091f3400001151
│    ....
├── snap.1
│   └── jetbackup.index
├── snap.2
│   └── jetbackup.index
....

Under “files”, this is where backup data across all the snaps are actually stored, and each object represents a file in the backup. Additionally, there will also be a corresponding “snap” and “export” data which stores the information required for JetBackup to read this backup.

JetBackup Storage Object Integrity

Please be aware that when utilizing JetBackup Storage destinations, a file hashing mechanism is employed to ensure object integrity during the file upload process. This procedure involves generating a hash of the file, transmitting it to the JetBackup Storage server, uploading the file, and subsequently hashing the file again on the JetBackup Storage server using the same algorithm. JetBackup Storage then compares these two hashes, and if they do not match, the file upload is declined. As this is required for all file uploading to JetBackup Storage, this cannot be disabled at the JetBackup level. With this in mind, we recommend excluding certain files that are regularly written to (logs, temp files, etc.) to mitigate partial backups.

JetBackup Storage Documentation

Additional reading on JetBackup Storage can be found in our JetBackup Storage Documentation.

Jb5: S3 Compatible

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

For video tutorials, please click here:

When using JetBackup with a S3 Compatible destination, it is expected to see download egress as JetBackup pulls in the full and snap.x SQLite databases(backup indexing) from the remote destination during each backup job run. Storing and downloading the remote SQLite database files are required to ensure the integrity of the backups stored on the remote destination.

Creating the Destination

This guide shows how to add an S3 compatible backup destination to JetBackup.

First make sure that you have the appropriate S3 destination plugin installed and enabled.

Create a bucket on the backup destination (for instructions on creating buckets for your corresponding S3 Vendor, please click here).

NOTE: Kindly ensure Bucket settings such Bucket Versioning, Object Lock/Governance Mode, Object Lifecycle are disabled as these settings are UNSUPPORTED and can be expected to cause issues with your backups.

If you do not see your S3 Provider listed as an available Vendor, please note that you may be able to add your S3 Compatible Destination as a Custom Vendor.

Create New Access Key and Secret Key Pair and save them for the credentials on creation page.

An example S3 configuration page for the destination:

Destination Name

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

Read Only

Owner

Maximum Concurrent Threads

Vendor

Choose which S3 compatible vendor you will be using as your S3 destination.

Custom Vendor

A Custom Vendor must be fully S3-Compatible to be used with JetBackup. Choosing to use a custom vendor will require the additional Endpoint field. Please note that JetBackup automatically updates the endpoint with the Region from below. The correct format for the endpoint will use {region} in place of the actual region.

Example Configuration:

When connecting to the destination, JetBackup will automatically take the Region us-east-1 and replace the {region} with the inputted field whenever needed. For custom endpoint configurations, you can also specify {bucket} depending on the endpoint format. This is not required for most S3 destinations. Example Custom Vendors:

MEGA S4 Object Storage *Recommended to use Archived/Compressed structure
Linode Object Storage
Backblaze *Recommended to use Archived/Compressed structure

Backup Directory

This will be our starting point when accessing this destination. Always use the absolute path and make sure to start with “/”.

For example: /PATH/TO/FOLDER.

Only the following characters are allowed for the Backup Directory Path: A-Z a-z 0-9 and /This is in accordance to the Amazon S3 Object key naming guidelines.

Access/Secret Key Pair

Every S3 Destination has a Access/Secret Key Pair you must use in order to create the destination. Please visit the specific documentation on creating these pairs for each S3 Destination.

JetBackup Premium Cloud Storage - Creating Access/Secret Keys
Amazon S3 - Managing Access keys AWS Console
Cloudflare R2 - Creating an Access/Secret Key Pair
- NOTE: Cloudflare account ID required to create destination. This can be copied from the Cloudflare R2 Dashboard under Account details. For more information, Find zone and account IDs
Digital Ocean Object Storage - Creating an Access Key
Google Cloud Storage - Creating an HMAC Key
IBM Cloud Object Storage - Service credentials
- NOTE: Ensure to enable Include HMAC Credential to receive the key pair properly. Oracle Cloud Object Storage - Create a Customer Secret Key
MEGA S4 Object Storage - Create an Access Key
ScaleWay Elements - How to Generate an API Key
Wasabi - Creating a Wasabi API Access Key Set

Bucket

Please visit the specific documentation on creating buckets for each S3 Destination.

JetBackup Premium Cloud Storage - Creating storage buckets
Amazon S3 - How do I create an S3 Bucket
Cloudflare R2 - Creating an R2 Bucket (Follow Step 2 for bucket creation.)
Digital Ocean Object Storage - Create a Space
Google Cloud Storage - Creating storage buckets
IBM Cloud Object Storage - Getting started with IBM Cloud Object Storage
Oracle Cloud Object Storage - Create a Bucket in Oracle Object Storage
- NOTE: After creating a bucket, take note of the Namespace under Bucket Settings for your Destination Configuration on JetBackup.
MEGA S4 Object Storage - Creating a Bucket
ScaleWay Elements - Creating a Bucket through the Scaleway Console
Wasabi - Creating a Bucket

Region

JetBackup will list known regions for the S3 Destination chosen. For a Custom Vendor, the region can be entered manually if required by the vendor. For more information, please see Custom Vendor.

It is best practice to choose the closest region to your server, if available, or consider a vendor with closer regions for best performance.

Verify SSL

Whether SSL verification is enabled/disabled on the s3 compatible destination. [ default: Yes ]

HTTP Retries

Controls how many retries will be attempted if the destination returns an error for an HTTP call (upload / download / delete). [default: 3 retries]

Note: Increasing the number of retries may also increase your backup time accordingly as JetBackup tries to upload for a maximum set number of times until either getting a successful response from the S3 provider or reaching the set number of retries.

Large files upload chunk size

Select the multipart upload chunk size for large files. Lower this value if you find large files are failing to upload. [default: 5120 MB]

Keep Alive timeout

The time in seconds, that the host will allow an idle connection to remain open before it is closed. [default: 60 seconds]

Max Keep Alive Requests

Low Speed Timeout

Require at least 1 byte in the configured interval otherwise the connection is considered slow and connection is aborted. Increase this for slow or unstable connections. [default: 120 seconds]

Upload Verification

Ensures the uploaded file is successfully stored on the remote destination by reconnecting and verifying its presence using getObject.

WARNING: Enabling this feature may result in significant performance downgrade due to additional verification steps on each uploaded file.

Additional information

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.

S3 Object Storage vs Traditional File System Comparison

The S3 protocol uses object storage where data is stored as objects with unique identifiers, compared to standard file storage where your data are stored in files and directories and are human-readable.

As an example, this is how a snap is structured on JetBackup 5’s backup format, organized per backup item plus additional metadata for JetBackup’s use:

.
├── snap.1
│   ├── certificate
│   ├── config
│   ├── cronjob
│   ├── database
│   ├── database_user
│   ├── domain
│   ├── email
│   ├── ftp
│   ├── homedir
│   ├── jetbackup.configs
│   └── jetbackup.index
├── snap.2
 ....

Once this data is transferred to an S3 Compatible Destination, this is then converted and stored as objects and will look something similar to the following:

.
├── export
│   ├── snap.1
│   ├── snap.2
│    ....
├── files
│   ├── 6258c0a30008839f00001146
│   ├── 6258c0a30009115600001148
│   ├── 6258c0a3000914d000001149
│   ├── 6258c0a30009180b0000114b
│   ├── 6258c0a300091a820000114c
│   ├── 6258c0a300091f3400001151
│    ....
├── snap.1
│   └── jetbackup.index
├── snap.2
│   └── jetbackup.index
....

S3 Lifecycle Settings

It is important to verify proper Lifecycle Settings when setting up an S3 destination to prevent excess storage usage. Some providers will keep all verisons of a file stored by default which can unncessarily increase storage utilization and costs.

S3 Minimum Storage Retention Policies

Some providers may apply a charge for stored objects that have been been deleted before a certain number of days. With this in mind, even though JetBackup is removing files during the integrity check and snapshot cleanup processes, the storage usage and costs may not reflect these changes accurately.

Wasabi Minimum Storage Duration Policy

S3 Object Integrity

Please be aware that when utilizing S3 storage destinations, a file hashing mechanism is employed to ensure object integrity during the file upload process. This procedure involves generating a hash of the file, transmitting it to the S3 server, uploading the file, and subsequently hashing the file again on the S3 server using the same algorithm. S3 then compares these two hashes, and if they do not match, the file upload is declined. As this is required for all file uploading to S3 storage, this cannot be disabled at the JetBackup level. With this in mind, we recommend excluding certain files that are regularly written to (logs, temp files, etc.) to mitigate partial backups.

Resources

Additional reading on the S3 storage type can be found here.

Jb5: FTP

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

For video tutorials, please click here:

JetBackup does not support FTP servers hosted on windows as a backup destination.

Creating the Destination

This guide shows how to add an FTP backup destination to JetBackup.

First make sure that you have the appropriate FTP destination plugin installed and enabled.

Then create a new FTP user and password on the backup destination server. Then create the destination and add the credentials in the “Add Destination Screen”.

An example FTP Configuration page for the destination:

Destination Name

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

Read Only

Owner

Maximum Concurrent Threads

Backup Directory

This will be our starting point when accessing this destination. There are two ways to get to each directory: Relative and Absolute Relative path “./” will point to the Absolute path of the SSH/Linux user home directory “/home/USERNAME” Make sure that you always have the right permission to the path you’re using.

Remote Host

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

Port

Your remote port. Default port is 21.

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 FTP user.

Connection Timeout

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

Connection Retries

Number of times JetBackup will attempt to connect to the destination. The default value is 3 Retries. You can increase this value but unsuccessful connections will be made longer.

Secure SSL-FTP Connection

Support for SSL-FTP connections providing greater security through the use of SSL certificates.

Passive Mode

In passive mode, data connections are initiated by the client, rather than by the server. It may be needed if the client is behind firewall.

Additional Info

vsftpd Configuration Requirements

If you are using vsftpd as your FTP server, the following options must be enabled in your /etc/vsftpd.conf file. These options are not enabled by default on installation.

chroot_local_user=YES
allow_writeable_chroot=YES
write_enable=YES

chroot_local_user and allow_writeable_chroot must be enabled to allow JetBackup to create the backup directory on the remote server. Without these, the backup will fail with below error -

Error: Failed creating dir '/backup'. Error: QUOT command failed with 550

write_enable must also be set to allow JetBackup write permissions on the FTP server.

Jb5: SFTP

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

For video tutorials, please click here:

JetBackup does not support SFTP servers hosted on windows as a backup destination.

Creating the Destination

This guide shows how to add an SFTP backup destination to JetBackup.

First make sure that you have the appropriate SFTP destination plugin installed and enabled.

When creating the Destination, you will be prompted to install the SFTP plugin and can click “Install Now” to install and enable the plugin. Be sure that you’ve created a new FTP user on the backup destination server before proceeding.

Next, fill in the Backup Directory with the path you’d like to store your backups, along with the Remote Host, SFTP port, Remote Username, and authentication details. If you’d like to use a SSH Private Key or SSH Private Key with passphrase, please ensure you’ve authorized key on the FTP users authorized_keys file on the destination first.

Next, click “Save” or “Apply” to save the destination.

An example SFTP Configuration page for the destination:

Destination Name

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

Read Only

Owner

Maximum Concurrent Threads

Backup Directory

Remote Host

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

Port

Your remote port. Default port is 21.

Remote Username

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

Authentication Type

Private key

The path to the private key.

SSH keys with or without a passphrase are supported. For optimal security, we recommend creating a SSH key with a passphrase. Please verify that the SSH Public Key is added to the remote user authorized_keys file before creating the destination.

Please review the following guide for instructions on creating a SSH key with password here.

Please visit the following links for specific instructions on how to generate Private keys for Rsync.net or Hetzner Storage Box.

Remote Password

Password for the provided FTP user.

Connection Timeout

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

Connection Retries

Number of times JetBackup will attempt to connect to the destination. The default value is 3 Retries. You can increase this value but unsuccessful connections will be made longer.

Performance/Troubleshooting

The SFTP destination uses the OpenSSH sftp-server file transfer daemon. If you receive Error: Expected NET_SFTP_VERSION when creating the destination, please enable the sftp-server or internal-sftp subsystems in the remote destination’s /etc/ssh/sshd_config in order to add the SFTP destination to JetBackup 5.

Example:

# override default of no subsystems
Subsystem       sftp    /usr/libexec/openssh/sftp-server

The SFTP destination will open up to 10 Connections per Backup Fork by default. The Maximum Concurrent Threads setting will determine the number of Connections per Backup Fork. If you encounter abnormally slow backups or retry errors, you may be reaching session/IO limits on the destination.

If your destination is returning rate limit errors, first try reducing the number of Maximum Concurrent Threads or the number of Concurrent Backup Tasks.

Otherwise, you can modify the “MaxSessions” and “MaxStartups” settings on the destination /etc/ssh/sshd_config to allow a higher volume of sftp-server processes to be opened on the destination and avoid rate limiting. For more information on these settings, please see the sshd_config manual.

Example:

MaxSessions 200
MaxStartups 1024

Jb5: Google Drive

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

For video tutorials, please click here:

Note: We do not recommend using the Integrated Google Drive Project for Incremental backups due to the write limits. To reduce the amount of rate limiting from Google Drive, kindly attempt to backup using a Compressed/Archived backup type, or lowering the “Maximum Concurrent Threads” value for the destination. Kindly refer to Google Drive’s API and Upload limitations HERE for more information.

We suggest using the Custom Google Drive Project if you encounter any rate limiting.

Creating the Destination

This guide shows how to add a Google Drive backup destination to JetBackup.

First make sure that you have the appropriate Google Drive destination plugin installed and enabled.

When creating the Destination, you will be prompted to install the Google Drive plugin and can click “Install Now” to install and enable the plugin.

Next, fill in the Backup Directory with the path you’d like to store your backups.

Then select the Google Drive Project (Integrated/Custom).

After selecting a Google Drive Project, click “Request Access Code” to authorize JetBackup to read and store files it creates using your Google Drive account. Proceed through the popup window until you receive an Access Code, which you can then paste in the “Request Access Code” text field.

An example of the Google App authorization popup after clicking “Request Access Code”. Please be sure to check the box “See, edit, create, and delete only the specific Google Drive files you use with this app” to allow JB the proper permissions:

Integrated

An example Integrated Google Drive Project Configuration page for the destination:

Custom

Follow these steps to setup your Custom Google Drive Project:

Navigate to https://console.developers.google.com/cloud-resource-manager and sign in with the Google Account you would like to create the custom project on.

Type in your project Name and then click the “CREATE” button

Enable Google Drive API for the project

Search for “Google Drive API”

Enable it for the project

Configure the OAuth Consent Screen

Click the drawer icon left to Google Cloud logo -> APIs & services -> OAuth Consent Screen to navigate to the Google Auth Platform page and then, press the “Get started” button. The consent screen must be configured prior to creating an OAuth Client ID for JetBackup.

Under “App Name” type the backup product’s name, such as “JetBackup”. Fill in the “User Support Email” field with your email address.

Select the Audience

Add your email in the Contact Information

Review Google API Services: User Data Policy and then press the “Create” button.

Configure the “Scopes” for your project. Scopes control what access your “App” has to your Google Drive. JetBackup will require read and write ability to be able to back up to your Google Drive.

Click the “Add or Remove Scopes” button

Now you should see a “Update Selected Scopes” panel on the right hand side. Please select the following scopes so you can add the Destination to JetBackup. The first two scopes are required to successfully authenticate when you use “Request Access Code” in a later step.

../auth/userinfo.email - View your email address
openid - Associate you with your personal info on Google
../auth/documents - See, edit, create, and delete all of your Google Drive files
../auth/drive - See, edit, create, and delete all of your Google Drive files

The scopes ../auth/documents and ../auth/drive may not appear on the list and can be added in the “Manually add scopes” field.

https://www.googleapis.com/auth/drive
https://www.googleapis.com/auth/documents

Create OAuth client ID

Navigate to the Clients page on the left side bar and press “Create client”

Choose “Web Application” under the Application type dropdown menu and choose a name to identify the OAuth client such as “JetBackupOAuth”. Under Authorized redirect URIs, click on “+ ADD URI”, specify https://auth.jetbackup.com/google/ on the URI field then click the “Create” button.

The “OAuth client created” modal should appear. Save the Client ID and Client secret to use when adding the Custom Google Drive destination in JetBackup.

NOTE: You will need to add your email address as a “Test User” in the Audience page to authenticate with Google Drive if you do not move the project out of “Testing” status in the Google Developer Console. You can skip adding a “Test User” by clicking “Publish App” from the Audience when complete.

In JetBackup, fill in the OAuth 2.0 Client Id and OAuth 2.0 Client Secret fields with the Client ID and Client secret that was generated earlier.

An example Custom Google Drive Project Configuration page for the destination:

Destination Name

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

Read Only

Owner

Maximum Concurrent Threads

Backup Directory

This will be our starting point when accessing this destination. Always use the absolute path and make sure to start with “/”. For example: /PATH/TO/FOLDER.

OAuth 2.0 Client Id (Custom Google Drive Project)

The unique identifier generated in the Google Cloud Console that identifies the application (JetBackup) requesting authorization to access Google Drive.

OAuth 2.0 Client Secret (Custom Google Drive Project)

The confidential key generated in the Google Cloud Console that is used to authenticate the application (JetBackup) when requesting authorization tokens from Google Drive.

Request Access Code

This option allows you to generate a secure access token for the purpose of storing and retrieving snapshots that were uploaded from your server using JetBackup.

HTTP Retries

Controls how many retries will be attempted if the destination returns an error for an HTTP call (upload / download / delete). [ default: 3 retries ]

Jb5: Dropbox

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

For video tutorials, please click here:

Creating the Destination

This guide shows how to add a Dropbox backup destination to JetBackup.

First make sure that you have the appropriate Dropbox destination plugin installed and enabled.

When creating the Destination, you will be prompted to install the Dropbox plugin and can click “Install Now” to install and enable the plugin.

Next, fill in the Backup Directory with the path you’d like to store your backups.

Then, click “Request Acces Code” to authorize JetBackup to read and store files it creates using your Dropbox account. Proceed through the popup window until you receive an Access Code, which you can then paste in the “Request Acces Code” text field.

An example Dropbox Configuration page for the destination:

An example of the Dropbox App authorization popup after clicking “Request Access Code”. If you are already signed in to Dropbox, you will receive a new access code automatically.

Destination Name

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

Read Only

Owner

Maximum Concurrent Threads

Backup Directory

This will be our starting point when accessing this destination. Always use the absolute path and make sure to start with “/”. For example: /PATH/TO/FOLDER.

Request Access Code

This option allows you to generate a secure access token for the purpose of storing and retrieving snapshots that were uploaded from your server using JetBackup.

HTTP Retries

Controls how many retries will be attempted if the destination returns an error for an HTTP call (upload / download / delete). [ default: 3 retries ]

Jb5: OneDrive

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

For video tutorials, please click here:

Creating the Destination

This guide shows how to add a OneDrive backup destination to JetBackup.

First make sure that you have the appropriate OneDrive destination plugin installed and enabled.

When creating the Destination, you will be prompted to install the OneDrive plugin and can click “Install Now” to install and enable the plugin.

Next, fill in the Backup Directory with the path you’d like to store your backups.

Then, click “Get Authorization Code” to authorize JetBackup to read and store files it creates using your OneDrive account. Proceed through the popup window until you receive an Authorization Code, which you can then paste in the “Get Authorization Code” text field.

An example OneDrive Configuration page for the destination:

An example of the OneDrive App authorization popup after clicking “Get Authorization Code”. If you are already signed in to OneDrive, you will receive a new Authorization code after accepting the required scopes.

Destination Name

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

Read Only

Owner

Maximum Concurrent Threads

Backup Directory

This will be our starting point when accessing this destination. Always use the absolute path and make sure to start with “/”. For example: /PATH/TO/FOLDER.

Request Access Code

This option allows you to generate a secure access token for the purpose of storing and retrieving snapshots that were uploaded from your server using JetBackup.

HTTP Version

Select the HTTP version that will be used to connect with the destinations.

Default - selects the version configured on the destination
HTTP/1.1
HTTP/1.2

HTTP Retries

Controls how many retries will be attempted if the destination returns an error for an HTTP call (upload / download / delete). [ default: 3 retries ]