Xray-docs-next

mirror of https://github.com/XTLS/Xray-docs-next.git synced 2025-04-08 11:32:06 +00:00

History

mmmray f71ded095a SplitHTTP: Reformat xmux config documentation The way that xmux is documented is inconsistent with other JSON objects, so let's make it more consistent. Later, XmuxObject should be moved outside of splithttp, but right now it really "belongs to" splithttp. Also add/update version tags because 24.9.16 has broken xmux and people are getting confused.		2024-09-21 07:59:33 -05:00
..
features	Update browser_dialer.md	2024-07-20 00:38:07 -04:00
inbounds	Remove legacy `timeout` config (#577 )	2024-09-15 18:22:25 +08:00
outbounds	Freedom/SplitHTTP: Some typo & refine	2024-09-17 05:25:14 +00:00
transports	SplitHTTP: Reformat xmux config documentation	2024-09-21 07:59:33 -05:00
api.md	Modify API doc. (#507 )	2024-05-23 11:23:54 -04:00
dns.md	Change the default port of Dns over Quic	2024-07-22 20:13:48 +08:00
dns_flow.png	压缩所有的 PNG 图片 (#561 )	2024-08-20 10:32:12 -04:00
fakedns.md	Update docs to cover 1.5.0 (#280 )	2022-06-20 22:16:41 -04:00
inbound.md	inbound: Update behavior description of listen address	2024-09-11 12:36:43 +08:00
log.md	log: Add address mask	2024-09-11 22:57:23 +08:00
metrics.md	Add HTTPUpgrade Transport (#482 )	2024-03-11 05:47:09 +00:00
observatory.md	Add observatory doc. (#509 )	2024-05-07 10:16:57 -04:00
outbound.md	在Mux的描述第一段提到UDP (#562 )	2024-08-20 10:37:14 -04:00
policy.md	Fix: format	2021-03-26 14:01:07 +08:00
README.md	Add observatory doc. (#509 )	2024-05-07 10:16:57 -04:00
reverse.md	Chore: lint	2021-04-06 19:05:35 +08:00
routing.md	Routing: Add ruleTag	2024-09-14 01:16:01 +08:00
stats.md	Fix: format	2021-03-26 14:01:07 +08:00
transport.md	Correct IP "prefer" description	2024-09-08 16:48:11 +00:00

README.md

title	lang
配置文件	zh-CN

这个章节将告诉您所有的 Xray 配置细节，掌握这些内容，在您手中 Xray 将发挥更大威力。

概述

Xray 的配置文件为 json 格式, 客户端和服务端的配置格式没有区别, 只是实际的配置内容不一样。
形式如下:

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

::: warning 如果你刚接触 Xray, 您可以先点击查看快速入门中的配置运行, 学习最基本的配置方式, 然后查看本章节内容以掌握所有 Xray 的配置方式。 :::

基础配置模块

log:LogObject

日志配置，控制 Xray 输出日志的方式.

api:ApiObject

提供了一些 API 接口供远程调用。

dns: DnsObject

内置的 DNS 服务器. 如果没有配置此项，则使用系统的 DNS 设置。

routing: RoutingObject

路由功能。可以设置规则分流数据从不同的 outbound 发出.

policy: PolicyObject

本地策略，可以设置不同的用户等级和对应的策略设置。

inbounds: [ InboundObject ]

一个数组，每个元素是一个入站连接配置。

outbounds: [ OutboundObject ]

一个数组，每个元素是一个出站连接配置。

transport: TransportObject

用于配置 Xray 其它服务器建立和使用网络连接的方式。

stats: StatsObject

用于配置流量数据的统计。

reverse: ReverseObject

反向代理。可以把服务器端的流量向客户端转发，即逆向流量转发。

fakedns: FakeDnsObject

FakeDNS 配置。可配合透明代理使用，以获取实际域名。

metrics: metricsObject

metrics 配置。更直接（希望更好）的统计导出方式。

observatory: ObservatoryObject

后台连接观测。探测出站代理的连接状态。

burstObservatory: BurstObservatoryObject

并发连接观测。探测出站代理的连接状态。