Uploom

Quickstart

Get started in five minutes

Connect a cloud storage account, mint an API token, and run your first S3 command against Uploom. The whole flow takes about five minutes.

1. Sign up and connect a provider

  1. Open the Uploom dashboard and create an account.
  2. Go to Providers and click Connect.
  3. Pick a provider (Google Drive, Dropbox, Mega, S3, …) and follow the OAuth flow. The provider account you connect shows up as an S3 bucket in the gateway.

You can connect as many accounts as you want — one per provider type is a common starting point.

2. Mint an API token

  1. In the dashboard, go to API tokens.
  2. Click Generate token, give it a label, and submit.
  3. Copy the accessKeyId and secretAccessKey. The secret is shown only once.

See Authentication for the full details on how the gateway uses these.

3. Configure your S3 client

Pick the tool you already use. The only change from real S3 is pointing the client at the Uploom gateway URL and forcing path-style addressing.

AWS CLI

Add a profile to ~/.aws/config:

[profile uploom]
region = us-east-1
output = json
endpoint_url = https://s3.uploom.io
s3 =
  addressing_style = path

And to ~/.aws/credentials:

[uploom]
aws_access_key_id = 
aws_secret_access_key =

rclone

Add to ~/.config/rclone/rclone.conf:

[uploom]
type = s3
provider = Other
access_key_id = <access-key-id>
secret_access_key = <secret-access-key>
endpoint = https://s3.uploom.io
force_path_style = true
region = us-east-1

boto3 (Python)

import boto3

s3 = boto3.client(
    "s3",
    endpoint_url="https://s3.uploom.io",
    aws_access_key_id="<access-key-id>",
    aws_secret_access_key="<secret-access-key>",
    region_name="us-east-1",
    config=boto3.session.Config(signature_version="s3v4", s3={"addressing_style": "path"}),
)

4. Run your first commands

# List your buckets (one per connected provider)
AWS_PROFILE=uploom aws s3 ls
# 2026-06-13 13:42:53 bucket-a

# List contents of a bucket
AWS_PROFILE=uploom aws s3 ls s3://bucket-a/

# Upload a file
AWS_PROFILE=uploom aws s3 cp ./local.txt s3://bucket-a/folder/

# Download a file
AWS_PROFILE=uploom aws s3 cp s3://bucket-a/folder/local.txt ./

Troubleshooting