R2VFS mounts one Cloudflare R2 bucket: every object becomes a file and every
/ in a key a folder. It reaches R2 through its S3-compatible API at
https://<accountId>.r2.cloudflarestorage.com. Set up credentials as in R2 setup.
Install
Configure
https://<accountId>.eu.r2.cloudflarestorage.com; set endpoint to it. 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.
Region requests are signed for; R2 addresses a bucket by account, not by region.
Cloudflare account ID. It builds the endpoint
https://<accountId>.r2.cloudflarestorage.com unless endpoint is set; one of the two is required.Authentication
Credentials come fromaccessKeyId and secretAccessKey, an R2 API token’s key
pair, with sessionToken for temporary credentials. Without them, the AWS SDK
reads its own chain: environment variables, ~/.aws/credentials, then the
instance or container role.
The token needs Object Read only on the bucket, or Object Read & Write
to write. A request the credentials may not make answers Permission denied.
Layout
/r2/data/file.txt is the key data/file.txt. Folders come from the / in
keys; R2 stores no folder objects.
Behavior
- Key prefix:
keyPrefix: 'users/42/'mounts only that part of the bucket, so/r2/notes.mdis the keyusers/42/notes.md.
Browser
The browserR2VFS from @struktoai/mirage-browser keeps credentials off the
page: a server signs a URL for each S3 call with the R2 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.accountIdandendpointonly 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
R2 accepts the S3 CORS call only from a token with Admin Read & Write on the
bucket; an object token gets
Access Denied. Without one, set the policy in the
Cloudflare dashboard: R2, the bucket,
Settings > CORS Policy, with the page’s origins, methods
GET,PUT,HEAD,DELETE,POST and allowed headers *. With an admin token: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.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.
Cloudflare account ID. It builds the endpoint
https://<accountId>.r2.cloudflarestorage.com unless endpoint is set.Integration
R2 answers these commands through its own API, so fewer objects are read. See Integration.md5sum: the object’s ETag, when it is the MD5 (a single-part upload, unencrypted or under SSE-S3).find: one recursive listing.du: one recursive listing.ls -Randtree: one recursive listing.
VFS.md
The VFS.md an agent reads with R2 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.