Skip to content

Installation

This section covers the prerequisites for building the sniffer and the commands needed to preview the HTML documentation locally.

Build the Sniffer

Use the project build guide in the repo root for the full build flow for the ACDI Sniffer:

  • BUILD.md

The shortest Linux path is:

./scripts/build.sh release

Expected binary:

build/pqc-sniffer

Prerequisites

Typical Ubuntu or Debian packages:

sudo apt-get update
sudo apt-get install -y build-essential cmake pkg-config libpcap-dev libpq-dev libpqxx-dev python3 python3-pip git
python3 -m pip install --user conan
conan profile detect --force

Preview the Docs Site Locally

& "C:\Program Files\Python312\python.exe" -m pip install --user -r docs-requirements.txt
& "C:\Program Files\Python312\python.exe" -m mkdocs serve

python3 -m pip install --user -r docs-requirements.txt
python3 -m mkdocs serve

Install the docs dependencies:

python3 -m pip install --user -r docs-requirements.txt

Start a local preview server:

mkdocs serve

Build static HTML files:

mkdocs build

Generated output:

site/
  1. Author or update content in site-docs/.
  2. Preview the site locally with mkdocs serve.
  3. Build static HTML with mkdocs build.
  4. Publish the generated site/ directory to your web host.

Scope of This Site

This docs site is intentionally focused on offline mode only. It does not document:

  • PostgreSQL-connected deployments
  • Quantum Command ingest
  • database-backed telemetry workflows