Configuration

vx-core reads a single server config file. The root message is ServerConfig in protos/proto/vx/server.proto.

Config format

Configs are protobuf messages, serialized as either:

Binary protobuf — compact; used internally in some paths
ProtoJSON — human-readable JSON; use this for hand-edited files

Typed protocol and transport settings use google.protobuf.Any. In JSON, set @type to the message’s type URL:

{
  "@type": "type.googleapis.com/vx.proxy.trojan.TrojanServerConfig",
  "users": [{ "secret": "your-password" }]
}

Field names in JSON use camelCase (for example matchAll, outboundTag, multiInbounds).

ServerConfig overview

Field	Type	Purpose
`inbounds`	`ProxyInboundConfig[]`	Single-protocol listeners
`multiInbounds`	`MultiProxyInboundConfig[]`	Multi-protocol listeners (TLS/REALITY + transport matrix)
`outbounds`	`OutboundHandlerConfig[]`	Where traffic is sent (direct, proxy, block, …)
`router`	`RouterConfig`	Rules that pick an outbound or selector per connection
`dns`	`DnsConfig`	DNS servers, resolvers, hijack, static records
`geo`	`GeoConfig`	Domain/IP/app sets used by routing and DNS
`policy`	`PolicyConfig`	Timeouts and per-level buffer limits
`log`	`LoggerConfig`	Log level, file path, redaction
`users`	`UserConfig[]`	Global users (also attachable per inbound)
`dispatcher`	`DispatcherConfig`	Sniffing and destination override
`dialerFactory`	`DialerFactoryConfig`	Outbound dial timeouts and resolver binding

Minimal server example:

{
  "inbounds": [
    {
      "tag": "trojan",
      "ports": [443],
      "protocol": {
        "@type": "type.googleapis.com/vx.proxy.trojan.TrojanServerConfig"
      }
    }
  ],
  "router": {
    "rules": [{ "matchAll": true, "outboundTag": "direct" }]
  },
  "outbounds": [
    {
      "tag": "direct",
      "protocol": {
        "@type": "type.googleapis.com/vx.proxy.freedom.FreedomConfig"
      }
    }
  ]
}

Sections

Inbounds

ProxyInboundConfig and MultiProxyInboundConfig

Outbounds

OutboundHandlerConfig and protocol Any

Router

RuleConfig, conditions, selectors, fallbacks

DNS

Servers, resolvers, hijack, fake DNS

Geo

Domain/IP/app sets for rules

Policy

Timeouts and buffer sizes

Log

LoggerConfig

Users

UserConfig

Dispatcher

Sniffing and session stats

Dialer factory

Dial timeouts and device binding

Proxy protocols

VMess, VLESS, Trojan, Shadowsocks, …

Transport

TCP, WebSocket, gRPC, KCP, xhttp, socket

Security

TLS and REALITY

CLI

vx run --config config.json

Flag	Default	Description
`--config`	`config.json`	Path to the config file

When installed via the install script, the default path is /usr/local/etc/vx/config.json.

Proto sources

Area	Proto path
Root	`protos/proto/vx/server.proto`
Inbounds	`protos/proto/vx/inbound/inbound.proto`
Outbounds	`protos/proto/vx/outbound/outbound.proto`
Router	`protos/proto/vx/router/router.proto`
DNS	`protos/proto/vx/dns/dns.proto`
Geo	`protos/proto/vx/geo/geo.proto`
Policy	`protos/proto/vx/policy.proto`
Log	`protos/proto/vx/log/logger.proto`
Users	`protos/proto/vx/user/user.proto`
Dispatcher	`protos/proto/vx/dispatcher/dispatcher.proto`
Dialer factory	`protos/proto/vx/dialerfactory/dialerfactory.proto`
Proxy protocols	`protos/proto/vx/proxy/*/` — docs
Transport	`protos/proto/vx/transport/` — docs
Security (TLS/REALITY)	`protos/proto/vx/transport/security/` — docs