Self-hosted S3 Compatible Gateway

For a complete list of the supported architectures and API calls for the S3 Gateway, see S3 Compatibility.

Minimum Requirements

✅ 1 CPU

✅ 2GB of RAM

Depending on the load and throughput, more resources may be required.

Dependencies

✅ Uplink CLI

✅ Create Access Grant in CLI or Create an Access Grant

Steps:

1. Get and install Gateway ST
2. Configure Gateway ST
3. Run Gateway ST
4. Configure AWS CLI to use Gateway ST
5. Try it out!

Get and install Gateway ST

Download, unzip, and install the binary for your OS:

curl https://github.com/storj/gateway-st/releases/latest/download/gateway_windows_amd64.exe.zip -o gateway_windows_amd64.exe.zip; Expand-Archive gateway_windows_amd64.exe.zip -Destination . -Force

curl -L https://github.com/storj/gateway-st/releases/latest/download/gateway_linux_amd64.zip -O && unzip gateway_linux_amd64.zip
chmod 755 gateway
sudo mv gateway /usr/local/bin/gateway

curl -L https://github.com/storj/gateway-st/releases/latest/download/gateway_linux_arm.zip -O && unzip gateway_linux_arm.zip
chmod 755 gateway
sudo mv gateway /usr/local/bin/gateway

curl -L https://github.com/storj/gateway-st/releases/latest/download/gateway_darwin_amd64.zip -O && unzip gateway_darwin_amd64.zip
chmod 755 gateway
sudo mv gateway /usr/local/bin/gateway

docker pull storjlabs/gateway

Configure Gateway ST

You have two ways to configure your Gateway ST:

1. Self-hosted S3 Compatible Gateway (only if it is your first setup)
2. Self-hosted S3 Compatible Gateway

Interactive Setup

1. Setup your S3 gateway by running the following command and following the instructions provided by the wizard:

./gateway.exe setup

gateway setup

gateway setup

docker run -it --rm --mount type=bind,source=/path/to/gateway-config-dir/,destination=/root/.local/share/storj/gateway/ --name gateway storjlabs/gateway setup

2. Enter the numeric choice or satellite address corresponding to the satellite you've created your account on.

The satellite address should be entered as <nodeid>@<address>:<port> for example: 12L9ZFwhzVpuEKMUNUqkaTLGzwY9G24tbiigLiXpmZWKwmcNDDs@eu1.storj.io:7777, or just use the number from the list:



3. Choose an access name (this step may not yet be implemented in the version of S3 Gateway you are using - if you don't see this prompt, skip to step 5 below).



4. Enter the Create Access Grant in CLI you generated:

Didn't save your Access token? Simply create another one in the satellite web interface.



5. Create and confirm an encryption passphrase, which is used to encrypt your files before they are uploaded:



6. Your S3 gateway is configured and ready to use!

Using an Access Grant

You can use two methods to obtain an Access Grant:

1. Create an Access to an Object
   
2. Create an Access Grant

Now we got our access grant and can configure the gateway as follows:

docker run -it --rm --mount type=bind,source=/path/to/gateway-config-dir/,destination=/root/.local/share/storj/gateway/ --name gateway storjlabs/gateway setup --access 14aV.... --non-interactive

This command will register the provided access as the default access in the gateway config file.

It is possible to have several access grants, see how Gateway ST Advanced Usage.

Run Gateway ST

The gateway functions as a daemon. Start it and leave it running.

./gateway.exe run

gateway run

gateway run

docker run -it --rm -p 127.0.0.1:7777:7777 --mount type=bind,source=/path/to/gateway-config-dir/,destination=/root/.local/share/storj/gateway/ --name gateway storjlabs/gateway run

The gateway should output your S3-compatible endpoint, access key, and secret key.

Example terminal output



If you are interested in more running options, checkout the Gateway ST Advanced Usage page where you can find how to:

1. Gateway ST Advanced Usage
   
2. Gateway ST Advanced Usage
   
3. Gateway ST Advanced Usage
   

Configure AWS CLI to use Gateway ST

Once you do, in a new terminal session, configure it with your Gateway's credentials:

$ aws configure
---
AWS Access Key ID: [Enter your Gateway's Access Key]
AWS Secret Access Key: [Enter your Gateway's Secret Key]
Default region name: [null]
Default output format: [null]

$ aws configure set default.s3.multipart_threshold 64MB

Then, test out some AWS S3 CLI commands!

Try it out!

Create a bucket

aws s3 --endpoint=http://localhost:7777 mb s3://bucket-name

Upload an object

aws s3 --endpoint=http://localhost:7777 cp your-large-file.mp4 s3://bucket-name/your-large-file.mp4

List objects in a bucket

aws s3 --endpoint=http://localhost:7777 ls s3://bucket-name/

Download an object

aws s3 --endpoint=http://localhost:7777 cp s3://bucket-name/your-large-file.mp4 ~/Downloads/your-large-file.mp4

Generate a URL for an object

aws s3 --endpoint=http://localhost:7777 presign s3://bucket-name/your-large-file.mp4

(This URL will allow live video streaming through your browser or VLC)

Delete an object

aws s3 --endpoint=http://localhost:7777 rm s3://bucket-name/your-large-file.mp4

All Commands

cp - Copies a local file or S3 object to another location locally or in S3

ls - List S3 objects and common prefixes under a prefix or all S3 buckets

mb - Creates an S3 bucket

mv - Moves a local file or S3 object to another location locally or in S3.

presign - Generate a pre-signed URL for an S3 object. This allows anyone who receives the pre-signed URL to retrieve the S3 object with an HTTP GET request.

rb - Deletes an empty S3 bucket

rm - Deletes an S3 object

sync - Syncs directories and S3 prefixes. Recursively copies new and updated files from the source directory to the destination. Only creates folders in the destination if they contain one or more files

And that's it! You've learned how to use our S3-compatible Gateway. Ideally, you'll see how easy it is to swap out AWS for the Uplink, going forward.