S3 Compatible
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 creting buckets for your corresponding S3 Vendor, please click here).
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
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.
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.
Vendor
Choose which S3 compatible vendor you will be using as your S3 destination.
Custom Vendor
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. View the example configuration below.
us-west-001 and replace the {region} with the inputted field whenever needed.{bucket} depending on the endpoint format. This is not required for most S3 destinations.Backup Directory
This will be our starting point when accessing this destination.
Make sure to start with "/".
Always use the absolute path, 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.
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.
Amazon S3 - Managing Access keys AWS Console
BackBlaze B2 - Creating and Managing Application Keys
- NOTE: Instead of Access Key/Secret Key, BackBlaze B2 Application Keys use keyID/applicationKey respectively. Additionally, be sure to give Application Key Read and Write "Type of Access".
Digital Ocean Object Storage - Creating an Access 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
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.
Amazon S3 - How do I create an S3 Bucket
BackBlaze B2 - Configure BackBlaze
Digital Ocean Object Storage - Create a Space
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.
ScaleWay Elements - Creating a Bucket through the Scaleway Console
Wasabi - Creating a Bucket
Region
JetBackup will list known regions for the S3 Destination chosen.
It is best practice to choose the closest region, if available, if not maybe consider a vendor with closer regions for best performance.
Verify SSL
Whether SSL verification is enabled/disabled on the s3 compatible destination.