Configuration

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

Configuration format

The configuration is a protobuf message that can be serialized as:

Binary protobuf — Compact; used in some internal paths
ProtoJSON — Human-readable JSON; suitable for manual editing

Typed settings for protocols and transports use google.protobuf.Any. In JSON, set @type to the message type URL:

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

JSON field names use camelCase (e.g. matchAll, outboundTag, multiInbounds).

ServerConfig overview

inbounds

ProxyInboundConfig[]

Inbounds

multiInbounds

MultiProxyInboundConfig[]

Multi-inbounds

outbounds

OutboundHandlerConfig[]

Outbounds

router

RouterConfig

Routing configuration

dns

DnsConfig

DNS configuration

geo

GeoConfig

Sets

policy

PolicyConfig

Timeout policy

log

LoggerConfig

Logging settings

users

UserConfig[]

Users

dispatcher

DispatcherConfig

Dispatcher

dialerFactory

DialerFactoryConfig

Outbound factory

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"
      }
    }
  ]
}