Skip to content
Xray Checker

Quick Start

Get Xray Checker up and running in minutes with these simple steps.

Prerequisites

  • Subscription URL for your proxies
  • Docker (optional, for container deployment)
  • Prometheus (optional, for metrics collection)

5-Minute Setup

  1. Pull the image:
Terminal window
docker pull kutovoys/xray-checker
  1. Run with basic configuration:
Terminal window
docker run -d \
  -e SUBSCRIPTION_URL=https://your-subscription-url/sub \
  -p 2112:2112 \
  kutovoys/xray-checker
  1. Check the status:
Terminal window
curl http://localhost:2112/health

Using Binary

  1. Download the latest release:
Terminal window
curl -Lo xray-checker https://github.com/kutovoys/xray-checker/releases/latest/download/xray-checker_linux_amd64
chmod +x xray-checker
  1. Run with basic configuration:
Terminal window
./xray-checker --subscription-url="https://your-subscription-url/sub"

Verify Installation

  1. Open web interface:

    • Navigate to http://localhost:2112
    • You should see the dashboard with proxy status

  2. Check metrics:

    • Navigate to http://localhost:2112/metrics
    • You should see Prometheus metrics

  3. Verify proxy status:

    • Click on any proxy link in the web interface
    • Check the status endpoint response

Next Steps

  1. Configure Prometheus:
scrape_configs:
  - job_name: "xray-checker"
    static_configs:
      - targets: ["localhost:2112"]

  1. Set up Uptime Kuma:

    • Add new monitor
    • Use proxy-specific endpoints
    • Configure alerts

  2. Customize configuration:

    • Adjust check intervals
    • Configure authentication
    • Set up metric pushing

Common Commands

Check version:

Terminal window
./xray-checker --version

Run single check:

Terminal window
./xray-checker --subscription-url="https://your-sub-url" --run-once

Enable authentication:

Terminal window
./xray-checker --subscription-url="https://your-sub-url" \
  --metrics-protected=true \
  --metrics-username=user \
  --metrics-password=pass

Troubleshooting

  1. Check service status:
Terminal window
curl http://localhost:2112/health
  1. View logs:
Terminal window
docker logs xray-checker
  1. Verify metrics:
Terminal window
curl http://localhost:2112/metrics

Need Help?

  • Check the full documentation
  • Open an issue on GitHub
  • Join the community discussions