Skip to content

Drivers Overview

Every entry under disks has a driver name and a driver-specific config. The built-in drivers are:

Driverconfig shapeNotes
local{ location, url?, visibility?, ... }Reads/writes to the local filesystem.
s3{ bucket, region, credentials, cdn?, ... }Also covers MinIO, B2, DigitalOcean Spaces, Wasabi via endpoint.
r2{ bucket, endpoint, credentials, region? }Cloudflare R2 — same as s3 with the right defaults baked in.
gcs{ bucket, ... }Google Cloud Storage.
azure{ containerName, accountName, accountKey } or { containerName, connectionString }Azure Blob Storage.

Every driver's SDK dependency (@aws-sdk/*, @google-cloud/storage, @azure/storage-blob) is an optional peer dependency, loaded lazily only for the driver names actually present in your disks config — see Installation.

Need something not listed here (Azure Table Storage, an in-house object store, FTP, ...)? See Custom Drivers.

Released under the MIT License.