S3
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 (check amazon's documentation on creating buckets).
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
Enabling Read Only will not allow you to backup to this destination. Read Only is required if the Backup Directory is already owned by another destination/server.
Owner
Specify the creator for this destination. This grants the creator and its parent account(s) permission to modify and delete this destination. Please note that the creator 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.
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.
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.
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 -
- Digital Ocean Object Storage - Create a Space
- IBM Cloud Object Storage - Getting started with IBM Cloud Object Storage
- ScaleWay Elements - Creating a Bucket through the Scaleway Console
- Wasabi - Creating a Bucket
Region
JetBackup will allow to select known regions for the S3 Destination chosen. Custom regions can also be acceppted so long as it matches the region assigned to the bucket.