S3-compatible bucket

s3 Writes backups to a bucket in Amazon S3, Cloudflare R2, Backblaze B2, MinIO or another S3-compatible store.

Setup

  1. Create a bucket

    1. In the store's console, create a private bucket, such as pando-backups.
    2. Add a lifecycle rule that deletes incomplete multipart uploads after one day.
    3. Copy the bucket's region and, unless the store is Amazon S3, its S3 API endpoint.

    Settings endpoint, region, bucket, prefix, path_style

  2. Create an access key

    1. Create an access key limited to the bucket, allowed these actions:
      Action
      s3:ListBucket
      s3:PutObject
      s3:GetObject
      s3:DeleteObject
      s3:AbortMultipartUpload
    2. Copy the Access key ID and the Secret access key.

    Settings access_key_id, secret_access_key

Settings (7)
endpointEndpoint

Empty is Amazon S3.

string · For example https://s3.us-west-002.backblazeb2.com

regionRegionRequired

Cloudflare R2 uses auto.

string · For example us-east-1

bucketBucketRequired

It has to exist already.

string · For example pando-backups

prefixPrefix

Empty is the top of the bucket.

string · For example pando/

path_stylePath-style addresses

endpoint/bucket rather than bucket.endpoint.

bool

access_key_idAccess key IDRequiredCredential

A key that can list the bucket and put, get and delete objects in it.

string

secret_access_keySecret access keyRequiredCredential

Stored encrypted, and never shown again.

string