Documentation hub

Everything you need to deploy and validate Volans.

Quick access to technical docs, API references, and testing guidance.

Repo documentation

  • Architecture and component diagrams.
  • Firewall, VPN, routing implementation notes.
  • Testing playbooks and attack simulations.

Core references

Start here for onboarding and operator enablement.

Quick start

Build and run the daemon, CLI, and Web UI with the default configs.

API guide

REST endpoints for routing, firewall, VPN, DHCP/DNS, HA, and QoS.

Testing

Docker-based integration, automation scripts, and attack suite.

Security posture

Sysctl hardening, rate limiting, and authentication options.

Operational checklists

Standardize review and launch readiness with structured steps.

Build

CI validation

Go toolchain, linting, unit tests, and coverage reporting.

Deploy

Package strategy

Docker builds for Alpine/Debian/Devuan environments.

Operate

Runbook

Health checks, logs, configuration persistence, and rollback plans.