<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Getting Started - Ruzor Documentation</title>
<meta name="description" content="Install Ruzor from Cargo or GitHub releases, build from source, and run the first local Pyzor-compatible server.">
<meta name="author" content="Bonjour Services">
<meta name="keywords" content="Ruzor, Pyzor, Rust, spam detection, UDP, email filtering, GPL-3.0, public.ruzor.org, public.pyzor.org">
<meta name="robots" content="index, follow">
<meta name="theme-color" content="#D4FF00">
<link rel="canonical" href="https://docs.ruzor.org/getting-started.html">
<meta property="og:type" content="article">
<meta property="og:site_name" content="Ruzor Documentation">
<meta property="og:title" content="Getting Started - Ruzor Documentation">
<meta property="og:description" content="Install Ruzor from Cargo or GitHub releases, build from source, and run the first local Pyzor-compatible server.">
<meta property="og:url" content="https://docs.ruzor.org/getting-started.html">
<meta property="article:section" content="Install">
<meta property="article:modified_time" content="2026-05-28T00:00:00+00:00">
<meta name="twitter:card" content="summary">
<meta name="twitter:title" content="Getting Started - Ruzor Documentation">
<meta name="twitter:description" content="Install Ruzor from Cargo or GitHub releases, build from source, and run the first local Pyzor-compatible server.">
<script type="application/ld+json">
{
"@context": "https://schema.org",
"@type": "TechArticle",
"headline": "Getting Started - Ruzor Documentation",
"description": "Install Ruzor from Cargo or GitHub releases, build from source, and run the first local Pyzor-compatible server.",
"url": "https://docs.ruzor.org/getting-started.html",
"inLanguage": "en",
"dateModified": "2026-05-28",
"author": {
"@type": "Organization",
"name": "Bonjour Services",
"email": "contact@bonjour.email",
"url": "https://github.com/bonjourservices/ruzor"
},
"publisher": {
"@type": "Organization",
"name": "Bonjour Services",
"email": "contact@bonjour.email"
},
"isPartOf": {
"@type": "TechArticle",
"name": "Ruzor Documentation",
"url": "https://docs.ruzor.org/index.html"
},
"about": [
"Ruzor",
"Pyzor-compatible spam detection",
"Rust command-line utilities",
"UDP email digest checking"
],
"mentions": [
{
"@type": "SoftwareSourceCode",
"name": "Ruzor",
"codeRepository": "https://github.com/bonjourservices/ruzor",
"programmingLanguage": "Rust"
},
{
"@type": "SoftwareApplication",
"name": "ruzor crate",
"url": "https://crates.io/crates/ruzor",
"applicationCategory": "DeveloperApplication"
},
{
"@type": "CreativeWork",
"name": "Upstream Pyzor documentation",
"url": "https://www.pyzor.org/en/latest/"
}
],
"license": "https://www.gnu.org/licenses/gpl-3.0.en.html",
"codeRepository": "https://github.com/bonjourservices/ruzor"
}
</script>
<link rel="stylesheet" href="styles.css">
</head>
<body>
<header class="topbar">
<a class="brand" href="index.html" aria-label="Ruzor documentation home">
<span class="brand-mark">RZ</span>
<span>Ruzor Docs</span>
</a>
<nav class="topnav" aria-label="Primary documentation navigation">
<a class="nav-link " href="index.html">Overview</a>
<a class="nav-link is-active" href="getting-started.html">Install</a>
<a class="nav-link " href="client.html">Client</a>
<a class="nav-link " href="server.html">Server</a>
<a class="nav-link " href="configuration.html">Configuration</a>
<a class="nav-link " href="protocol.html">Protocol</a>
<a class="nav-link " href="integrations.html">Integrations</a>
<a class="nav-link " href="license.html">License</a>
</nav>
</header>
<main>
<section class="hero-band">
<div class="hero-grid">
<p class="eyebrow">Install and build</p>
<h1>Getting Started</h1>
<p class="hero-copy">Rust-native Pyzor-compatible client and server documentation.</p>
</div>
</section>
<div class="doc-layout">
<aside class="side-rail" aria-label="Documentation links">
<span class="side-title">Documentation</span>
<a class="nav-link " href="index.html">Overview</a>
<a class="nav-link is-active" href="getting-started.html">Install</a>
<a class="nav-link " href="client.html">Client</a>
<a class="nav-link " href="server.html">Server</a>
<a class="nav-link " href="configuration.html">Configuration</a>
<a class="nav-link " href="protocol.html">Protocol</a>
<a class="nav-link " href="integrations.html">Integrations</a>
<a class="nav-link " href="license.html">License</a>
</aside>
<article class="doc-content">
<section class="section">
<h2>Install From Cargo</h2>
<p>The default package includes GNU gdbm, Redis, and MySQL backend support. GNU gdbm headers and libraries are required for the default build.</p>
<pre><code>cargo install ruzor --locked</code></pre>
<pre><code># Debian or Ubuntu
sudo apt-get install libgdbm-dev pkg-config
# macOS with Homebrew
brew install gdbm pkg-config</code></pre>
</section>
<section class="section">
<h2>Install Prebuilt Binaries</h2>
<p>GitHub releases publish native archives for Linux x64, macOS arm64, and macOS Intel. Each archive contains <code>ruzor</code>, <code>ruzord</code>, <code>README.md</code>, and <code>LICENSE</code>.</p>
<div class="button-row">
<a class="button" href="https://github.com/bonjourservices/ruzor/releases">GitHub releases</a>
<a class="button secondary" href="https://crates.io/crates/ruzor">Crate package</a>
</div>
</section>
<section class="section">
<h2>Build From Source</h2>
<p>Ruzor uses Rust 2024 and MSRV 1.95. The release profile strips symbols and uses ThinLTO for smaller native binaries.</p>
<pre><code>git clone https://github.com/bonjourservices/ruzor
cd ruzor
cargo build --release --locked</code></pre>
</section>
<section class="section">
<h2>Feature Flags</h2>
<table>
<thead><tr><th>Feature</th><th>Default</th><th>Purpose</th></tr></thead>
<tbody>
<tr><td><code>backend-gdbm</code></td><td>Yes</td><td>GNU gdbm server backend compatible with Python <code>dbm.gnu</code> databases.</td></tr>
<tr><td><code>backend-redis</code></td><td>Yes</td><td>Redis v1 and legacy Redis v0 storage formats.</td></tr>
<tr><td><code>backend-mysql</code></td><td>Yes</td><td>MySQL backend using the upstream Pyzor table layout.</td></tr>
<tr><td><code>backend-gdbm-native</code></td><td>No</td><td>Compatibility alias for the gdbm backend.</td></tr>
</tbody>
</table>
<pre><code>cargo build --release --locked --no-default-features --features backend-gdbm</code></pre>
</section>
<section class="section">
<h2>First Local Run</h2>
<pre><code>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</code></pre>
</section>
</article>
</div>
</main>
<footer class="site-footer">
<div>
<strong>Ruzor documentation</strong>
<span>GPL-3.0-only. Maintained by Bonjour Services.</span>
</div>
<div class="footer-links">
<a href="https://github.com/bonjourservices/ruzor">GitHub</a>
<a href="https://crates.io/crates/ruzor">crates.io</a>
<a href="https://www.pyzor.org/en/latest/">Pyzor docs</a>
<a href="mailto:contact@bonjour.email">contact@bonjour.email</a>
</div>
</footer>
</body>
</html>