Skip to content

Setting Up an S3 Storage Provider

The below outlines how to setup an S3 storage provider for use with TrueCharts.

S3 Backup Providers

Our only officially supported system for “offsite” backups is S3(-compatible) storage. Offsite can be either another machine with running MinIO or an S3 Storage provider like BackBlaze, CloudFlare, Amazon (coming soon) and more. Currently our only officially supported backup providers are CloudFlare and BackBlaze, but we’re working to expand this list in the future.

Both CloudFlare and BackBlaze provide a free plan with 10GB of storage included.

Obtaining S3 credentials

CloudFlare

  1. Login into your CloudFlare account and go to the R2 section seen below, you might need to agree to the Terms for the R2 Storage

S3 Cloudflare 1

  1. Click on “Manage R2 API Token” as highlighted in the picture below

S3 Cloudflare 2

  1. Click on “Create API token” in the top right corner and name it to your liking

  2. Give “Admin Read & Write” Permissions and click on “Create API token” in the bottom right

  3. It now shows you a screenshot with your S3 Credentials like this:

S3 Cloudflare 3

CloudFlare credentials assignment

  • Access Key ID -> accessKey
  • Secret Access Key -> secretKey
  • endpoint, default -> url

Backblaze

  1. Create a new Application Key as below

S3 Backblaze 1

  1. Allow access to all buckets, give it “Read and Write Access” and give it a meaningful name

S3 Backblaze 2

  1. Note down the shown credentials

S3 Backblaze 3

Backblaze credentials assignment

  • keyID -> accessKey
  • applicationKey -> secretKey

Storj

  • Go to Access Keys of your storj project
  • Create new access key, give it a name, and select S3 Credential
  • Select Advanced to only give access to a specific bucket (optional). Otherwise, select Full Access.

S3 Storj 1

  • Select all permissions (it might work with just read and write)
  • Select the bucket where you want to store the backups
  • Select No Expiration
  • Click Create Access

S3 Storj 1

Storj Credentials assignment

MinIO

  1. Login into MinIO web interface.

S3 MinIO 1

  1. Navigate to the “Access Keys” section and click “Create access key” as shown below.

S3 MinIO 2

  1. Fill out the form if wanted or leave the form as it is and click on “Create” in the lower right corner.

S3 MinIO 3

  1. If you want to store the generated credentials, click “Download for import” to store them to an .json file.

S3 MinIO 4

  1. The API url can be found when starting the MinIO server

S3 MinIO 5

MinIO credentials assignment

  • Access Key -> accessKey
  • Secret Key -> secretKey
  • API url -> url