Installation

Prerequisites

• Rust (stable toolchain via rustup)
• Linux with systemd for the single-node installer
• FUSE 3 (fusermount3) and access to /dev/fuse
• A mount directory and a data directory

BrewFS FUSE mounting currently supports Linux only. macOS and Windows are not supported mount targets in the current release.

Quick install: Redis + RustFS

The single-node installer downloads BrewFS, Redis, and RustFS, writes their configuration, creates three systemd services, initializes the object bucket, and mounts BrewFS.

curl -fsSL https://raw.githubusercontent.com/brewfs/brewfs/main/scripts/install_brewfs_single_node.sh | sudo bash -s -- install

After installation:

sudo systemctl status brewfs.service brewfs-redis.service brewfs-rustfs.service
brewfs info /mnt/brewfs
cat /mnt/brewfs/.stats

The script also supports status, restart, upgrade, and uninstall. To pin a release, pass BREWFS_VERSION through sudo env:

curl -fsSL https://raw.githubusercontent.com/brewfs/brewfs/main/scripts/install_brewfs_single_node.sh \
  | sudo env BREWFS_VERSION=v0.1.1 bash -s -- install

Build from source

git clone https://github.com/brewfs/brewfs
cd brewfs
cargo build --release

The release binary is produced under target/release/. All examples in these docs use cargo run -p brewfs -- so they work directly from a source checkout.