Skip to content

kutovoys/xray-checker

Xray Checker

GitHub Release GitHub Actions Workflow Status DockerHub Documentation GitHub License ru en

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.

Dashboard Screenshot

🚀 Key Features

  • 🔍 Monitoring of Xray proxy servers (VLESS, VMess, Trojan, Shadowsocks)
  • 🔄 Automatic configuration updates from subscription
  • 📊 Prometheus metrics export
  • 🌓 Web interface with dark/light theme
  • 📥 Endpoints for monitoring system integration
  • 🔒 Basic Auth protection for metrics and web interface
  • 🐳 Docker and Docker Compose support
  • 📝 Flexible configuration loading:
    • URL-subscription
    • Base64-strings
    • JSON-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

Star History Chart

🤝 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