You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
picklefan 0a80e89354
Englishize sidebar and navbar, fixe a typo, translate some docs (#357)
2 years ago
..
features Englishize sidebar and navbar, fixe a typo, translate some docs (#357) 2 years ago
inbounds Add Reality and remove deprecated flows 2 years ago
outbounds Add Reality and remove deprecated flows 2 years ago
transports Englishize sidebar and navbar, fixe a typo, translate some docs (#357) 2 years ago
README.md Translate to English #2 (#340) 2 years ago
api.md Update api.md 2 years ago
dns.md Translate to English #2 (#340) 2 years ago
dns_flow.png Add English translate (WIP) 4 years ago
fakedns.md Translate to English #2 (#340) 2 years ago
inbound.md Translate to English #2 (#340) 2 years ago
log.md Translate to English #2 (#340) 2 years ago
outbound.md Translate to English #2 (#340) 2 years ago
policy.md Translate to English #2 (#340) 2 years ago
reverse.md Translate to English #2 (#340) 2 years ago
routing.md Translate to English #2 (#340) 2 years ago
stats.md Translate to English #2 (#340) 2 years ago
transport.md Translate to English #2 (#340) 2 years ago

README.md

title lang
Configurations en-US

This section will tell you all the details of Xray configuration. By mastering these contents, Xray will unleash its full power in your hands.

Overview

The configuration file of Xray is in JSON format, and the configuration format for the client and server is the same, except for the actual configuration content. It takes the following form:

{
  "log": {},
  "api": {},
  "dns": {},
  "routing": {},
  "policy": {},
  "inbounds": [],
  "outbounds": [],
  "transport": {},
  "stats": {},
  "reverse": {},
  "fakedns": {}
}

::: warning If you are new to Xray, you can first click to view configuration and running in the Quick Start guide, to learn the most basic configuration method, and then refer to the contents of this section to master all the configuration methods of Xray. :::

Basic Configuration Modules

log:LogObject

Log configuration, which controls the way Xray outputs logs.

api:ApiObject

Provides some API interfaces for remote calls.

dns: DnsObject

Built-in DNS server. If this item is not configured, the system's DNS settings will be used.

routing: RoutingObject

Routing function. You can set rules to route data to different outbounds.

policy: PolicyObject

Local policy, which can set different user levels and corresponding policy settings.

inbounds: [ InboundObject ]

An array, with each element being an inbound connection configuration.

outbounds: [ OutboundObject ]

An array, with each element being an outbound connection configuration.

transport: TransportObject

Used to configure the way Xray establishes and uses network connections with other servers.

stats: StatsObject

Used to configure traffic data statistics.

reverse: ReverseObject

Reverse proxy. You can forward server-side traffic to the client, that is, reverse traffic forwarding.

fakedns: FakeDnsObject

FakeDNS configuration. It can be used with transparent proxy to obtain the actual domain name.