Documentation
Sentrazone is a self-hosted control plane for managing private VPN infrastructure. This documentation covers deployment, configuration, and API usage.
Quick start
The fastest path to a running Sentrazone instance is Docker Compose. The stack runs on a single server and includes the control plane, reverse proxy, and VPN server management.
- Clone the repository and copy the environment file.
- Configure your secrets in
.env. - Run
docker compose up -d. - Access the dashboard at your domain.
For a detailed walkthrough including DNS configuration and firewall rules, see the Setup Guide.
Architecture
Sentrazone consists of two binaries: the control plane and the agent.
- Control plane — Serves the dashboard, stores history in SQLite, and manages authentication. Exposes a REST API and a WebSocket endpoint for live metrics.
- Agent — Runs on each VPN node. Collects interface metrics every 10 seconds and reports them to the control plane over an authenticated HTTP channel.
In the default Docker Compose setup, all components run on a single host. Agents can also run on separate machines and report back over the public internet using the agent token.