sing-box/docs/configuration/inbound/vmess.md

Structure

{
  "inbounds": [
    {
      "type": "vmess",
      "tag": "vmess-in",
      
      "listen": "::",
      "listen_port": 2080,
      "tcp_fast_open": false,
      "sniff": false,
      "sniff_override_destination": false,
      "domain_strategy": "prefer_ipv6",
      "proxy_protocol": false,

      "users": [
        {
          "name": "sekai",
          "uuid": "bf000d23-0752-40b4-affe-68f7707a9661",
          "alterId": 0
        }
      ],
      "tls": {},
      "transport": {}
    }
  ]
}

VMess Fields

users

==Required==

VMess users.

Alter ID	Description
0	Disable legacy protocol
> 0	Enable legacy protocol

!!! warning ""

Legacy protocol support (VMess MD5 Authentication) is provided for compatibility purposes only, use of alterId > 1 is not recommended.

tls

TLS configuration, see TLS.

transport

V2Ray Transport configuration, see V2Ray Transport.

Listen Fields

listen

==Required==

Listen address.

listen_port

==Required==

Listen port.

tcp_fast_open

Enable tcp fast open for listener.

sniff

Enable sniffing.

See Protocol Sniff for details.

sniff_override_destination

Override the connection destination address with the sniffed domain.

If the domain name is invalid (like tor), this will not work.

domain_strategy

One of prefer_ipv4 prefer_ipv6 ipv4_only ipv6_only.

If set, the requested domain name will be resolved to IP before routing.

If sniff_override_destination is in effect, its value will be taken as a fallback.

proxy_protocol

Parse Proxy Protocol in the connection header.