Xray Checker

<div align="center">

</div> <div align="center">

</div>

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.

<div align="center"> <img src=".github/screen/xray-checker.webp" alt="Dashboard Screenshot"> </div>

[!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

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

Docker Compose

yamlCopy
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

<a href="https://star-history.com/#kutovoys/xray-checker&Date"> <picture> <source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=kutovoys/xray-checker&type=Date&theme=dark" /> <source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=kutovoys/xray-checker&type=Date" /> <img alt="Star History Chart" src="https://api.star-history.com/svg?repos=kutovoys/xray-checker&type=Date" /> </picture> </a>

🤝 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.

<p align="center"> Thanks to the all contributors who have helped improve Xray Checker: </p> <p align="center"> <a href="https://github.com/kutovoys/xray-checker/graphs/contributors"> <img src="https://contrib.rocks/image?repo=kutovoys/xray-checker" /> </a> </p> <p align="center"> Made with <a rel="noopener noreferrer" target="_blank" href="https://contrib.rocks">contrib.rocks</a> </p>

VPN Recommendation

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