Skip to content

Latest commit

 

History

History
107 lines (73 loc) · 3.28 KB

README.md

File metadata and controls

107 lines (73 loc) · 3.28 KB
Storj logo

Single Tenant S3 Gateway

Go Report Card Go Doc

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

If you're looking for the rest of Storj's edge services, check out Edge.

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

We support all essential API actions, like

  • AbortMultipartUpload
  • CompleteMultipartUpload
  • CopyObject
  • CreateBucket
  • CreateMultipartUpload
  • DeleteBucket
  • DeleteObject
  • DeleteObjects
  • GetObject
  • HeadBucket
  • HeadObject
  • ListBuckets
  • ListMultipartUploads
  • ListObjects
  • ListObjectsV2
  • ListParts
  • PutObject
  • UploadPart

as well as (Get/Put/Delete)ObjectTagging actions.

For more details on gateway's S3 compatibility, please refer to Compatibility Table.

Testing

Correctness

A suite of integration tests can be run on the checked out code.

make integration-run will start a new integration environment using Docker and run all the integration tests.

At the end of the run, you can run make integration-env-purge to remove the integration environment.

This requires docker to be installed on your local machine for this to work.

mint

We run mint tests based on MinIO's mint (gateway-mint) on every commit.

To run the tests:

make integration-env-start integration-mint-tests

You can also run a specific test using the TEST environment variable:

TEST=aws-sdk-php make integration-mint-tests

ceph/splunk-s3-tests

We run S3 tests based on Splunk's fork (which is better suited for us) of Ceph's S3 tests (splunk-s3-tests) on every commit.

To run the tests:

make integration-env-start integration-splunk-tests

License

This library is distributed under the Apache-2.0 license.

Support

If you have any questions or suggestions please reach out to us on our community forum or email us at [email protected].