Apranik

VLESS ​

A UUID, a command and a destination, then raw payload: TCP, and UDP framed inside the stream, plain or as XUDP. A request from an unknown user can go to the inbound's fallback.

WARNING

VLESS does not encrypt. Run it over tls, or the UUID and all traffic cross the wire in the clear.

Not built yet: flow (XTLS Vision), TCP over Mux, plain Mux.Cool UDP, reverse proxy and VLESS encryption. A known user asking for one is refused.

Structure ​

json
{
  "tag": "vless-in",
  "listen": "0.0.0.0",
  "port": 443,
  "transport": [
    { "type": "tcp" },
    {
      "type": "tls",
      "settings": {
        "certificates": [
          {
            "certificate_file": "/etc/apranik/cert.pem",
            "key_file": "/etc/apranik/key.pem"
          }
        ]
      }
    }
  ],
  "protocol": {
    "type": "vless",
    "settings": {
      "users": [
        { "name": "alice", "uuid": "b831381d-6324-4d53-ad4f-8cda48b30811" }
      ],
      "handshake_timeout": "10s"
    }
  },
  "fallback": { "server": "127.0.0.1", "server_port": 8080 }
}

Inbound fields ​

users ​

list of usersRequired

At least one, each with a name and a unique uuid. The name is Apranik's own, for routing, statistics and logs. See Users.

handshake_timeout ​

durationDefault: 10s

How long a client may take to send its request.

Outbound fields ​

uuid ​

stringRequired

The user's UUID.

A uuid is read as Xray and sing-box read it: a UUID, with or without dashes, or 1 to 30 bytes of text turned into a version 5 UUID.

UDP ​

  • XUDP, the default: one stream carries a UDP session's datagrams to every destination. Set by muxcool.
  • Plain UDP, with "muxcool": { "udp": { "enabled": false } }: one stream per destination, for servers without Mux.Cool.

NOTE

An Xray client with mux.enabled and no xudpConcurrency puts TCP and UDP in one Mux connection, which an Apranik inbound refuses. Set "concurrency": -1 and a positive xudpConcurrency on the client.