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
Named profile in the shared AWS config and credentials files that supplies credentials when no access key pair is given.
Address the bucket in the URL path (
<endpoint>/<bucket>/<key>) instead of as a subdomain of the endpoint.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.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.
Provider region every request is signed for. Most providers also build their endpoint URL from it unless
endpoint is set.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.Authentication
Credentials come fromaccessKeyId 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.mdis the keyusers/42/notes.md. - Path style: Supabase takes only path-style URLs, so
forcePathStyledefaults totrue.
Browser
The browserSupabaseVFS 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, answersPermission denied. keyPrefixset in the browser is no security boundary: enforce the prefix in the signing server.projectRefandendpointonly name the mount’s storage location: requests go to the host each signed URL names.
Signing server
Signing server
An Express route that signs URLs:Sign only the operations the app needs: a viewer needs
GET, HEAD and LIST.Bucket CORS rules
Bucket CORS rules
Supabase Storage’s S3 API follows the bucket’s CORS configuration, set in the
Supabase dashboard under the project’s Storage > Settings:
- Add the page’s origins, such as
http://localhost:5173. - Allow the methods
GET, PUT, HEAD, DELETE, POSTand the headers*. - Expose the headers
ETag, Content-Length, Content-Type, Last-Modified.
Browser fields
Browser fields
Function
(path, operation, options) that returns a signed URL for each S3 operation; your server signs it, so the browser holds no keys.Region of the bucket. Most providers derive the endpoint from it; requests go to the host each presigned URL names.
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.
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.
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.
Supabase project reference. It builds the endpoint
https://<projectRef>.storage.supabase.co/storage/v1/s3 unless endpoint is set.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 -Randtree: 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.
- Rendered
- Raw
Virtual Filesystem
Supported 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.