Skip to main content
SupabaseVFS mounts one Supabase Storage bucket: every object becomes a file and every / in a key a folder. It reaches Supabase through the Storage S3 API. Set up credentials as in Supabase setup.

Install

Configure

projectRef builds the endpoint https://<projectRef>.storage.supabase.co/storage/v1/s3; endpoint replaces it. region is required to sign requests: use the one on the project’s Storage settings page. A mount takes MountMode.READ, WRITE or EXEC.

Fields

string
required
Name of the bucket to mount.
string
secret
Access key ID; set it with secretAccessKey. Unset uses the AWS SDK credential chain.
string
secret
Secret access key paired with accessKeyId.
string
secret
Session token for temporary credentials, sent with the access key pair.
string
Named profile in the shared AWS config and credentials files that supplies credentials when no access key pair is given.
boolean
default:"true"
Address the bucket in the URL path (<endpoint>/<bucket>/<key>) instead of as a subdomain of the endpoint.
string
Key prefix inside the bucket that the mount treats as its root; keys outside it are not visible. Leading slashes are dropped and a trailing / is added.
number
default:"DEFAULT_TIMEOUT"
Seconds a request may wait to connect, or between two reads of its answer, before it fails; a download that keeps flowing is never cut off.
string
secret
Proxy URL for every HTTP and HTTPS request to the endpoint.
string
required
Provider region every request is signed for. Most providers also build their endpoint URL from it unless endpoint is set.
string
Endpoint URL that replaces the one the provider derives.
string
Supabase project reference. It builds the endpoint https://<projectRef>.storage.supabase.co/storage/v1/s3 unless endpoint is set; one of the two is required.
Fields marked secret are redacted in snapshots.

Authentication

Credentials come from accessKeyId and secretAccessKey, a Storage S3 access key, with sessionToken for temporary credentials. Without them, the AWS SDK reads its own chain: environment variables, ~/.aws/credentials, then the instance or container role. Use an S3 access key, not the project’s anon or service_role key. An S3 access key reaches every bucket in the project and bypasses Row Level Security, so keep it on a server. A request the credentials may not make answers Permission denied.

Layout

/supabase/data/file.txt is the key data/file.txt. Folders come from the / in keys; Supabase stores no folder objects.

Behavior

  • Key prefix: keyPrefix: 'users/42/' mounts only that part of the bucket, so /supabase/notes.md is the key users/42/notes.md.
  • Path style: Supabase takes only path-style URLs, so forcePathStyle defaults to true.

Browser

The browser SupabaseVFS from @struktoai/mirage-browser keeps credentials off the page: a server signs a URL for each S3 call with the Supabase keys, and the browser fetches it.
  • The bucket’s CORS rules must allow the page’s origin, exactly as served.
  • A browser mount cannot declare write: conditional, and any HTTP 403 from a signed URL, an expired one included, answers Permission denied.
  • keyPrefix set in the browser is no security boundary: enforce the prefix in the signing server.
  • projectRef and endpoint only name the mount’s storage location: requests go to the host each signed URL names.
An Express route that signs URLs:
Sign only the operations the app needs: a viewer needs GET, HEAD and LIST.
Supabase Storage’s S3 API follows the bucket’s CORS configuration, set in the Supabase dashboard under the project’s Storage > Settings:
  1. Add the page’s origins, such as http://localhost:5173.
  2. Allow the methods GET, PUT, HEAD, DELETE, POST and the headers *.
  3. Expose the headers ETag, Content-Length, Content-Type, Last-Modified.
string
required
Name of the bucket to mount.
function
required
secret
Function (path, operation, options) that returns a signed URL for each S3 operation; your server signs it, so the browser holds no keys.
string
Region of the bucket. Most providers derive the endpoint from it; requests go to the host each presigned URL names.
string
Endpoint URL that replaces the one the provider derives. Requests go to the host each presigned URL names; the mount uses it to name its storage location.
string
default:"'application/octet-stream'"
Content-Type stored with every object the mount writes.
string
Key prefix the mount treats as its root. The browser can change it before a URL is signed, so enforce the prefix on the signing server.
number
default:"DEFAULT_TIMEOUT"
Seconds a request may wait to connect, or between two reads of its answer, before it fails; a download that keeps flowing is never cut off.
string
Supabase project reference. It builds the endpoint https://<projectRef>.storage.supabase.co/storage/v1/s3 unless endpoint is set.
Fields marked secret are redacted in snapshots.

Integration

Supabase answers these commands through its own API, so fewer objects are read. See Integration.
  • find: one recursive listing.
  • du: one recursive listing.
  • ls -R and tree: one recursive listing.

VFS.md

The VFS.md an agent reads with Supabase mounted at /<path>. <mode> is the mount’s mode: read, write or exec. The commands shown are those of a write mount.
Virtual FilesystemSupported Unix Commands for VFSUnix commands work on each path as on a local filesystem, as far as the path supports them:Limitations of Unix Commands for VFSWhere a path differs from a local filesystem:Run man <cmd> or <cmd> --help for one command’s usage.