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://<account_id>.r2.cloudflarestorage.com. Set up credentials as in R2 setup.
Install
Configure
https://<account_id>.eu.r2.cloudflarestorage.com; set endpoint_url to it. A
mount takes MountMode.READ, WRITE or EXEC.
Fields
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.
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.Cloudflare account ID. It builds the endpoint
https://<account_id>.r2.cloudflarestorage.com unless endpoint_url is set; one of the two is required.Authentication
Credentials come from the first of:access_key_idandsecret_access_key, an R2 API token’s key pair, withsession_tokenfor temporary credentials.aws_profile, a profile in~/.aws/credentials.- The AWS credential chain: environment variables, then the instance or container role.
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:
key_prefix="users/42/"mounts only that part of the bucket, so/r2/notes.mdis the keyusers/42/notes.md.
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.