Skip to main content
An existing Supabase Storage bucket becomes a folder tree, with one file per object, reached through its S3-compatible API at https://<project-ref>.storage.supabase.co/storage/v1/s3.

Setup

Supabase signs S3 requests with an S3 access key, not the project’s anon or service_role key.
  1. In the Supabase dashboard, open the project, then Storage > Settings, and turn on the S3 connection.
  2. Under S3 Access Keys, pick New access key.
  3. Copy the Access key ID and Secret access key. Supabase shows the secret only once.
  4. Copy the Region from the same page. Supabase needs one to sign requests.
  5. Copy the project reference from the dashboard URL: https://supabase.com/dashboard/project/<project-ref>.
  • An S3 access key reaches every bucket in the project and bypasses Row Level Security. Keep it on a server.
  • Supabase requires path-style URLs; both SDKs use them by default.

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.