Proxy Checker

Proxy Checker is a tool for monitoring proxy server availability with support for VLESS, VMess, Trojan, Shadowsocks, and WireGuard protocols. It supports both Xray Core and sing-box backends, automatically tests connections and provides metrics for Prometheus, as well as API endpoints for integration with monitoring systems.

Tip

Try the Live Demo: See Xray Checker in action at demo-xray-checker.kutovoy.dev

🚀 Key Features

• 🔍 Monitoring of proxy servers (VLESS, VMess, Trojan, Shadowsocks, WireGuard)
• ⚡ Dual backend support: Xray Core and sing-box
• 🔄 Automatic configuration updates from subscription (multiple subscriptions supported)
• 📊 Prometheus metrics export with Pushgateway support
• 🌐 REST API with OpenAPI/Swagger documentation
• 🌓 Web interface with dark/light theme
• 🎨 Full web customization (custom logo, styles, or entire template)
• 📄 Public status page for VPN services (no authentication required)
• 📥 Endpoints for monitoring system integration (Uptime Kuma, etc.)
• 🔒 Basic Auth protection for metrics and web interface
• 🐳 Docker and Docker Compose support
• 📝 Flexible configuration loading:
  • URL subscriptions (base64, JSON)
  • Share links (vless://, vmess://, trojan://, ss://)
  • WireGuard config files (.conf)
  • JSON configuration files
  • Folders with configurations

Full list of features available in the documentation.

🚀 Quick Start

Docker

# Using Xray backend (default)
docker run -d \
  -e SUBSCRIPTION_URL=https://your-subscription-url/sub \
  -p 2112:2112 \
  kutovoys/xray-checker

# Using sing-box backend
docker run -d \
  -e BACKEND=singbox \
  -e SUBSCRIPTION_URL=https://your-subscription-url/sub \
  -p 2112:2112 \
  kutovoys/xray-checker

# With WireGuard configs
docker run -d \
  -e WIREGUARD_CONFIG=/app/wireguard \
  -v ./wireguard:/app/wireguard:ro \
  -p 2112:2112 \
  kutovoys/xray-checker

Docker Compose

services:
  proxy-checker:
    image: kutovoys/xray-checker
    environment:
      - BACKEND=xray                    # or singbox
      - SUBSCRIPTION_URL=https://your-subscription-url/sub
      - WIREGUARD_CONFIG=/app/wireguard # optional
    volumes:
      - ./wireguard:/app/wireguard:ro   # optional: WireGuard configs
    ports:
      - "2112:2112"

Configuration Options

Environment Variable	Description	Default
BACKEND	Proxy backend: xray or singbox	xray
SUBSCRIPTION_URL	Subscription URL(s), comma-separated	-
WIREGUARD_CONFIG	WireGuard config path(s), comma-separated	-
PROXY_CHECK_INTERVAL	Check interval in seconds	300
PROXY_CHECK_METHOD	Check method: ip, status, download	ip
METRICS_PROTECTED	Enable basic auth	false

See .env.example for all configuration options.

Detailed installation and configuration documentation is available at xray-checker.kutovoy.dev

📈 Project Statistics

🤝 Contributing

We welcome any contributions to Xray Checker! If you want to help:

1. Fork the repository
2. Create a branch for your changes
3. Make and test your changes
4. Create a Pull Request

For more details on how to contribute, read the contributor's guide.

Thanks to the all contributors who have helped improve Xray Checker:

Made with contrib.rocks

VPN Recommendation

For secure and reliable internet access, we recommend BlancVPN. Use promo code KLUGSCL for 15% off your subscription.