Skip to main content
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

A bucket in a jurisdiction has its own endpoint, such as https://<account_id>.eu.r2.cloudflarestorage.com; set endpoint_url to it. A mount takes MountMode.READ, WRITE or EXEC.

Fields

float
default:"30"
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.
str
required
Name of the bucket to mount.
str
default:"'auto'"
Region requests are signed for; R2 addresses a bucket by account, not by region.
str
Endpoint URL that replaces the one the provider derives.
str
secret
Access key ID; set it with secret_access_key. Unset uses the AWS credential chain.
str
secret
Secret access key paired with access_key_id.
str
secret
Session token for temporary credentials, sent with the access key pair.
str
Named profile in the shared AWS config and credentials files that supplies credentials when no access key pair is given.
bool
default:"False"
Address the bucket in the URL path (<endpoint>/<bucket>/<key>) instead of as a subdomain of the endpoint.
str
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.
str
secret
Proxy URL for every HTTP and HTTPS request to the endpoint.
str
Cloudflare account ID. It builds the endpoint https://<account_id>.r2.cloudflarestorage.com unless endpoint_url is set; one of the two is required.
Fields marked secret are redacted in snapshots.

Authentication

Credentials come from the first of:
  1. access_key_id and secret_access_key, an R2 API token’s key pair, with session_token for temporary credentials.
  2. aws_profile, a profile in ~/.aws/credentials.
  3. The AWS credential chain: environment variables, 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: key_prefix="users/42/" mounts only that part of the bucket, so /r2/notes.md is the key users/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 -R and tree: 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.
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.