VXVX Docs

Inbounds

ProxyInboundConfig and MultiProxyInboundConfig

Inbound configuration lives in ServerConfig.inbounds and ServerConfig.multiInbounds.

Schema definition: protos/proto/vx/inbound/inbound.proto.

ProxyInboundConfig

A standard inbound. You can specify multiple proxy protocols, but only one transport protocol and one security protocol may be active.

tag
string

Name referenced by router inboundTags

address
string

Listen address; empty means all interfaces

port
uint32

Single port (can be set alongside ports)

ports
uint32[]

List of ports to listen on

transport

TLS, REALITY, WebSocket, gRPC, etc.

protocol
Any

One proxy server configuration (VMess, VLESS, Trojan, etc.)

protocols
Any[]

Multiple protocols on the same listener

users

Users for this inbound (see Users)

Example:

{
  "tag": "vmess",
  "ports": [10000],
  "protocol": {
    "@type": "type.googleapis.com/vx.proxy.vmess.VmessServerConfig",
    "secureEncryptionOnly": true
  }
}

Protocol @type values are listed in Proxy protocols. Transport and TLS/REALITY: Transport, Security.

Note: When multiple protocols support UDP, only one protocol's UDP will actually take effect. If Hysteria is present, it is preferred and UDP for other protocols will not be enabled.

MultiProxyInboundConfig

Multi-inbounds can use multiple transport and security configurations simultaneously.

tag
string

Inbound tag for routing

address
string

Listen address; empty means all interfaces

ports
uint32[]

Listen ports

protocols
Any[]

Proxy protocol configurations (same Any type as above)

securityConfigs

Security protocols

transportProtocols

Transport protocols

socket

Socket options

users

Users for all handlers on this inbound

Security

Each entry in securityConfigs

Only one of tls or reality may be set per security block.

domains
string[]

Use this security configuration for the specified SNI

regularExpression
string

Use this security configuration for SNI matching this regular expression

always
bool

Use this security configuration for all connections

Transport protocol

Each entry in transportProtocols

Only one of websocket, http, grpc, httpupgrade, splithttp, or tcp may be set per transport block.

websocket

WebSocket transport. See WebSocket.

http

HTTP/2 transport camouflage. See HTTP transport.

grpc

gRPC transport. See gRPC.

httpupgrade

HTTP Upgrade transport. See HTTPUpgrade.

splithttp

Split HTTP (XHTTP) transport. See SplitHTTP.

tcp

Plain TCP transport. See TCP.

alpn
string

Match ALPN

sni
string

Match connection SNI

path
string

HTTP/1 path

h2
bool

Connection uses HTTP/2

always
bool

Use this transport for all connections

Field details are in Transport and Security.

Comments