Everything you need to
deploy and operate LYNX
Production-grade documentation for every layer, every platform, and every operational scenario. All docs are version-controlled alongside the source code.
Quick start
All documentation
Architecture
Full 12-layer pipeline walkthrough — hardware ingestion to SOC alert delivery. Includes thread model, memory budgets, and data flow diagrams.
Layer Implementation Guide
Per-layer implementation notes, key data structures, C API contracts, and the universal hot-path rules every contributor must follow.
Configuration Reference
Complete reference for every configuration option — all 17 sections, all defaults, type annotations, and per-platform profile examples including the full MIPS profile.
Deployment — Linux
Production Linux deployment — kernel isolation parameters, DPDK hugepage setup, NIC IRQ pinning, systemd unit files, Prometheus metrics, and log rotation.
Deployment — Windows
Windows 10 / 11 / Server 2022 deployment — Npcap installation, MSVC build with vcpkg, Windows Service setup via NSSM, Event Log integration.
Deployment — macOS
macOS deployment for Apple Silicon and Intel — BPF permissions via ChmodBPF, Metal GPU acceleration for TinyLlama, launchd service setup.
Deployment — MIPS (Cyberoam)
Step-by-step cross-compilation for Cavium OCTEON MIPS64 — toolchain setup, static libpcap build, SCP deploy to Cyberoam CR1500ia, memory tuning, SysV init script.
Dashboard API Reference
WebSocket protocol specification — all message types, delta format, alert object schema, REST endpoints, authentication, TypeScript type definitions.
Federated Learning
FL server setup, trust model architecture, differential privacy parameters, clustered FedAvg, gradient anomaly detection, node enrollment, rollback procedures.
ML Models
Dataset preparation, XGBoost pre-filter training, ONNX export, TinyLlama QLoRA fine-tuning, Q4_K_M quantization, MIPS C decision tree export, adversarial retraining.
Testing Guide
Unit test framework (CMocka), PCAP regression suite with 11 attack scenarios, benchmark thresholds, CI pipeline setup for all four platforms, coverage requirements.
Security
Full threat model, adversarial assumptions, evasion-resistance design rationale, resource exhaustion mitigations, responsible disclosure policy.
CONTRIBUTING.md
Contributing
Dev setup, code style (C17, Go, TypeScript, Python), PR process, architecture decision records, and the zero-conflict branch ownership map.
SECURITY.md
Security Policy
Full threat model, adversarial assumptions, evasion-resistance rationale per layer, and the responsible disclosure process with contact details.