Env: Add new env configuration (#874)

* Document root env configuration

* Format env documentation

* Align config module spacing

* Document Docker env config file

* Move env docs to basic config

* Add env to basic config sidebar

* Clarify root env behavior

* Refine environment variable documentation

---------

Co-authored-by: yiguo <yiguo@example.com>
This commit is contained in:
yiguodev
2026-07-10 13:05:06 +08:00
committed by GitHub
co-authored by yiguo
parent 5db24cc2d6
commit 63d932f42f
27 changed files with 391 additions and 265 deletions
+2 -56
View File
@@ -1,57 +1,3 @@
# 环境变量
# 环境配置已移动
Xray 提供以下环境变量以供修改 Xray 的一些底层配置。
## 资源文件路径
- 名称:`xray.location.asset` 或 `XRAY_LOCATION_ASSET`。
- 默认值:特定 [FHS](https://en.wikipedia.org/wiki/Filesystem_Hierarchy_Standard) 目录或 Xray 文件同路径。
这个环境变量指定了一个文件夹位置,这个文件夹应当包含 geoip.dat 和 geosite.dat 文件。
若无指定变量值,程序将会按以下顺序寻找资源文件:
```text
./
/usr/local/share/xray
/usr/share/xray
```
## 配置文件位置
- 名称:`xray.location.config` 或 `XRAY_LOCATION_CONFIG`。
- 默认值:和 Xray 文件同路径。
这个环境变量指定了一个文件夹位置,这个文件夹应当包含 config.json 文件。
## 多配置目录
- 名称:`xray.location.confdir` 或 `XRAY_LOCATION_CONFDIR`。
- 默认值:`""`。
这个目录内的 `.json` 文件会按文件名顺序读取,作为多配置选项。
此项优先级低于启动参数 `confdir`。
## 严格 JSON 解析器
- 名称:`xray.json.strict` 或 `XRAY_JSON_STRICT`。
- 默认值:`false`。
默认情况下,Xray 在启动时会使用自定义的 JSON 解析器(该解析器会从配置中剔除注释及其他非标准字符)。如果你确认自己的配置文件严格遵循 JSON 标准(RFC8259),可以启用此选项以使用标准 JSON 解析器,在配置文件极大时(几十 MB 以上)可以提升其解析速度。
## 其它可用的配置
- xray.location.plugin
- xray.location.tool
- xray.location.cert
- xray.buf.readv
- xray.buf.splice
- xray.vmess.padding
- xray.ray.buffer.size
- xray.browser.dialer
- xray.xudp.show
- xray.xudp.basekey
这些选项对有特殊需求的用户开放,您可以阅读源代码来发现其用途。~~PR Welcome~~
`env` 是基础配置模块,文档已移动到 [环境配置](../env.md)。
-1
View File
@@ -5,6 +5,5 @@ Xray 具备以下特性:
- [XTLS 深度剖析](xtls.md)
- [Fallback 回落](fallback.md)
- [Browser Dialer](browser_dialer.md)
- [环境变量](env.md)
- [多文件配置](multiple.md)
- [反向代理 / 内网穿透](/document/level-2/vless_reverse.md)