Subscription Format

Xray Checker supports five different formats for proxy configuration. Use the environment variable SUBSCRIPTION_URL for setup.

For information about how proxies are verified, see check methods.

1. Subscription URL (Default)

Standard subscription URL returning Base64 encoded list of proxy links.

Example:

SUBSCRIPTION_URL=https://example.com/subscription

Requirements:

• HTTPS URL
• Returns Base64 encoded content
• Content is newline-separated proxy URLs
• Supports standard User-Agent headers

Headers sent:

Accept: */*
User-Agent: Xray-Checker

2. Base64 String

Direct Base64 encoded string containing proxy configuration links.

Example:

SUBSCRIPTION_URL=dmxlc3M6Ly91dWlkQGV4YW1wbGUuY29tOjQ0MyVlbmNyeXB0aW9uPW5vbmUmc2VjdXJpdHk9dGxzI3Byb3h5MQ==

Content format (before encoding):

vless://uuid@example.com:443?encryption=none&security=tls#proxy1
trojan://password@example.com:443?security=tls#proxy2
vmess://base64encodedconfig
ss://base64encodedconfig

3. V2Ray JSON File

Single JSON configuration file in V2Ray/Xray format.

Example:

SUBSCRIPTION_URL=file:///path/to/config.json

File format:

{
  "outbounds": [
    {
      "protocol": "vless",
      "settings": {
        "vnext": [
          {
            "address": "example.com",
            "port": 443,
            "users": [
              {
                "id": "uuid",
                "encryption": "none"
              }
            ]
          }
        ]
      },
      "streamSettings": {
        "network": "tcp",
        "security": "tls"
      }
    }
  ]
}

4. Xray JSON Array (Multi-config)

JSON array containing multiple Xray configurations with remarks. This format is useful when exporting configurations from GUI clients or managing multiple named configurations in a single file.

Example:

SUBSCRIPTION_URL=file:///path/to/configs.json

File format:

[
  {
    "remarks": "US Server 1",
    "outbounds": [
      {
        "protocol": "vless",
        "settings": {
          "vnext": [
            {
              "address": "us1.example.com",
              "port": 443,
              "users": [{ "id": "uuid-1", "encryption": "none" }]
            }
          ]
        },
        "streamSettings": { "network": "tcp", "security": "tls" }
      }
    ]
  },
  {
    "remarks": "EU Server 1",
    "outbounds": [
      {
        "protocol": "trojan",
        "settings": {
          "servers": [
            {
              "address": "eu1.example.com",
              "port": 443,
              "password": "password123"
            }
          ]
        },
        "streamSettings": { "network": "tcp", "security": "tls" }
      }
    ]
  }
]

The remarks field from each configuration will be used as the proxy name in the dashboard.

5. Configuration Folder

Directory containing multiple V2Ray/Xray JSON configuration files.

Example:

SUBSCRIPTION_URL=folder:///path/to/configs

Requirements:

• Directory must contain .json files
• Each file follows V2Ray JSON format
• Files are processed in alphabetical order
• Invalid files are skipped with warning