Getting started

Two paths, depending on what you're here for:

🚀 I want to run Riptide

Deploy the published image or jar — no build toolchain needed.

• Docker Compose — full stack (Riptide + ClickHouse + UI + Grafana) in one docker compose up
• Plain JAR — java -jar with file- or env-var-based configuration
• DEB / RPM packages — apt/dnf install with a managed systemd service
• NixOS — flake package plus a services.riptide module
• Operations notes — image tags, restarts, upgrades

🛠 I want to work on Riptide

Build from source, debug locally, send a pull request.

• Environment — clone, make, IDE setup
• Run & debug — Riptide under a debugger with real flow traffic (pcap replay, nl6 simulator)
• Testing — unit / e2e / full-mode tiers
• Pull requests — quality gates, DCO, commit conventions

Both paths share the configuration reference — receivers, SNMP agents, secret references, and ClickHouse.