From 9aeb689d65feb4ad2dd61b363fae4261bbee6ecb Mon Sep 17 00:00:00 2001 From: warflash Date: Tue, 16 Jan 2024 19:36:31 +0100 Subject: [PATCH] docs: add instructions for DO spaces setup --- docs/supported-storage-providers.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/docs/supported-storage-providers.md b/docs/supported-storage-providers.md index 46a3f048..bced3443 100644 --- a/docs/supported-storage-providers.md +++ b/docs/supported-storage-providers.md @@ -8,6 +8,7 @@ nav_order: 3 - [x] Local filesystem - [x] AWS S3 +- [x] DigitalOcean Spaces - [x] Google Cloud Storage - [x] Azure Blob Storage @@ -30,6 +31,19 @@ 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](https://cloud.digitalocean.com/spaces) +2. Generate a new [spaces access key](https://cloud.digitalocean.com/account/api/spaces) +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](https://docs.digitalocean.com/products/spaces/how-to/use-aws-sdks/#configure-a-client) +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](https://console.cloud.google.com/storage/browser) (or use an existing one)