Connect Your Tools
Every S3 tool needs the same five values. Open your bucket in the dashboard and click Credentials to see them:
| Value | Example |
|---|---|
| Endpoint | https://fra1.my-s3.com |
| Region | fra1 |
| Bucket | the bucket name for your tools |
| Access Key ID | the public part of the key |
| Secret Key | the private part, hidden until you show it |
The bucket page also has a Quick connect section with ready-made configs for the aws-cli and rclone, already filled in with your values.
Examples
The examples below use the location fra1. Replace it with the location of your bucket, and replace the values in angle brackets with your credentials.
Add a profile to ~/.aws/credentials:
[my-s3]
aws_access_key_id = <access key id>
aws_secret_access_key = <secret key>
And its settings to ~/.aws/config:
[profile my-s3]
region = fra1
payload_signing_enabled = false
Then pass the profile and the endpoint with every command:
aws s3 ls s3://<bucket>/ --profile my-s3 --endpoint-url https://fra1.my-s3.com
aws s3 cp ./backup.tar s3://<bucket>/backups/ --profile my-s3 --endpoint-url https://fra1.my-s3.com
Add a remote to your rclone config (rclone config file shows where it is):
[my-s3]
type = s3
provider = Other
access_key_id = <access key id>
secret_access_key = <secret key>
endpoint = https://fra1.my-s3.com
region = fra1
Then use the remote with the bucket name:
rclone ls my-s3:<bucket>
rclone sync /srv/data my-s3:<bucket>/data --progress
restic reads the credentials from environment variables. Set them, create the repository once, and back up:
export AWS_ACCESS_KEY_ID=<access key id>
export AWS_SECRET_ACCESS_KEY=<secret key>
export AWS_DEFAULT_REGION=fra1
export RESTIC_REPOSITORY=s3:https://fra1.my-s3.com/<bucket>/restic
restic init
restic backup /srv/data
restic encrypts your data before the upload. Keep the repository password safe: without it, nobody can restore the backup, not even we.
Hyper Backup backs up a Synology device to a bucket. In Hyper Backup, create a Data backup task and select S3 Storage as the destination. Then set S3 Server to Custom Server URL and enter these values:
| Field | Value |
|---|---|
| Server address | your endpoint without https://, for example fra1.my-s3.com |
| Signature version | v4 |
| Access key | the Access Key ID of your bucket |
| Secret key | the Secret Key of your bucket |
| Bucket name | your bucket, from the list |
Hyper Backup signs its requests for a fixed region. Our buckets accept the region that a tool sends, so you do not need to change it.
Plesk stores backups in a bucket with its Amazon S3 Backup extension. Install the extension, open Backup Manager, then Remote Storage Settings, and select Amazon S3 Backup. Choose a custom service provider and enter these values:
| Field | Value |
|---|---|
| Service endpoint URL | your endpoint, for example https://fra1.my-s3.com |
| Access key | the Access Key ID of your bucket |
| Secret key | the Secret Key of your bucket |
| Bucket | your bucket |
Plesk signs its requests for a fixed region, and the extension has no field to change it. Our buckets accept the region that a tool sends, so you do not need to change it. Older guides tell you to set RegionForCustomEndpoint in panel.ini; you can leave that setting out.
Other tools work the same way: choose a custom or "other" S3 provider, and enter the endpoint, region, access key and secret key. Tools with a fixed region, such as Synology Hyper Backup and Plesk, work too: our buckets accept the region that a tool sends. When a tool cannot connect, check the limits.