Skip to main content

📦 Installation

🐳 Install via Docker (Recommended for isolated environments & CI)​

Pull the latest official container images:

docker pull ghcr.io/deven96/ahnlich-db:latest  
docker pull ghcr.io/deven96/ahnlich-ai:latest

Run both services locally with default ports (DB → 1369, AI → 1370):

docker run -d --name ahnlich-db -p 1369:1369 ghcr.io/deven96/ahnlich-db:latest

docker run -d \
  --name ahnlich-ai \
  -p 1370:1370 \
  ghcr.io/deven96/ahnlich-ai:latest

For more advanced setups—including tracing, persistence, and model caching—refer to the example docker-compose.yml in the main repository.

Download Pre-built Binaries (Great for local servers & headless deployment)​

You can download OS‑specific binaries (for db and ai) from the Ahnlich GitHub Releases page. GitHub

Example steps for a Linux (x86_64-unknown-linux-gnu) environment:

# Download the "db" binary for your version/platform
wget -L https://github.com/deven96/ahnlich/releases/download/bin%2Fdb%2F0.1.0/x86_64-unknown-linux-gnu-ahnlich-db.tar.gz
Verify it’s a gzip file

Extract the contents
tar -xvzf ahnlich-db.tar.gz

Make the binary executable
chmod +x ahnlich-db

Run the database service
./ahnlich-db

./ahnlich-db --help

Repeat the same for the ahnlich-ai binary, substituting db → ai and the correct filename.

You can find complete download instructions (including Windows / macOS options) in the official repository README. GitHub

Build from Source with Cargo (For developers and Rust contributors)​

Get up-to-date source and compile the binaries natively:

git clone https://github.com/deven96/ahnlich.git
cd ahnlich
cargo build --release --bin ahnlich-db
cargo build --release --bin ahnlich-ai

Once built, find the executables in target/release/. Move them into your $PATH or launch directly:

./target/release/ahnlich-db --help
./target/release/ahnlich-ai --help

This method is ideal for reviewing code, customizing defaults, or staying on the cutting edge. Ensure you have the Rust toolchain installed via rustup.rs. GitHub

✅ Quick Comparison Table​

MethodExternal DependenciesBest ForUpgrade Workflow
DockerDocker onlyIsolated sandbox, CI, testingdocker pull ghcr.io/deven96/ahnlich-*
Official binariesNone (just download tool)Servers without Rust or DockerDownload updated files from Releases
Source (Cargo)Rust toolchainCustom builds, contributionsgit pull && cargo build

🛠️ Post‑Installation Checklist​

  • Add execution permissions: chmod +x <binary>.

  • Ports: ahnlich-db defaults to 1369, ahnlich-ai defaults to 1370. Use --host and --port flags to customize.

  • For upgrades:

    • Docker: pull the :latest tag;

    • Binaries: download again from the releases page;

    • Source: run git pull && cargo build.

🔗 Helpful Links​