Is xray-checker free to use?

xray-checker is open source under the AGPL-3.0 licence. There is no licence fee and no seat count — you can self-host it or, where the project offers one, pay a vendor for a managed version instead.

What does xray-checker do?

Xray Checker: A Prometheus exporter for monitoring Xray proxies

What is xray-checker written in?

xray-checker is primarily written in Go. Its source is publicly available at https://github.com/kutovoys/xray-checker, and it has 904 GitHub stars.

xray-checker: Open Source Monitoring & Observability

xray-checker is a free, open source monitoring & observability project written in Go and released under AGPL-3.0. It has 904 GitHub stars, 88 forks and 20 open issues, and was last pushed 8 days ago. On this registry it ranks #233 of 271 tracked projects in Monitoring & Observability, with 5 head-to-head comparisons available.

Xray Checker

Xray Checker is a tool for monitoring proxy server availability with support for VLESS, VMess, Trojan, and Shadowsocks protocols. It automatically tests connections through Xray Core 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 Xray proxy servers (VLESS, VMess, Trojan, Shadowsocks)
🔄 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
🌍 Automatic geo files management (geoip.dat, geosite.dat)
📝 Flexible configuration loading:
- URL subscriptions (base64, JSON)
- Share links (vless://, vmess://, trojan://, ss://)
- JSON configuration files
- Folders with configurations

Full list of features available in the documentation.

🚀 Quick Start

Docker

docker run -d \
  -e SUBSCRIPTION_URL=https://your-subscription-url/sub \
  -p 2112:2112 \
  kutovoys/xray-checker

Docker Compose

services:
  xray-checker:
    image: kutovoys/xray-checker
    environment:
      - SUBSCRIPTION_URL=https://your-subscription-url/sub
    ports:
      - "2112:2112"

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:

Fork the repository
Create a branch for your changes
Make and test your changes
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.