⚠️ Caution: This project is under active development! ⚠️

Compass VPN Agent

Read the complete guide on our website.

Features

Read Here.

Requirements

Read Here.

How to run

1. Setup Agent

Follow this tutorial to get the Compass VPN Agent running.

2. Setup Manager

Follow this tutorial to create a manager.

Ensure you obtain the authentication values from the manager setup. These values will be required to be included in the env_file of the agent.

Commands

Bootstrap: (first time)

./bootstrap.sh

Rebuild and restart all services:

./restart.sh

Start the Panel

./start_panel.sh

View Configuration Links:

./show_configs.sh

Check & Update:

./check_update.sh

Show Logs:

./logs.sh

Services

xray-config

Creates config.json, monitors configurations, and export Xray configurations via /metrics path.

xray

Reads config.json from the xray-config service and runs the Xray-core.

v2ray-exporter

Exports V2Ray/Xray configuration metrics.

node-exporter

Prometheus Node Exporter that collects all critical metrics of the agent machine.

nginx

NGINX webserver to manage Xray inbounds and fallbacks, enhancing both performance and security.

metric-forwarder

Reads metrics from xray-config, node-exporter, and v2ray-exporter services and pushes them to a remote manager Pushgateway service or Grafana Cloud Prometheus endpoint.

fail2ban

Protects the server against brute force attacks by monitoring logs and automatically blocking suspicious IPs.

user-metrics

Tracks approximate active unique users across all configured inbounds and monitors blocked requests due to junk traffic, providing insights into bandwidth optimization.