config library
Classes
- ApiConfig
- API interface configuration provides a set of APIs based on gRPC for remote invocation.
- BalancerCost
- Weight configuration for outbound nodes.
- BalancerStrategy
- Balance strategy object.
- BalancerStrategySettings
- Settings for load balancing strategies.
- BaseSettingsHeaders
- Base class for RAW header masking settings.
- BlackHoleOutbound
- Blackhole outbound: blocks all outgoing traffic.
- BlackHoleOutboundSettings
- Blackhole outbound settings.
- BlackHoleResponse
- Blackhole response behavior.
- CommonRules
- Common DNS rule fields.
- CustomSockopt
- DnsConfig
- Config for built‑in DNS server.
- DnsOutbound
- DNS outbound: intercepts and forwards DNS queries.
- DnsOutboundSettings
- DnsServer
- DNS server object.
- DokodemoDoorInbound
- DokodemoDoorInboundSettings
- FakeDnsConfig
- Setting up FakeDNS. Can be used together with transparent proxying to obtain real domain names.
- Fallback
- FreedomOutbound
- Freedom outbound: sends plain TCP/UDP traffic to any destination.
- FreedomOutboundSettings
- GrpcSettings
- gRPC configuration for the current connection.
- HappyEyeballs
- HttpAccount
- HttpInbound
- HttpInboundSettings
- HttpOutbound
- HTTP outbound protocol.
- HttpOutboundSettings
- HttpRequest
- Raw HTTP request model.
- HttpResponse
- Raw HTTP response model.
- HttpSettingsHeaders
- HTTP cloaking configuration.
- HttpUpgradeSettings
- HTTPUpgrade configuration for the current connection.
- HysteriaObfs
- HysteriaOutbound
- HysteriaOutboundSettings
- HysteriaServer
- HysteriaSettings
- Low-level QUIC transport implementation for Hysteria2.
- HysteriaUDPhop
- UDP port hopping configuration for Hysteria2.
- Inbound
- InboundAllocate
- InboundClient
- InboundSniffing
- KcpHeaders
- mKCP header masking configuration.
- KcpSettings
- mKCP configuration for the current connection.
- LevelPolicy
- Policy applied to a specific user level.
- LogConfig
- Log configuration controls how Xray outputs logs. Docs
- LoopbackOutbound
- Loopback outbound: reroutes traffic to an inbound by tag.
- LoopbackOutboundSettings
- MetricsConfig
- Metrics configuration.
- Mux
- NoneSettingsHeaders
- No masking is performed.
- ObservatoryConfig
- The connection monitoring component uses HTTP pings to check the connection status of outbound proxies.
- Outbound
- Base class for all outbound configurations.
- PingConfig
- Ping schema used by BurstObservatory.
- PolicyConfig
- Local policy configuration for user levels and system‑wide rules.
- Port
- ProxySettings
- Outbound proxy configuration.
- RawSettings
- RAW transport settings (renamed from TCP transport layer).
- RealitySettings
- Reality configuration (Xray REALITY protocol).
- ReverseBridge
- Bridge configuration object.
- ReverseConfig
- A reverse proxy can redirect traffic from a server to a client, performing reverse traffic forwarding.
- ReversePortal
- Portal configuration object.
- RoutingBalancer
- Load balancer configuration.
- RoutingConfig
- Configures routing. Specifies rules to route connections through different outbounds.
- RoutingRule
- Routing rule object.
- ShadowSocksClient
- ShadowSocksCommon
- ShadowSocksInbound
- ShadowSocksInboundSettings
- ShadowSocksOutbound
- ShadowSocks outbound protocol.
- ShadowSocksOutboundSettings
- ShadowSocksServer
- ShadowSocks server entry.
- Sockopt
- SocksAccount
- SocksInbound
- SocksInboundSettings
- SocksOutbound
- SOCKS outbound protocol.
- SocksOutboundSettings
- StatsConfig
- Used to configure the collection of traffic statistics.
- StreamSettings
- SystemPolicy
- System‑wide Xray policies.
- TlsCertificate
- TlsSettings
- TransportConfig
- Transport defines how data is transmitted between Xray nodes.
- TrojanClient
- TrojanInbound
- TrojanInboundSettings
- TrojanOutbound
- Trojan outbound protocol.
- TrojanOutboundSettings
- TrojanServer
- Trojan server entry.
- TunInbound
- TunInboundSettings
- VersionConfig
- Controls the version range in which this config can run.
- VlessClient
- VlessInbound
- VlessInboundSettings
- VlessOutbound
- VLESS outbound protocol.
- VlessOutboundSettings
- VlessReverse
- Reverse proxy configuration for VLESS.
- VlessUser
- VLESS user entry.
- VlessVNext
- VLESS VNext entry.
- VMessClient
- VMessInbound
- VMessInboundDefaultSettings
- VMessInboundSettings
- VMessOutbound
- VMess outbound protocol.
- VMessOutboundSettings
- VMessUser
- VMess user entry.
- VMessVNext
- VMess VNext entry.
- WireguardInbound
- WireguardInboundSettings
- WireguardOutbound
- WireGuard outbound protocol.
- WireguardOutboundPeer
- WireGuard peer configuration.
- WireguardOutboundSettings
- WireguardPeer
- WsSettings
- WebSocket configuration for the current connection.
- XHttpDownloadSettings
- Download settings for XHTTP.
- XHttpExtraSettings
- Extra XHTTP settings (shared JSON scheme).
- XHttpSettings
- XHTTP configuration for the current connection.
- XMux
- XMux configuration for XHTTP.
- XrayConfig
Enums
- AddressPortStrategy
- AllocateStrategy
- ApiService
- Supported API List.
- BalancerStrategyType
- Balance strategy type.
- CertificateUsageType
- Certificate usage type.
- DnsQueryStrategy
- DNS query strategy.
- DomainStrategy
- EncryptionMethod
- Fingerprint
- HeadersType
- KcpHeaderType
- LogLevel
- NetProtocol
- NonIPQueryType
- OperatingSystem
- Protocol
- RoutingDomainStrategy
- Domain name resolution strategy.
- RoutingRuleType
- SocksAuth
- StreamNetwork
- StreamSecurity
- Transport‑layer encryption type.
- TcpCongestion
- TProxy
- Whether to enable transparent proxying (Linux only).
- TrafficType
- TransportProtocol
- VlessEncryption
- VMessSecurity
- XHttpMode
- XtlsFlow
Properties
-
$EncryptionMethodEnum
→ EnumEncoder<
EncryptionMethod> -
final
-
$HeaderTypeEnum
→ EnumEncoder<
HeadersType> -
final
-
$KcpHeaderTypeEnum
→ EnumEncoder<
KcpHeaderType> -
final
-
$ProtocolEnum
→ EnumEncoder<
Protocol> -
final
-
$XHttpModeEnum
→ EnumEncoder<
XHttpMode> -
final
Functions
-
portFromJson(
dynamic json) → Port -
portToJson(
Port value) → Object -
readRawSettingsValue(
Map json, String key) → Object? -
readStreamNetworkValue(
Map json, String key) → String