billstclair / elm-s3

A pure-Elm interface to Amazon's Simple Storage Service and Digital Ocean's Spaces
MIT License
7 stars 5 forks source link

elm-package

Pure-Elm client for Amazon S3 and DigitalOcean Spaces key/value stores. It targets a subset of the DigitalOcean subset of the Amazon S3 API.

URLs

DigitalOcean Spaces doesn't really have the concept of a "bucket". Instead, it has a "unique name", which becomes a subdomain of the host. So the "index.html" key in the "elm-s3" bucket (in the "us-east-1" region for Amazon or the "nyc3" region for Digital Ocean) becomes:

Example

The example directory has some sample code, with a simple user interface.

Cross-Origin Resource Sharing (CORS)

It's very easy to get CORS errors when doing S3 requests from a web browser. You can't list buckets at all, and you need to set the CORS properties on buckets, with some tool other than a browser, in order to be able to access them from a browser.

cors.xml is an example of XML to send as the body in an s3cmd "setcors" command:

s3cmd setcors cors.xml s3://BUCKET

For Amazon S3, you can use the AWS Management Console to set the CORS properties. For Digital Ocean Spaces, you need to do it with an SDK or s3cmd. The Amazon S3 CORS documentation is here.

And you'll need a JSON version of the CORS configuration for that:

cors.json

Credits

My thanks to Kevin Tonon for his elm-aws-core package, and to the-sett for upgrading it to Elm 0.19.1: the-sett/elm-aws-core package. Without it, I would likely have thrown up my hands in despair over ever getting the signing and authorization crypto to work.