V2Ray

jsonv5-preview

Schema URL

https://catalog.lintel.tools/schemas/schemastore/v2ray/versions/jsonv5-preview.json
← Back to V2Ray
Type: github:v2fly_v2ray-core_v5_infra_conf_v5cfg:RootConfig

JSON schema for V2Ray jsonv5 configuration format: https://github.com/v2fly/v2ray-core

Definitions

github:EHfive_v2ray-jsonschema_common:CustomDNSDomainMatcher enum
github:EHfive_v2ray-jsonschema_common:CustomFreedomDomainStrategy enum
github:EHfive_v2ray-jsonschema_common:CustomNetworkList string | enum[]
github:EHfive_v2ray-jsonschema_common:CustomPbAny object
typeUrl string
pattern=^types\.v2fly\.org/
value string
github:EHfive_v2ray-jsonschema_common:CustomPortRange integer | string
github:EHfive_v2ray-jsonschema_common:CustomRouterProtocol enum
github:EHfive_v2ray-jsonschema_common:CustomString string
github:EHfive_v2ray-jsonschema_common:CustomStringList string | string[]
github:EHfive_v2ray-jsonschema_v5config:CustomBalancingRule
github:EHfive_v2ray-jsonschema_v5config:CustomInboundConfig
github:EHfive_v2ray-jsonschema_v5config:CustomOutboundConfig
github:EHfive_v2ray-jsonschema_v5config:CustomServices object
backgroundObservatory object
3 nested properties
subjectSelector string[]

@Document The selectors for outbound under observation

probeUrl string
probeInterval integer
browser object

Config is the settings for BrowserForwarder.

2 nested properties
listenAddr string
listenPort integer
burstObservatory object
2 nested properties
subjectSelector string[]

@Document The selectors for outbound under observation

pingConfig object
5 nested properties
destination string

destination url, need 204 for success return default https://connectivitycheck.gstatic.com/generate_204

connectivity string

connectivity check url

interval integer

health check interval, int64 values of time.Duration

samplingCount integer

sampling count is the amount of recent ping results which are kept for calculation

timeout integer

ping timeout, int64 values of time.Duration

commander object
2 nested properties
tag string
name string[]
fakeDns object
2 nested properties
ipPool string
lruSize integer
fakeDnsMulti object
1 nested properties
pools github:v2fly_v2ray-core_v5_app_dns_fakedns:FakeDnsPool[]
instman object
policy object
2 nested properties
level object
system object
2 nested properties
stats object
overrideAccessLogDest boolean
restfulapi object
3 nested properties
listenAddr string
listenPort integer
authToken string
reverse object
2 nested properties
bridgeConfig github:v2fly_v2ray-core_v5_app_reverse:BridgeConfig[]
portalConfig github:v2fly_v2ray-core_v5_app_reverse:PortalConfig[]
stats object
tun object
11 nested properties
name string
mtu integer
userLevel integer
packetEncoding enum
Values: "None" "Packet"
tag string
ips github:v2fly_v2ray-core_v5_app_router_routercommon:CIDR[]
routes github:v2fly_v2ray-core_v5_app_router_routercommon:CIDR[]
enablePromiscuousMode boolean
enableSpoofing boolean
socketSettings object

SocketConfig is options to be applied on network sockets.

14 nested properties
mark integer

Mark of the connection. If non-zero, the value will be set to SO_MARK.

tfo enum

TFO is the state of TFO settings.

Values: "AsIs" "Enable" "Disable"
tproxy enum

TProxy is for enabling TProxy socket option.

Values: "Off" "TProxy" "Redirect"
receiveOriginalDestAddress boolean

ReceiveOriginalDestAddress is for enabling IP_RECVORIGDSTADDR socket option. This option is for UDP only.

bindAddress string | integer[]
bindPort integer
acceptProxyProtocol boolean
tcpKeepAliveInterval integer
tfoQueueLength integer
tcpKeepAliveIdle integer
bindToDevice string
rxBufSize integer
txBufSize integer
forceBufSize boolean
sniffingSettings object
3 nested properties
enabled boolean

Whether or not to enable content sniffing on an inbound connection.

destinationOverride string[]

Override target destination if sniff'ed protocol is in the given list. Supported values are "http", "tls", "fakedns".

metadataOnly boolean

Whether should only try to sniff metadata without waiting for client input. Can be used to support SMTP like protocol where server send the first message.

subscription object

Config is the settings for Subscription Manager.

3 nested properties
imports github:v2fly_v2ray-core_v5_app_subscription:ImportSource[]
nonnativeConverterOverlay string | integer[]
nonnativeConverterOverlayFile string
github:EHfive_v2ray-jsonschema_v5config:CustomStreamSettings
github:EHfive_v2ray-jsonschema_v5config:CustomUTLSImitate enum
github:v2fly_v2ray-core_v5_app_browserforwarder:Config object

Config is the settings for BrowserForwarder.

listenAddr string
listenPort integer
github:v2fly_v2ray-core_v5_app_commander:SimplifiedConfig object
tag string
name string[]
github:v2fly_v2ray-core_v5_app_dns:SimplifiedConfig object
nameServer github:v2fly_v2ray-core_v5_app_dns:SimplifiedNameServer[]

NameServer list used by this DNS client.

clientIp string

Client IP for EDNS client subnet. Must be 4 bytes (IPv4) or 16 bytes (IPv6).

staticHosts github:v2fly_v2ray-core_v5_app_dns:SimplifiedHostMapping[]

Static domain-ip mapping in DNS server.

fakeDns object
1 nested properties
pools github:v2fly_v2ray-core_v5_app_dns_fakedns:FakeDnsPool[]
tag string

Tag is the inbound tag of DNS client.

domainMatcher enum
Values: "linear" "mph"
disableCache boolean

DisableCache disables DNS cache Deprecated. Use cache_strategy.

Deprecated: Marked as deprecated in app/dns/config.proto.

disableFallback boolean

Deprecated. Use fallback_strategy.

Deprecated: Marked as deprecated in app/dns/config.proto.

disableFallbackIfMatch boolean

Deprecated. Use fallback_strategy.

Deprecated: Marked as deprecated in app/dns/config.proto.

queryStrategy enum

Default query strategy (IPv4, IPv6, or both) for each name server.

Values: "USE_IP" "USE_IP4" "USE_IP6"
cacheStrategy enum

Default cache strategy for each name server.

Values: "CacheEnabled" "CacheDisabled"
fallbackStrategy enum

Default fallback strategy for each name server.

Values: "Enabled" "Disabled" "DisabledIfAnyMatch"
github:v2fly_v2ray-core_v5_app_dns:SimplifiedHostMapping object
type enum
Values: "Full" "Subdomain" "Keyword" "Regex"
domain string
ip string[]
proxiedDomain string

ProxiedDomain indicates the mapped domain has the same IP address on this domain. V2Ray will use this domain for IP queries.

github:v2fly_v2ray-core_v5_app_dns:SimplifiedNameServer object
address object

Endpoint of a network connection.

3 nested properties
network enum
Values: "Unknown" "RawTCP" "TCP" "UDP" "UNIX"
address string
port integer
clientIp string
tag string
prioritizedDomain github:v2fly_v2ray-core_v5_app_dns:SimplifiedNameServer_PriorityDomain[]
geoip github:v2fly_v2ray-core_v5_app_router_routercommon:GeoIP[]
originalRules github:v2fly_v2ray-core_v5_app_dns:SimplifiedNameServer_OriginalRule[]
fakeDns object
1 nested properties
pools github:v2fly_v2ray-core_v5_app_dns_fakedns:FakeDnsPool[]
skipFallback boolean

Deprecated. Use fallback_strategy.

Deprecated: Marked as deprecated in app/dns/config.proto.

queryStrategy enum
Values: "USE_IP" "USE_IP4" "USE_IP6"
cacheStrategy enum
Values: "CacheEnabled" "CacheDisabled"
fallbackStrategy enum
Values: "Enabled" "Disabled" "DisabledIfAnyMatch"
geoDomain github:v2fly_v2ray-core_v5_app_router_routercommon:GeoSite[]
github:v2fly_v2ray-core_v5_app_dns:SimplifiedNameServer_OriginalRule object
rule string
size integer
github:v2fly_v2ray-core_v5_app_dns:SimplifiedNameServer_PriorityDomain object
type enum
Values: "Full" "Subdomain" "Keyword" "Regex"
domain string
github:v2fly_v2ray-core_v5_app_dns_fakedns:FakeDnsPool object
ipPool string
lruSize integer
github:v2fly_v2ray-core_v5_app_dns_fakedns:FakeDnsPoolMulti object
pools github:v2fly_v2ray-core_v5_app_dns_fakedns:FakeDnsPool[]
github:v2fly_v2ray-core_v5_app_instman:Config object
github:v2fly_v2ray-core_v5_app_log:Config object
error object
3 nested properties
type enum
Values: "None" "Console" "File" "Event"
level enum
Values: "Unknown" "Error" "Warning" "Info" "Debug"
path string
access object
3 nested properties
type enum
Values: "None" "Console" "File" "Event"
level enum
Values: "Unknown" "Error" "Warning" "Info" "Debug"
path string
github:v2fly_v2ray-core_v5_app_log:LogSpecification object
type enum
Values: "None" "Console" "File" "Event"
level enum
Values: "Unknown" "Error" "Warning" "Info" "Debug"
path string
github:v2fly_v2ray-core_v5_app_observatory:Config object
subjectSelector string[]

@Document The selectors for outbound under observation

probeUrl string
probeInterval integer
github:v2fly_v2ray-core_v5_app_observatory_burst:Config object
subjectSelector string[]

@Document The selectors for outbound under observation

pingConfig object
5 nested properties
destination string

destination url, need 204 for success return default https://connectivitycheck.gstatic.com/generate_204

connectivity string

connectivity check url

interval integer

health check interval, int64 values of time.Duration

samplingCount integer

sampling count is the amount of recent ping results which are kept for calculation

timeout integer

ping timeout, int64 values of time.Duration

github:v2fly_v2ray-core_v5_app_observatory_burst:HealthPingConfig object
destination string

destination url, need 204 for success return default https://connectivitycheck.gstatic.com/generate_204

connectivity string

connectivity check url

interval integer

health check interval, int64 values of time.Duration

samplingCount integer

sampling count is the amount of recent ping results which are kept for calculation

timeout integer

ping timeout, int64 values of time.Duration

github:v2fly_v2ray-core_v5_app_policy:Config object
level object
system object
2 nested properties
stats object
4 nested properties
inboundUplink boolean
inboundDownlink boolean
outboundUplink boolean
outboundDownlink boolean
overrideAccessLogDest boolean
github:v2fly_v2ray-core_v5_app_policy:Policy object
timeout object

Timeout is a message for timeout settings in various stages, in seconds.

4 nested properties
handshake object
1 nested properties
value integer
connectionIdle object
1 nested properties
value integer
uplinkOnly object
1 nested properties
value integer
downlinkOnly object
1 nested properties
value integer
stats object
2 nested properties
userUplink boolean
userDownlink boolean
buffer object
1 nested properties
connection integer

Buffer size per connection, in bytes. -1 for unlimited buffer.

github:v2fly_v2ray-core_v5_app_policy:Policy_Buffer object
connection integer

Buffer size per connection, in bytes. -1 for unlimited buffer.

github:v2fly_v2ray-core_v5_app_policy:Policy_Stats object
userUplink boolean
userDownlink boolean
github:v2fly_v2ray-core_v5_app_policy:Policy_Timeout object

Timeout is a message for timeout settings in various stages, in seconds.

handshake object
1 nested properties
value integer
connectionIdle object
1 nested properties
value integer
uplinkOnly object
1 nested properties
value integer
downlinkOnly object
1 nested properties
value integer
github:v2fly_v2ray-core_v5_app_policy:Second object
value integer
github:v2fly_v2ray-core_v5_app_policy:SystemPolicy object
stats object
4 nested properties
inboundUplink boolean
inboundDownlink boolean
outboundUplink boolean
outboundDownlink boolean
overrideAccessLogDest boolean
github:v2fly_v2ray-core_v5_app_policy:SystemPolicy_Stats object
inboundUplink boolean
inboundDownlink boolean
outboundUplink boolean
outboundDownlink boolean
github:v2fly_v2ray-core_v5_app_proxyman:SniffingConfig object
enabled boolean

Whether or not to enable content sniffing on an inbound connection.

destinationOverride string[]

Override target destination if sniff'ed protocol is in the given list. Supported values are "http", "tls", "fakedns".

metadataOnly boolean

Whether should only try to sniff metadata without waiting for client input. Can be used to support SMTP like protocol where server send the first message.

github:v2fly_v2ray-core_v5_app_restfulapi:Config object
listenAddr string
listenPort integer
authToken string
github:v2fly_v2ray-core_v5_app_reverse:BridgeConfig object
tag string
domain string
github:v2fly_v2ray-core_v5_app_reverse:Config object
bridgeConfig github:v2fly_v2ray-core_v5_app_reverse:BridgeConfig[]
portalConfig github:v2fly_v2ray-core_v5_app_reverse:PortalConfig[]
github:v2fly_v2ray-core_v5_app_reverse:PortalConfig object
tag string
domain string
github:v2fly_v2ray-core_v5_app_router:BalancingRule object
tag string
outbound_selector string[]
fallback_tag string
github:v2fly_v2ray-core_v5_app_router:SimplifiedConfig object
domainStrategy enum
Values: "AsIs" "UseIp" "IpIfNonMatch" "IpOnDemand"
rule github:v2fly_v2ray-core_v5_app_router:SimplifiedRoutingRule[]
balancingRule github:EHfive_v2ray-jsonschema_v5config:CustomBalancingRule[]
github:v2fly_v2ray-core_v5_app_router:SimplifiedRoutingRule object
tag string
balancingTag string
domain github:v2fly_v2ray-core_v5_app_router_routercommon:Domain[]

List of domains for target domain matching.

geoip github:v2fly_v2ray-core_v5_app_router_routercommon:GeoIP[]

List of GeoIPs for target IP address matching. If this entry exists, the cidr above will have no effect. GeoIP fields with the same country code are supposed to contain exactly same content. They will be merged during runtime. For customized GeoIPs, please leave country code empty.

portList string

List of ports.

networks string | enum[]
sourceGeoip github:v2fly_v2ray-core_v5_app_router_routercommon:GeoIP[]

List of GeoIPs for source IP address matching. If this entry exists, the source_cidr above will have no effect.

sourcePortList string

List of ports for source port matching.

userEmail string[]
inboundTag string[]
protocol github:EHfive_v2ray-jsonschema_common:CustomRouterProtocol[]
attributes string
domainMatcher enum
Values: "linear" "mph"
geoDomain github:v2fly_v2ray-core_v5_app_router_routercommon:GeoSite[]

geo_domain instruct simplified config loader to load geo domain rule and fill in domain field.

github:v2fly_v2ray-core_v5_app_router:StrategyLeastLoadConfig object
costs github:v2fly_v2ray-core_v5_app_router:StrategyWeight[]

weight settings

baselines integer[]

RTT baselines for selecting, int64 values of time.Duration

expected integer

expected nodes count to select

maxRTT integer

max acceptable rtt, filter away high delay nodes. defalut 0

tolerance number

acceptable failure rate

observerTag string
github:v2fly_v2ray-core_v5_app_router:StrategyLeastPingConfig object
observerTag string
github:v2fly_v2ray-core_v5_app_router:StrategyRandomConfig object
observerTag string
aliveOnly boolean
github:v2fly_v2ray-core_v5_app_router:StrategyWeight object
regexp boolean
match string
value number
github:v2fly_v2ray-core_v5_app_router_routercommon:CIDR object

IP for routing decision, in CIDR form.

ip string | integer[]

IP address, should be either 4 or 16 bytes.

prefix integer

Number of leading ones in the network mask.

ipAddr string
github:v2fly_v2ray-core_v5_app_router_routercommon:Domain object

Domain for routing decision.

type enum

Domain matching type.

Values: "Plain" "Regex" "RootDomain" "Full"
value string

Domain value.

attribute github:v2fly_v2ray-core_v5_app_router_routercommon:Domain_Attribute[]

Attributes of this domain. May be used for filtering.

github:v2fly_v2ray-core_v5_app_router_routercommon:Domain_Attribute object
key string
boolValue boolean
intValue integer
github:v2fly_v2ray-core_v5_app_router_routercommon:GeoIP object
countryCode string
cidr github:v2fly_v2ray-core_v5_app_router_routercommon:CIDR[]
inverseMatch boolean
resourceHash string | integer[]

resource_hash instruct simplified config converter to load domain from geo file.

code string
filePath string
github:v2fly_v2ray-core_v5_app_router_routercommon:GeoSite object
countryCode string
domain github:v2fly_v2ray-core_v5_app_router_routercommon:Domain[]
resourceHash string | integer[]

resource_hash instruct simplified config converter to load domain from geo file.

code string
filePath string
github:v2fly_v2ray-core_v5_app_stats:Config object
github:v2fly_v2ray-core_v5_app_subscription:Config object

Config is the settings for Subscription Manager.

imports github:v2fly_v2ray-core_v5_app_subscription:ImportSource[]
nonnativeConverterOverlay string | integer[]
nonnativeConverterOverlayFile string
github:v2fly_v2ray-core_v5_app_subscription:ImportSource object
name string
url string
tagPrefix string
importUsingTag string
defaultExpireSeconds integer
github:v2fly_v2ray-core_v5_app_tun:Config object
name string
mtu integer
userLevel integer
packetEncoding enum
Values: "None" "Packet"
tag string
ips github:v2fly_v2ray-core_v5_app_router_routercommon:CIDR[]
routes github:v2fly_v2ray-core_v5_app_router_routercommon:CIDR[]
enablePromiscuousMode boolean
enableSpoofing boolean
socketSettings object

SocketConfig is options to be applied on network sockets.

14 nested properties
mark integer

Mark of the connection. If non-zero, the value will be set to SO_MARK.

tfo enum

TFO is the state of TFO settings.

Values: "AsIs" "Enable" "Disable"
tproxy enum

TProxy is for enabling TProxy socket option.

Values: "Off" "TProxy" "Redirect"
receiveOriginalDestAddress boolean

ReceiveOriginalDestAddress is for enabling IP_RECVORIGDSTADDR socket option. This option is for UDP only.

bindAddress string | integer[]
bindPort integer
acceptProxyProtocol boolean
tcpKeepAliveInterval integer
tfoQueueLength integer
tcpKeepAliveIdle integer
bindToDevice string
rxBufSize integer
txBufSize integer
forceBufSize boolean
sniffingSettings object
3 nested properties
enabled boolean

Whether or not to enable content sniffing on an inbound connection.

destinationOverride string[]

Override target destination if sniff'ed protocol is in the given list. Supported values are "http", "tls", "fakedns".

metadataOnly boolean

Whether should only try to sniff metadata without waiting for client input. Can be used to support SMTP like protocol where server send the first message.

github:v2fly_v2ray-core_v5_common_net:Endpoint object

Endpoint of a network connection.

network enum
Values: "Unknown" "RawTCP" "TCP" "UDP" "UNIX"
address string
port integer
github:v2fly_v2ray-core_v5_common_protocol:SecurityConfig object
type enum
Values: "UNKNOWN" "LEGACY" "AUTO" "AES128_GCM" "CHACHA20_POLY1305" "NONE" "ZERO"
github:v2fly_v2ray-core_v5_common_protocol:ServerEndpoint object
address string
port integer
user github:v2fly_v2ray-core_v5_common_protocol:User[]
github:v2fly_v2ray-core_v5_common_protocol:User object

User is a generic user for all procotols.

level integer
email string
account object
2 nested properties
typeUrl string
pattern=^types\.v2fly\.org/
value string
github:v2fly_v2ray-core_v5_infra_conf_cfgcommon_muxcfg:MuxConfig object
enabled boolean
concurrency integer
github:v2fly_v2ray-core_v5_infra_conf_cfgcommon_proxycfg:ProxyConfig object
tag string
transportLayer boolean
github:v2fly_v2ray-core_v5_infra_conf_cfgcommon_sniffer:SniffingConfig object
enabled boolean
destOverride string | string[]
metadataOnly boolean
github:v2fly_v2ray-core_v5_infra_conf_cfgcommon_socketcfg:SocketConfig object
mark integer
tcpFastOpen boolean
tproxy string
acceptProxyProtocol boolean
tcpKeepAliveInterval integer
tcpKeepAliveIdle integer
tcpFastOpenQueueLength integer
bindToDevice string
rxBufSize integer
txBufSize integer
forceBufSize boolean
github:v2fly_v2ray-core_v5_infra_conf_v5cfg:InboundConfig object
protocol string
port integer | string
listen string
tag string
sniffing object
3 nested properties
enabled boolean
destOverride string | string[]
metadataOnly boolean
streamSettings
All of: github:v2fly_v2ray-core_v5_infra_conf_v5cfg:StreamConfig object, variant, variant, variant, variant, variant, variant, variant, variant, variant, variant, variant
github:v2fly_v2ray-core_v5_infra_conf_v5cfg:OutboundConfig object
protocol string
sendThrough string
tag string
streamSettings
All of: github:v2fly_v2ray-core_v5_infra_conf_v5cfg:StreamConfig object, variant, variant, variant, variant, variant, variant, variant, variant, variant, variant, variant
proxySettings object
2 nested properties
tag string
transportLayer boolean
mux object
2 nested properties
enabled boolean
concurrency integer
domainStrategy enum
Values: "AsIs" "UseIP" "UseIP4" "UseIP6"
github:v2fly_v2ray-core_v5_infra_conf_v5cfg:RootConfig object
log object
2 nested properties
error object
3 nested properties
type enum
Values: "None" "Console" "File" "Event"
level enum
Values: "Unknown" "Error" "Warning" "Info" "Debug"
path string
access object
3 nested properties
type enum
Values: "None" "Console" "File" "Event"
level enum
Values: "Unknown" "Error" "Warning" "Info" "Debug"
path string
dns object
12 nested properties
nameServer github:v2fly_v2ray-core_v5_app_dns:SimplifiedNameServer[]

NameServer list used by this DNS client.

clientIp string

Client IP for EDNS client subnet. Must be 4 bytes (IPv4) or 16 bytes (IPv6).

staticHosts github:v2fly_v2ray-core_v5_app_dns:SimplifiedHostMapping[]

Static domain-ip mapping in DNS server.

fakeDns object
1 nested properties
pools github:v2fly_v2ray-core_v5_app_dns_fakedns:FakeDnsPool[]
tag string

Tag is the inbound tag of DNS client.

domainMatcher enum
Values: "linear" "mph"
disableCache boolean

DisableCache disables DNS cache Deprecated. Use cache_strategy.

Deprecated: Marked as deprecated in app/dns/config.proto.

disableFallback boolean

Deprecated. Use fallback_strategy.

Deprecated: Marked as deprecated in app/dns/config.proto.

disableFallbackIfMatch boolean

Deprecated. Use fallback_strategy.

Deprecated: Marked as deprecated in app/dns/config.proto.

queryStrategy enum

Default query strategy (IPv4, IPv6, or both) for each name server.

Values: "USE_IP" "USE_IP4" "USE_IP6"
cacheStrategy enum

Default cache strategy for each name server.

Values: "CacheEnabled" "CacheDisabled"
fallbackStrategy enum

Default fallback strategy for each name server.

Values: "Enabled" "Disabled" "DisabledIfAnyMatch"
router object
3 nested properties
domainStrategy enum
Values: "AsIs" "UseIp" "IpIfNonMatch" "IpOnDemand"
rule github:v2fly_v2ray-core_v5_app_router:SimplifiedRoutingRule[]
balancingRule github:EHfive_v2ray-jsonschema_v5config:CustomBalancingRule[]
inbounds github:EHfive_v2ray-jsonschema_v5config:CustomInboundConfig[]
outbounds github:EHfive_v2ray-jsonschema_v5config:CustomOutboundConfig[]
services object
13 nested properties
backgroundObservatory object
3 nested properties
subjectSelector string[]

@Document The selectors for outbound under observation

probeUrl string
probeInterval integer
browser object

Config is the settings for BrowserForwarder.

2 nested properties
listenAddr string
listenPort integer
burstObservatory object
2 nested properties
subjectSelector string[]

@Document The selectors for outbound under observation

pingConfig object
commander object
2 nested properties
tag string
name string[]
fakeDns object
2 nested properties
ipPool string
lruSize integer
fakeDnsMulti object
1 nested properties
pools github:v2fly_v2ray-core_v5_app_dns_fakedns:FakeDnsPool[]
instman object
policy object
2 nested properties
level object
system object
restfulapi object
3 nested properties
listenAddr string
listenPort integer
authToken string
reverse object
2 nested properties
bridgeConfig github:v2fly_v2ray-core_v5_app_reverse:BridgeConfig[]
portalConfig github:v2fly_v2ray-core_v5_app_reverse:PortalConfig[]
stats object
tun object
11 nested properties
name string
mtu integer
userLevel integer
packetEncoding enum
Values: "None" "Packet"
tag string
ips github:v2fly_v2ray-core_v5_app_router_routercommon:CIDR[]
routes github:v2fly_v2ray-core_v5_app_router_routercommon:CIDR[]
enablePromiscuousMode boolean
enableSpoofing boolean
socketSettings object

SocketConfig is options to be applied on network sockets.

sniffingSettings object
subscription object

Config is the settings for Subscription Manager.

3 nested properties
imports github:v2fly_v2ray-core_v5_app_subscription:ImportSource[]
nonnativeConverterOverlay string | integer[]
nonnativeConverterOverlayFile string
extension array
github:v2fly_v2ray-core_v5_infra_conf_v5cfg:StreamConfig object
socketSettings object
11 nested properties
mark integer
tcpFastOpen boolean
tproxy string
acceptProxyProtocol boolean
tcpKeepAliveInterval integer
tcpKeepAliveIdle integer
tcpFastOpenQueueLength integer
bindToDevice string
rxBufSize integer
txBufSize integer
forceBufSize boolean
github:v2fly_v2ray-core_v5_proxy_blackhole:SimplifiedConfig object
github:v2fly_v2ray-core_v5_proxy_dns:SimplifiedConfig object
github:v2fly_v2ray-core_v5_proxy_dokodemo:SimplifiedConfig object
address string
port integer
networks string | enum[]
followRedirect boolean
github:v2fly_v2ray-core_v5_proxy_freedom:SimplifiedConfig object
github:v2fly_v2ray-core_v5_proxy_http_simplified:ClientConfig object
address string
port integer
h1SkipWaitForReply boolean
github:v2fly_v2ray-core_v5_proxy_http_simplified:ServerConfig object
github:v2fly_v2ray-core_v5_proxy_loopback:Config object
inboundTag string
github:v2fly_v2ray-core_v5_proxy_shadowsocks2022:ClientConfig object
method string
psk string | integer[]
ipsk string | integer[][]
address string
port integer
github:v2fly_v2ray-core_v5_proxy_shadowsocks_simplified:ClientConfig object
address string
port integer
method enum
Values: "UNKNOWN" "AES_128_GCM" "AES_256_GCM" "CHACHA20_POLY1305" "NONE"
password string
experimentReducedIvHeadEntropy boolean
github:v2fly_v2ray-core_v5_proxy_shadowsocks_simplified:ServerConfig object
method enum
Values: "UNKNOWN" "AES_128_GCM" "AES_256_GCM" "CHACHA20_POLY1305" "NONE"
password string
networks string | enum[]
packetEncoding enum
Values: "None" "Packet"
github:v2fly_v2ray-core_v5_proxy_socks:ClientConfig object

ClientConfig is the protobuf config for Socks client.

server github:v2fly_v2ray-core_v5_common_protocol:ServerEndpoint[]

Sever is a list of Socks server addresses.

version enum
Values: "SOCKS5" "SOCKS4" "SOCKS4A"
delayAuthWrite boolean
github:v2fly_v2ray-core_v5_proxy_socks_simplified:ClientConfig object
address string
port integer
github:v2fly_v2ray-core_v5_proxy_socks_simplified:ServerConfig object
address string
udpEnabled boolean
packetEncoding enum
Values: "None" "Packet"
github:v2fly_v2ray-core_v5_proxy_trojan_simplified:ClientConfig object
address string
port integer
password string
github:v2fly_v2ray-core_v5_proxy_trojan_simplified:ServerConfig object
users string[]
packetEncoding enum
Values: "None" "Packet"
github:v2fly_v2ray-core_v5_proxy_vless_inbound:SimplifiedConfig object
users string[]
github:v2fly_v2ray-core_v5_proxy_vless_outbound:SimplifiedConfig object
address string
port integer
uuid string
github:v2fly_v2ray-core_v5_proxy_vlite_inbound:UDPProtocolConfig object
password string
scramblePacket boolean
enableFec boolean
enableStabilization boolean
enableRenegotiation boolean
handshakeMaskingPaddingSize integer
github:v2fly_v2ray-core_v5_proxy_vlite_outbound:UDPProtocolConfig object
address string
port integer
password string
scramblePacket boolean
enableFec boolean
enableStabilization boolean
enableRenegotiation boolean
handshakeMaskingPaddingSize integer
github:v2fly_v2ray-core_v5_proxy_vmess_inbound:SimplifiedConfig object
users string[]
github:v2fly_v2ray-core_v5_proxy_vmess_outbound:SimplifiedConfig object
address string
port integer
uuid string
github:v2fly_v2ray-core_v5_transport_internet:SocketConfig object

SocketConfig is options to be applied on network sockets.

mark integer

Mark of the connection. If non-zero, the value will be set to SO_MARK.

tfo enum

TFO is the state of TFO settings.

Values: "AsIs" "Enable" "Disable"
tproxy enum

TProxy is for enabling TProxy socket option.

Values: "Off" "TProxy" "Redirect"
receiveOriginalDestAddress boolean

ReceiveOriginalDestAddress is for enabling IP_RECVORIGDSTADDR socket option. This option is for UDP only.

bindAddress string | integer[]
bindPort integer
acceptProxyProtocol boolean
tcpKeepAliveInterval integer
tfoQueueLength integer
tcpKeepAliveIdle integer
bindToDevice string
rxBufSize integer
txBufSize integer
forceBufSize boolean
github:v2fly_v2ray-core_v5_transport_internet_domainsocket:Config object
path string

Path of the domain socket. This overrides the IP/Port parameter from upstream caller.

abstract boolean

Abstract specifies whether to use abstract namespace or not. Traditionally Unix domain socket is file system based. Abstract domain socket can be used without acquiring file lock.

padding boolean

Some apps, eg. haproxy, use the full length of sockaddr_un.sun_path to connect(2) or bind(2) when using abstract UDS.

github:v2fly_v2ray-core_v5_transport_internet_grpc:Config object
host string
serviceName string
github:v2fly_v2ray-core_v5_transport_internet_headers_http:Header object
name string

"Accept", "Cookie", etc

value string[]

Each entry must be valid in one piece. Random entry will be chosen if multiple entries present.

github:v2fly_v2ray-core_v5_transport_internet_http:Config object
host string[]
path string
method string
header github:v2fly_v2ray-core_v5_transport_internet_headers_http:Header[]
github:v2fly_v2ray-core_v5_transport_internet_httpupgrade:Config object
path string
host string
github:v2fly_v2ray-core_v5_transport_internet_kcp:Config object
mtu object

Maximum Transmission Unit, in bytes.

1 nested properties
value integer
tti object

Transmission Time Interview, in milli-sec.

1 nested properties
value integer
uplinkCapacity object

Uplink capacity, in MB.

1 nested properties
value integer
downlinkCapacity object

Downlink capacity, in MB.

1 nested properties
value integer
congestion boolean
writeBuffer object
1 nested properties
size integer

Buffer size in bytes.

readBuffer object
1 nested properties
size integer

Buffer size in bytes.

headerConfig object
2 nested properties
typeUrl string
pattern=^types\.v2fly\.org/
value string
seed object

Maximum Transmission Unit, in bytes.

1 nested properties
seed string
github:v2fly_v2ray-core_v5_transport_internet_kcp:DownlinkCapacity object

Downlink capacity, in MB.

value integer
github:v2fly_v2ray-core_v5_transport_internet_kcp:EncryptionSeed object

Maximum Transmission Unit, in bytes.

seed string
github:v2fly_v2ray-core_v5_transport_internet_kcp:MTU object

Maximum Transmission Unit, in bytes.

value integer
github:v2fly_v2ray-core_v5_transport_internet_kcp:ReadBuffer object
size integer

Buffer size in bytes.

github:v2fly_v2ray-core_v5_transport_internet_kcp:TTI object

Transmission Time Interview, in milli-sec.

value integer
github:v2fly_v2ray-core_v5_transport_internet_kcp:UplinkCapacity object

Uplink capacity, in MB.

value integer
github:v2fly_v2ray-core_v5_transport_internet_kcp:WriteBuffer object
size integer

Buffer size in bytes.

github:v2fly_v2ray-core_v5_transport_internet_quic:Config object
key string
security object
1 nested properties
type enum
Values: "UNKNOWN" "LEGACY" "AUTO" "AES128_GCM" "CHACHA20_POLY1305" "NONE" "ZERO"
header object
2 nested properties
typeUrl string
pattern=^types\.v2fly\.org/
value string
github:v2fly_v2ray-core_v5_transport_internet_request_stereotype_meek:Config object
url string
github:v2fly_v2ray-core_v5_transport_internet_tcp:Config object
headerSettings object
2 nested properties
typeUrl string
pattern=^types\.v2fly\.org/
value string
acceptProxyProtocol boolean
github:v2fly_v2ray-core_v5_transport_internet_tls:Certificate object
Certificate string | integer[]

TLS certificate in x509 format.

Key string | integer[]

TLS key in x509 format.

usage enum
Values: "ENCIPHERMENT" "AUTHORITY_VERIFY" "AUTHORITY_ISSUE" "AUTHORITY_VERIFY_CLIENT"
certificateFile string
keyFile string
github:v2fly_v2ray-core_v5_transport_internet_tls:Config object
allowInsecure boolean

Whether or not to allow self-signed certificates.

certificate github:v2fly_v2ray-core_v5_transport_internet_tls:Certificate[]

List of certificates to be served on server.

serverName string

Override server name.

nextProtocol string[]

Lists of string as ALPN values.

enableSessionResumption boolean

Whether or not to enable session (ticket) resumption.

disableSystemRoot boolean

If true, root certificates on the system will not be loaded for verification.

pinnedPeerCertificateChainSha256 string | integer[][]

@Document A pinned certificate chain sha256 hash. @Document If the server's hash does not match this value, the connection will be aborted. @Document This value replace allow_insecure. @Critical

verifyClientCertificate boolean

If true, the client is required to present a certificate.

minVersion enum

Minimum TLS version to support.

Values: "Default" "TLS1_0" "TLS1_1" "TLS1_2" "TLS1_3"
maxVersion enum

Maximum TLS version to support.

Values: "Default" "TLS1_0" "TLS1_1" "TLS1_2" "TLS1_3"
github:v2fly_v2ray-core_v5_transport_internet_tls_utls:Config object
tlsConfig object
10 nested properties
allowInsecure boolean

Whether or not to allow self-signed certificates.

certificate github:v2fly_v2ray-core_v5_transport_internet_tls:Certificate[]

List of certificates to be served on server.

serverName string

Override server name.

nextProtocol string[]

Lists of string as ALPN values.

enableSessionResumption boolean

Whether or not to enable session (ticket) resumption.

disableSystemRoot boolean

If true, root certificates on the system will not be loaded for verification.

pinnedPeerCertificateChainSha256 string | integer[][]

@Document A pinned certificate chain sha256 hash. @Document If the server's hash does not match this value, the connection will be aborted. @Document This value replace allow_insecure. @Critical

verifyClientCertificate boolean

If true, the client is required to present a certificate.

minVersion enum

Minimum TLS version to support.

Values: "Default" "TLS1_0" "TLS1_1" "TLS1_2" "TLS1_3"
maxVersion enum

Maximum TLS version to support.

Values: "Default" "TLS1_0" "TLS1_1" "TLS1_2" "TLS1_3"
imitate enum
Values: "randomized" "randomizedalpn" "randomizednoalpn" "firefox_auto" "firefox_55" "firefox_56" "firefox_63" "firefox_65" "firefox_99" "firefox_102" "firefox_105" "chrome_auto" "chrome_58" "chrome_62" "chrome_70" "chrome_72" "chrome_83" "chrome_87" "chrome_96" "chrome_100" "chrome_102" "ios_auto" "ios_11_1" "ios_12_1" "ios_13" "ios_14" "android_11_okhttp" "edge_auto" "edge_85" "edge_106" "safari_auto" "safari_16_0" "360_auto" "360_7_5" "360_11_0" "qq_auto" "qq_11_1"
noSNI boolean
forceAlpn enum
Values: "TRANSPORT_PREFERENCE_TAKE_PRIORITY" "NO_ALPN" "UTLS_PRESET"
github:v2fly_v2ray-core_v5_transport_internet_websocket:Config object
path string

URL path to the WebSocket service. Empty value means root(/).

header github:v2fly_v2ray-core_v5_transport_internet_websocket:Header[]
acceptProxyProtocol boolean
maxEarlyData integer
useBrowserForwarding boolean
earlyDataHeaderName string
github:v2fly_v2ray-core_v5_transport_internet_websocket:Header object
key string
value string