Skip to main content
An existing bucket on the SeaweedFS S3 gateway becomes a folder tree, with one file per object.

Setup

The SeaweedFS S3 gateway (weed s3, port 8333 by default) takes access keys from an S3 config file. With no identities defined, it accepts any key pair, which suits local development.
Write the identities to s3.json:
s3.json
Start the gateway with it, weed s3 -filer=localhost:8888 -config=s3.json or weed server -s3 -s3.config=s3.json. Drop Write:my-bucket for a read-only key. Once any identity exists, the gateway requires authentication even after the identities are removed.
  • The gateway is self-hosted, so the endpoint is required and requests are path-style.
  • Blaxel Agent Drive is backed by SeaweedFS: use the drive’s s3Url as the endpoint and a drive access token’s credentials as the key pair.

Connect

workspace.yaml

Layout

  • Each object key is a file path; folders are key prefixes, and the bucket holds no directory objects.
  • key_prefix (keyPrefix in TypeScript) mounts one subpath of the bucket as the root.
  • grep -r, find and du stop after 1000 files; a glob matching more, tar -c, cp -r and rm -r are refused.

Sample runs

On a write mount, redirects, cp, mv and rm change objects in the bucket. For write: conditional, see S3-compatible VFSes.

SDK guides

Python

Every config field, the VFS.md and write support.

TypeScript

Every config field, the VFS.md and write support.