Documentation

Find every Zedmos answer without leaving the CLI.

Architecture diagrams, performance notes, and operational runbooks are indexed below. Search anything—from JA4 blocking to TLS proxy tuning—and jump straight to the right guide.

150+curated articles
12deployment blueprints
< 2 minmedian search-to-answer

Getting started

Install Zedmos, license the engine, and verify inline capture in minutes.

Jump to section →
  • Install on OPNsense 24.7

    Step-by-step install, repo keys, and service validation checks.

    Open
  • License & activation

    Bring-your-own license flow plus offline activation CLI.

    Open
  • Sanity tests

    Run capture diagnostics and packet echo before enabling policies.

    Open

Architecture

Dive into the packet path, DPI layers, and policy runtime internals.

Jump to section →
  • Packet path diagram

    From NIC rings to writerd queues — every hop explained.

    Open
  • Policy runtime

    Suffix tries, TLS metadata, and synchronous enforcement design.

    Open
  • Writerd log plane

    SQLite, Elastic, and Mongo targets with batching semantics.

    Open

Performance & tuning

Benchmarks, recommended BIOS flags, and profiling recipes.

Jump to section →
  • 10G inline benchmark

    Test harness, traffic mix, and reproduction notes.

    Open
  • Latency budgets

    How Zedmos keeps p95 under 1ms with TLS MITM enabled.

    Open
  • CPU pinning guide

    DG_PER_QUEUE, worker affinity, and NUMA-aware tuning.

    Open

Deployment & operations

Bootstrap production, automate policy delivery, and monitor health.

Jump to section →
  • Inline bridge mode

    Interface prep, takeover plans, and rollback instructions.

    Open
  • Routed mode

    Multi-interface flow, takeover lists, and TLS redirect rules.

    Open
  • Observability

    Metrics endpoints, Prometheus exporters, and alerting hooks.

    Open

API & automation

Control plane RPC, policy exports, and integration blueprints.

Jump to section →
  • gRPC control plane

    UNIX socket schema plus example clients in Go and Python.

    Open
  • Policy export format

    JSON schema for policies.json and how to version it.

    Open
  • Automation playbooks

    CI/CD hooks to roll policy updates with zero packet loss.

    Open

Architecture poster

Inline pipeline reference

A printable poster that walks through NIC capture, DPI layers, policy evaluation, and writerd persistence without any mystery hops.

  • Netmap zero-copy diagram
  • TLS MITM control flow
  • Writerd batching timeline
Download packet-path PDF

Performance methodology

Reproduce Zedmos benchmarks

Every throughput, latency, and CPU number published on the landing page is sourced from this methodology. Clone the test harness, capture your own traces, and compare results apples-to-apples.

Deployment playbooks

Ship Zedmos with predictable change windows

Use the change templates, GARP checklists, and takeover rehearsals to deploy without packet loss. Each playbook lists owners, timings, and rollback triggers.

Inline bridge mode

Interface prep, takeover plans, and rollback instructions.

Open playbook →

Routed mode

Multi-interface flow, takeover lists, and TLS redirect rules.

Open playbook →

Observability

Metrics endpoints, Prometheus exporters, and alerting hooks.

Open playbook →

Release notes

Track the evolution of the engine

r2025.062025-06-18
  • Introduced TLS cert cache eviction telemetry.
  • Added CPU pinning helper to deployment CLI.
r2025.032025-03-02
  • Writerd gained Mongo cluster failover support.
  • Policy runtime can stream suffix trie stats.
r2024.122024-12-11
  • Netmap routed mode auto-discovers takeover lists.
  • New CLI to diff policies.json exports before deploy.

Need a human?

Direct lines to the engineering team

Whether you are planning a migration or debugging a policy edge case, you can escalate straight to the people who build and run Zedmos.

Incident desk

24/7 pager for inline outages and emergency bypass.

Contact →

Architecture clinic

Book 30 minutes with the engine team for design reviews.

Contact →

Community

Discuss roadmaps and share playbooks with other operators.

Contact →