Supported Storage Providers

  • Local filesystem
  • AWS S3
  • DigitalOcean Spaces
  • Google Cloud Storage
  • Azure Blob Storage

AWS S3

Credentials and Region

AWS credentials and configuration are loaded as described in the AWS SDK documentation:

For example, you can set environment variables AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, or create a file ~/.aws/credentials with AWS credentials.

If running in an AWS Lambda Function, temporary credentials (including an AWS_SESSION_TOKEN) are automatically created. You do not need to manually configure these.

Specify the region using the AWS_REGION environment variable or in ~/.aws/config.

DigitalOcean Spaces

DigitalOcean Spaces is an S3-compatible object storage that this project also supports.

  1. Create a Space.
  2. Generate a new spaces access key.
  3. Fill in the AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY environment variables based on the access key you created.
  4. Set AWS_REGION to us-east-1 - Explanation
  5. Set STORAGE_PATH to the name of the Space you created.
  6. Set S3_ENDPOINT to the endpoint of the Space you created. For example, https://nyc3.digitaloceanspaces.com.
  7. Set STORAGE_PROVIDER to s3.

Google Cloud Storage

  1. Create a bucket (or use an existing one).
  2. Create a new service account.
  3. Grant the role Storage Object Admin to the service account on the bucket. 
      # .env
  STORAGE_PROVIDER=google-cloud-storage
  STORAGE_PATH=<name-of-the-bucket>

    Using static Service Account credentials

  4. Click “Create Key” and save the JSON file.
  5. Add the project_id , client_email, and private_key from saved JSON file to .env (or wherever you manage your environment variables): 
      # .env
  GCS_PROJECT_ID=<project_id>
  GCS_CLIENT_EMAIL=<client_email>
  GCS_PRIVATE_KEY=<private_key>

    Using Application Default Credentials (ADC)

  6. Do not set GCS_* environment variables 
      # .env
  GCS_PROJECT_ID=
  GCS_CLIENT_EMAIL=
  GCS_PRIVATE_KEY=

Azure Blob Storage

  1. Create a new Blob Storage.
  2. On “Security + networking” tab, copy one of Connection string on “Access keys” blade.
  3. Set ABS_CONNECTION_STRING to the connection string.

Minio

  1. Create Access key
  2. Fill in the AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY environment variables based on the access key you created.
  3. Create bucket
  4. Set STORAGE_PATH to the name of the bucket you created.
  5. Set AWS_REGION (can leave blank S3_REGION= for none).
  6. Set STORAGE_PROVIDER to minio.
  7. Set S3_ENDPOINT to Minio url (ie http://127.0.0.1:9000)