/gateway-st

Minimal S3 compatible server for interacting with Storj Network.

Primary LanguageGoApache License 2.0Apache-2.0

Single Tenant S3 Gateway

S3-compatible gateway for Storj V3 Network, based on MinIO.

If you're looking for our multi-tenant gateway, check out Gateway-MT.

Go Report Card Go Doc Beta

Storj is building a decentralized cloud storage network. Check out our white paper for more info!


Storj is an S3-compatible platform and suite of decentralized applications that allows you to store data in a secure and decentralized manner. Your files are encrypted, broken into little pieces and stored in a global decentralized network of computers. Luckily, we also support allowing you (and only you) to retrieve those files!

Documentation

S3 API Compatibility

The following S3 methods are supported:

  • HeadBucket
  • CreateBucket
  • DeleteBucket
  • ListBuckets
  • HeadObject
  • PutObject
  • GetObject
  • DeleteObject
  • DeleteObjects
  • ListObjects
  • ListObjectsV2

We use the minio mint testsuite to ensure our compatibility to the S3 API. As some S3 methods are not supported yet, we use a custom build that you can run it against any endpoint using docker. To build our custom image and tag it as storj/mint:

docker build --pull https://github.com/storj/minio.git#storj -f Dockerfile.mint -t storj/mint

To run the tests against the endpoint endpoint_address (using the HOST:PORT format), use:

docker run -e SERVER_ENDPOINT=endpoint_address -e ACCESS_KEY=myaccesskey -e SECRET_KEY=mysecretkey -e ENABLE_HTTPS=0 storj/mint

The ENABLE_HTTPS flag indicates if https should be used (ENABLE_HTTPS=1)

License

This library is distributed under the Apache v2 license.

Support

If you have any questions or suggestions please reach out to us on our community forum or email us at support@storj.io.