Install Guide

Desktop (Tauri)

If your platform is not listed in Releases, build from source:

cd apps/desktop
bun install
bun run tauri build

CLI

Release binaries are on GitHub Releases. To build locally:

cargo build -p zann-cli

The binary is at target/debug/zann (or target/release/zann with --release).

Server (Docker Compose, local dev)

git clone https://github.com/constXife/zann
cd zann
cp .env.example .env
# edit .env: set ZANN_PASSWORD_PEPPER and ZANN_TOKEN_PEPPER
# (openssl rand -base64 32)
docker compose up -d

This uses config/dev.yaml. The shared-vault master key is generated into ./data/smk on first start (mode auto_generate); back that file up. No secret values ship in the repo.

Server (prebuilt image)

docker pull constxife/zann-server:latest

Server config (self-hosted)

Start from config/config.example.yaml and supply required secrets via env:

• ZANN_PASSWORD_PEPPER
• ZANN_TOKEN_PEPPER
• ZANN_SMK or ZANN_SMK_FILE / server.master_key_file (shared vault master key; the server rejects the historically committed public dev key)
• ZANN_CONFIG_PATH (path to your config file)

The config file controls auth mode, OIDC settings, policies, and metrics.

First user access

For local dev, config/dev.yaml sets auth.internal.registration: open. For production, consider invite_only and create invites from an admin account.