uppy/examples/digitalocean-spaces/README.md

Uploading to DigitalOcean Spaces

This example uses Uppy to upload files to a DigitalOcean Space. DigitalOcean Spaces has an identical API to S3, so we can use the AwsS3 plugin. We use @uppy/companion with a custom endpoint configuration that points to DigitalOcean.

Running it

To run this example, make sure you've correctly installed the repository root:

corepack yarn install
corepack yarn build

That will also install the dependencies for this example.

First, set up the COMPANION_AWS_KEY, COMPANION_AWS_SECRET, COMPANION_AWS_REGION (use a DigitalOcean region name for COMPANION_AWS_REGION, e.g. nyc3), and COMPANION_AWS_BUCKET environment variables for @uppy/companion in a .env file. You may find useful to first copy the .env.example file:

[ -f .env ] || cp .env.example .env

To setup the CORS settings of your Spaces bucket in accordance with the plugin docs, you can use the example XML config file with the s3cmd CLI:

s3cmd setcors examples/digitalocean-spaces/setcors.xml "s3://$COMPANION_AWS_BUCKET"

Then you can start the dev server:

corepack yarn workspace @uppy-example/digitalocean-spaces start