Getting Started - Ruzor Documentation

Install From Cargo

The default package includes GNU gdbm, Redis, and MySQL backend support. GNU gdbm headers and libraries are required for the default build.

cargo install ruzor --locked

# Debian or Ubuntu
sudo apt-get install libgdbm-dev pkg-config

# macOS with Homebrew
brew install gdbm pkg-config

Install Prebuilt Binaries

GitHub releases publish native archives for Linux x64, macOS arm64, and macOS Intel. Each archive contains ruzor, ruzord, README.md, and LICENSE.

GitHub releases Crate package

Build From Source

Ruzor uses Rust 2024 and MSRV 1.95. The release profile strips symbols and uses ThinLTO for smaller native binaries.

git clone https://github.com/bonjourservices/ruzor
cd ruzor
cargo build --release --locked

Feature Flags

Feature	Default	Purpose
`backend-gdbm`	Yes	GNU gdbm server backend compatible with Python `dbm.gnu` databases.
`backend-redis`	Yes	Redis v1 and legacy Redis v0 storage formats.
`backend-mysql`	Yes	MySQL backend using the upstream Pyzor table layout.
`backend-gdbm-native`	No	Compatibility alias for the gdbm backend.

cargo build --release --locked --no-default-features --features backend-gdbm

First Local Run

cat > /tmp/ruzor-msg.eml <<'EOF'
From: a@example.com
To: b@example.com
Subject: test

hello ruzor
EOF

ruzor digest < /tmp/ruzor-msg.eml
mkdir -p /tmp/ruzor-server /tmp/ruzor-client
printf '%s\n' 127.0.0.1:24441 > /tmp/ruzor-client/servers
ruzord --homedir /tmp/ruzor-server -a 127.0.0.1 -p 24441