Tools & SDKs

rclone

rclone can either sync between Uploom and a local folder, or mount the gateway as a real FUSE filesystem. Both modes work with the gateway's path-style addressing.

Remote

Write 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

List buckets

rclone lsd uploom:

Sync a local folder to a bucket

rclone sync /Users/me/photos uploom:bucket/photos \
  --transfers 8 --checkers 16 --progress

Mount the gateway as a filesystem

macOS / Linux (FUSE):

mkdir -p ~/Uploom
rclone mount uploom:bucket ~/Uploom \
  --vfs-cache-mode full --daemon

On macOS, install macFUSE first. On Linux, install fuse3.

VFS cache

For smooth reading of large files, enable the VFS cache. rclone will pre-fetch bytes so Finder / Explorer doesn't have to stream them directly from the gateway.

rclone mount uploom: ~/Uploom \
  --vfs-cache-mode full \
  --vfs-cache-max-age 24h \
  --vfs-read-ahead 128M

Useful flags

• --transfers N — concurrent uploads per sync.
• --checkers N — concurrent listings.
• --retries 5 — retry on transient network errors.
• --no-traverse — skip the initial list; use when mounting a huge tree.