Config

URL

Floxcore expects the QR code to encode a link in this format:

floxcore://domain.com/path

Floxcore will replace floxcore:// with https:// and download the configuration from your webserver. You may use the path to authenticate individual users.

For example:

floxcore://provider.com/config/64736/67cd9621-bd01-4b64-b51f-9e5c05634069

Headers

When querying your URL, Floxcore will pass you two HTTP headers: X-Device-ID and X-Device-Name.

• X-Device-ID: a short random string. This not guaranteed to be unique and should not be used to identify the user. If you need to identify your individual users, do so in the path of your URL.
• X-Device-Name: the platform used. E.g. iPhone iOS 17.2.1.

Config

Floxcore expects the URL to return valid JSON, wrapping xray-core compatible server configurations in the following format:

{
  "messages": [],
  "account": {
    "expiry_date": "2024-12-31T00:00:00.000000Z"
  },
  "servers": [
    {
      "id": "server-1",
      "name": "Best Server",
      "country": "BE",
      "lat": 50.8504,
      "lon": 4.3518,
      "type": "xray-core",
      "xray_version_min": "1.8.0",
      "xray_version_max": null,
      "configuration": {
        // insert xray-core configuration JSON here
      },
      {        
      "id": "server-2",
      "name": "Even Better Server",
      "country": "BE",
      "lat": 50.8504,
      "lon": 4.3518,
      "type": "xray-core",
      "xray_version_min": "1.8.0",
      "xray_version_max": null,
      "configuration": {
        // insert xray-core configuration JSON here
      }
  ]
}

Inbounds

An inbounds section must be present in the xray-core config. Floxcore will replace the settings, listen, port, and tag entries of the inbound object.