BrewFSBrewFS
BrewFSBrewFS
Get started
Quick StartInstallationMount BrewFSConfigurationPerformance tuning parametersCLI Reference
Getting Started

Mount BrewFS

Mount with LocalFS + SQLite, or S3-compatible storage + Redis.

BrewFS separates the data backend (where object blocks live) from the metadata backend (where the namespace and slice metadata live). Any combination can be mounted.

LocalFS + SQLite

The simplest single-machine setup:

mkdir -p /tmp/brewfs-mnt /tmp/brewfs-data

cargo run -p brewfs -- mount /tmp/brewfs-mnt \
  --data-backend local-fs \
  --data-dir     /tmp/brewfs-data \
  --meta-backend sqlx \
  --meta-url     sqlite:///tmp/brewfs-meta.db

S3-compatible + Redis

Object storage for data, Redis for low-latency metadata:

cargo run -p brewfs -- mount /mnt/brewfs \
  --data-backend s3 \
  --s3-bucket  brewfs-data \
  --s3-endpoint http://127.0.0.1:9000 \
  --meta-backend redis \
  --meta-url     redis://127.0.0.1:6379/0

Works with MinIO, RustFS, Ceph RGW, AWS S3, and other S3-compatible services.

Unmount

fusermount3 -u /tmp/brewfs-mnt
# or, when mounted as root
sudo umount /tmp/brewfs-mnt

Installation

Install a Redis + RustFS single-node stack or build BrewFS from source.

Configuration

Data backends, metadata backends, and mount options.

On this page

LocalFS + SQLiteS3-compatible + RedisUnmount