From 8a0c7d76e859af1a1c6622bfa20fcf369fb49559 Mon Sep 17 00:00:00 2001 From: JimhHan <50871214+JimhHan@users.noreply.github.com> Date: Thu, 18 Mar 2021 23:32:36 +0800 Subject: [PATCH] Fix: not enough links --- docs/config/README.md | 22 +++++++++++----------- docs/config/api.md | 4 ++-- docs/config/dns.md | 8 ++++---- docs/config/fakedns.md | 2 +- docs/config/inbound.md | 6 +++--- docs/config/outbound.md | 6 +++--- docs/config/policy.md | 5 ----- docs/config/reverse.md | 4 ++-- docs/config/routing.md | 4 ++-- docs/config/stats.md | 2 +- docs/config/transport.md | 36 ++++++++++++++++++------------------ docs/guide/README.md | 12 +++++------- docs/guide/command.md | 7 ++----- docs/guide/config.md | 9 +++------ docs/guide/document.md | 7 +------ docs/guide/install.md | 7 +------ docs/links.md | 5 +---- 17 files changed, 60 insertions(+), 86 deletions(-) diff --git a/docs/config/README.md b/docs/config/README.md index 0f8e655e2..41796d52f 100644 --- a/docs/config/README.md +++ b/docs/config/README.md @@ -32,46 +32,46 @@ Xray 的配置文件为 json 格式, 客户端和服务端的配置格式没有 ## 基础配置模块 -> log:[LogObject](./log) +> log:[LogObject](./log.md) 日志配置,控制 Xray输出日志的方式. -> api:[ApiObject](./api) +> api:[ApiObject](./api.md) 提供了一些API接口供远程调用。 -> dns: [DnsObject](./dns) +> dns: [DnsObject](./dns.md) 内置的 DNS 服务器. 如果没有配置此项,则使用系统的 DNS 设置。 -> routing: [RoutingObject](./routing) +> routing: [RoutingObject](./routing.md) 路由功能。可以设置规则分流数据从不同的outbound发出. -> policy: [PolicyObject](./base/policy) +> policy: [PolicyObject](./policy.md) 本地策略,可以设置不同的用户等级和对应的策略设置。 -> inbounds: \[ [InboundObject](./inbound) \] +> inbounds: \[ [InboundObject](./inbound.md) \] 一个数组,每个元素是一个入站连接配置。 -> outbounds: \[ [OutboundObject](./outbound) \] +> outbounds: \[ [OutboundObject](./outbound.md) \] 一个数组,每个元素是一个出站连接配置。 -> transport: [TransportObject](./base/transport) +> transport: [TransportObject](./transport.md) 用于配置 Xray 其它服务器建立和使用网络连接的方式。 -> stats: [StatsObject](./stats) +> stats: [StatsObject](./stats.md) 用于配置流量数据的统计。 -> reverse: [ReverseObject](./reverse) +> reverse: [ReverseObject](./reverse.md) 反向代理。可以把服务器端的流量向客户端转发,即逆向流量转发 -> fakedns: [FakeDnsObject](./fakedns) +> fakedns: [FakeDnsObject](./fakedns.md) FakeDNS. 可配合透明代理使用,以获取实际域名。 diff --git a/docs/config/api.md b/docs/config/api.md index ee126ec20..44dd6b88c 100644 --- a/docs/config/api.md +++ b/docs/config/api.md @@ -2,7 +2,7 @@ API接口配置提供了一些基于 [gRPC](https://grpc.io/)的 API 接口供远程调用。 -可以通过api配置模块开启接口. 当api配置开启时,Xray 会自建一个出站代理,须手动将所有的 API 入站连接通过 [路由规则配置](./routing) 指向这一出站代理。 +可以通过api配置模块开启接口. 当api配置开启时,Xray 会自建一个出站代理,须手动将所有的 API 入站连接通过 [路由规则配置](./routing.md) 指向这一出站代理。 请参考本节中的[相关配置](#相关配置) @@ -93,4 +93,4 @@ API接口配置提供了一些基于 [gRPC](https://grpc.io/)的 API 接口供 ### StatsService -内置的数据统计服务,详见 [统计信息](./stats)。 +内置的数据统计服务,详见 [统计信息](./stats.md)。 diff --git a/docs/config/dns.md b/docs/config/dns.md index a50c6d0f4..17e7d1a2b 100644 --- a/docs/config/dns.md +++ b/docs/config/dns.md @@ -73,7 +73,7 @@ DNS 服务器的处理流程示意图如下: - 正则表达式:由 `"regexp:"` 开始,余下部分是一个正则表达式。当此正则表达式匹配目标域名时,该规则生效。例如 "regexp:\\\\.goo.\*\\\\.com$" 匹配"www.google.com"或 "fonts.googleapis.com",但不匹配 "google.com"。 - 子域名 (推荐):由 `"domain:"` 开始,余下部分是一个域名。当此域名是目标域名或其子域名时,该规则生效。例如 “domain:xray.com” 匹配"www.xray.com"、“xray.com”,但不匹配 “wxray.com”。 - 子串:由 `"keyword:"` 开始,余下部分是一个字符串。当此字符串匹配目标域名中任意部分,该规则生效。比如 "keyword:sina.com" 可以匹配"sina.com"、"sina.com.cn" 和"www.sina.com",但不匹配 "sina.cn"。 -- 预定义域名列表:由 `"geosite:"` 开头,余下部分是一个名称,如 `geosite:google` 或者 `geosite:cn`。名称及域名列表参考 [预定义域名列表](./routing/#预定义域名列表)。 +- 预定义域名列表:由 `"geosite:"` 开头,余下部分是一个名称,如 `geosite:google` 或者 `geosite:cn`。名称及域名列表参考 [预定义域名列表](./routing.md#预定义域名列表)。 >`servers`: \[string | [ServerObject](#serverobject) \] @@ -98,7 +98,7 @@ DNS 服务器的处理流程示意图如下: ::: ::: tip TIP 3 -(v1.4.0+) 可以在 [日志](./log) 中打开 DNS 查询日志。 +(v1.4.0+) 可以在 [日志](./log.md) 中打开 DNS 查询日志。 ::: >`clientIp`: string @@ -143,11 +143,11 @@ DNS 服务器端口,如 `53`。此项缺省时默认为 `53`。当使用 DOH >`domains`: \[string\] -一个域名列表,此列表包含的域名,将优先使用此服务器进行查询。域名格式和 [路由配置](./routing#ruleobject) 中相同。 +一个域名列表,此列表包含的域名,将优先使用此服务器进行查询。域名格式和 [路由配置](./routing.md#ruleobject) 中相同。 >`expectIPs`:\[string\] -一个 IP 范围列表,格式和 [路由配置](./routing#ruleobject) 中相同。 +一个 IP 范围列表,格式和 [路由配置](./routing.md#ruleobject) 中相同。 当配置此项时,Xray DNS 会对返回的 IP 的进行校验,只返回包含 expectIPs 列表中的地址。 diff --git a/docs/config/fakedns.md b/docs/config/fakedns.md index d8b6b34fa..8e7207a31 100644 --- a/docs/config/fakedns.md +++ b/docs/config/fakedns.md @@ -27,7 +27,7 @@ FakeDNS 将使用此选项指定的 IP 块分配地址。 ### 如何使用? -FakeDNS 本质上是一个 [DNS 服务器](./dns#serverobject),能够与任意 DNS 规则配合使用。 +FakeDNS 本质上是一个 [DNS 服务器](./dns.md#serverobject),能够与任意 DNS 规则配合使用。 ::: tip 只有将 DNS 查询路由到 FakeDNS,才能使其发挥作用。 diff --git a/docs/config/inbound.md b/docs/config/inbound.md index 47ebb66cf..02566f631 100644 --- a/docs/config/inbound.md +++ b/docs/config/inbound.md @@ -1,6 +1,6 @@ # 入站代理 -入站连接用于接收发来的数据,可用的协议请见[inbound 可用协议列表](./inbounds)。 +入站连接用于接收发来的数据,可用的协议请见[inbound 可用协议列表](./inbounds/)。 ## InboundObject @@ -52,13 +52,13 @@ >`protocol`: string -连接协议名称,可选的协议类型见[inbound 可用协议列表](./inbounds)。 +连接协议名称,可选的协议类型见[inbound 可用协议列表](./inbounds/)。 >`settings`: InboundConfigurationObject 具体的配置内容,视协议不同而不同。详见每个协议中的 `InboundConfigurationObject`。 ->`streamSettings`: [StreamSettingsObject](./transport#streamsettingsobject) +>`streamSettings`: [StreamSettingsObject](./transport.md#streamsettingsobject) 底层传输方式(transport)是当前 Xray 节点和其它节点对接的方式 diff --git a/docs/config/outbound.md b/docs/config/outbound.md index 1c9e9e278..bf186d655 100644 --- a/docs/config/outbound.md +++ b/docs/config/outbound.md @@ -1,6 +1,6 @@ # 出站代理 -出站连接用于发送数据,可用的协议请见[outbound 可用协议列表](../outbounds/)。 +出站连接用于发送数据,可用的协议请见[outbound 可用协议列表](./outbounds/)。 ## OutboundObject @@ -46,7 +46,7 @@ 当其不为空时,其值必须在所有 `tag` 中 **唯一**。 ::: ->`streamSettings`: [StreamSettingsObject](./transport#streamsettingsobject) +>`streamSettings`: [StreamSettingsObject](./transport.md#streamsettingsobject) 底层传输方式(transport)是当前 Xray 节点和其它节点对接的方式 @@ -71,7 +71,7 @@ Mux 相关的具体配置。 当指定另一个outbound的标识时,此outbound发出的数据,将被转发至所指定的outbound发出。 ::: danger -这种转发方式**不经过**底层传输方式。如果需要使用支持底层传输方式的转发,请使用 [SockOpt.dialerProxy](./transport#sockoptobject)。 +这种转发方式**不经过**底层传输方式。如果需要使用支持底层传输方式的转发,请使用 [SockOpt.dialerProxy](./transport.md#sockoptobject)。 ::: ::: danger diff --git a/docs/config/policy.md b/docs/config/policy.md index 1e227abab..223302d36 100644 --- a/docs/config/policy.md +++ b/docs/config/policy.md @@ -92,11 +92,6 @@ Xray系统级别的策略 * 在 ARM64、MIPS64、MIPS64LE 平台上,默认值为 `4`。 * 在其它平台上,默认值为 `512`。 -::: tip -`bufferSize` 选项会覆盖 [环境变量](./examples/env#每个连接的缓存大小)中 `Xray.ray.buffer.size` 的设定。 -::: - - ### SystemPolicyObject ```json diff --git a/docs/config/reverse.md b/docs/config/reverse.md index c3b84468b..a755c8cf2 100644 --- a/docs/config/reverse.md +++ b/docs/config/reverse.md @@ -65,7 +65,7 @@ > `tag`: string -所有由 `bridge` 发出的连接,都会带有这个标识。可以在 [路由配置](./routing) 中使用 `inboundTag` 进行识别。 +所有由 `bridge` 发出的连接,都会带有这个标识。可以在 [路由配置](./routing.md) 中使用 `inboundTag` 进行识别。 > `domain`: string @@ -86,7 +86,7 @@ > `tag`: string -`portal` 的标识。在 [路由配置](./routing) 中使用 `outboundTag` 将流量转发到这个 `portal`。 +`portal` 的标识。在 [路由配置](./routing.md) 中使用 `outboundTag` 将流量转发到这个 `portal`。 > `domain`: string diff --git a/docs/config/routing.md b/docs/config/routing.md index f0196b563..5ef96b97d 100644 --- a/docs/config/routing.md +++ b/docs/config/routing.md @@ -103,7 +103,7 @@ * 子域名(推荐):由 `"domain:"` 开始,余下部分是一个域名。当此域名是目标域名或其子域名时,该规则生效。例如 "domain:xray.com" 匹配"www.xray.com"、"xray.com",但不匹配 "wxray.com"。 * 完整匹配:由 `"full:"` 开始,余下部分是一个域名。当此域名完整匹配目标域名时,该规则生效。例如 "full:xray.com" 匹配 "xray.com" 但不匹配"www.xray.com"。 * 预定义域名列表:由 `"geosite:"` 开头,余下部分是一个名称,如 `geosite:google` 或者 `geosite:cn`。名称及域名列表参考 [预定义域名列表](#预定义域名列表)。 -* 从文件中加载域名:形如 `"ext:file:tag"`,必须以 `ext:`(小写)开头,后面跟文件名和标签,文件存放在 [资源目录](./examples/env#资源文件路径) 中,文件格式与 `geosite.dat` 相同,标签必须在文件中存在。 +* 从文件中加载域名:形如 `"ext:file:tag"`,必须以 `ext:`(小写)开头,后面跟文件名和标签,文件存放在 [资源目录](./features/env.md#资源文件路径) 中,文件格式与 `geosite.dat` 相同,标签必须在文件中存在。 ::: tip `"ext:geoip.dat:cn"` 等价于 `"geoip:cn"` @@ -117,7 +117,7 @@ * [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing):形如 `"10.0.0.0/8"`。 * 预定义IP列表:此列表预置于每一个 Xray 的安装包中,文件名为 `geoip.dat`。使用方式形如 `"geoip:cn"`,必须以 `geoip:`(小写)开头,后面跟双字符国家代码,支持几乎所有可以上网的国家。 * 特殊值:`"geoip:private"`,包含所有私有地址,如 `127.0.0.1`。 -* 从文件中加载 IP:形如 `"ext:file:tag"`,必须以 `ext:`(小写)开头,后面跟文件名和标签,文件存放在 [资源目录](./examples/env#资源文件路径) 中,文件格式与 `geoip.dat` 相同标签必须在文件中存在。 +* 从文件中加载 IP:形如 `"ext:file:tag"`,必须以 `ext:`(小写)开头,后面跟文件名和标签,文件存放在 [资源目录](./features/env.md#资源文件路径) 中,文件格式与 `geoip.dat` 相同标签必须在文件中存在。 >`port`:number | string diff --git a/docs/config/stats.md b/docs/config/stats.md index c2aa08514..5631c056f 100644 --- a/docs/config/stats.md +++ b/docs/config/stats.md @@ -14,7 +14,7 @@ 目前统计信息不需要任何参数,只要 `StatsObject` 项存在,内部的统计即会开启。 -开启了统计以后, 只需在 [Policy](./policy) 中开启对应的项,就可以统计对应的数据。 +开启了统计以后, 只需在 [Policy](./policy.md) 中开启对应的项,就可以统计对应的数据。 ## 获取统计信息 diff --git a/docs/config/transport.md b/docs/config/transport.md index d2baaa180..e95484396 100644 --- a/docs/config/transport.md +++ b/docs/config/transport.md @@ -31,31 +31,31 @@ } ``` -> `tcpSettings`: [TcpObject](./transports/tcp) +> `tcpSettings`: [TcpObject](./transports/tcp.md) 针对 TCP 连接的配置。 -> `kcpSettings`: [KcpObject](./transports/mkcp) +> `kcpSettings`: [KcpObject](./transports/mkcp.md) 针对 mKCP 连接的配置。 -> `wsSettings`: [WebSocketObject](./transports/websocket) +> `wsSettings`: [WebSocketObject](./transports/websocket).md 针对 WebSocket 连接的配置。 -> `httpSettings`: [HttpObject](./transports/h2) +> `httpSettings`: [HttpObject](./transports/h2.md) 针对 HTTP/2 连接的配置。 -> `quicSettings`: [QuicObject](./transports/quic) +> `quicSettings`: [QuicObject](./transports/quic.md) 针对 QUIC 连接的配置。 -> `grpcSettings`: [GRPCObject](./transports/grpc) +> `grpcSettings`: [GRPCObject](./transports/grpc.md) 针对 gRPC 连接的配置。 -> `dsSettings`: [DomainSocketObject](./transports/domainsocket) +> `dsSettings`: [DomainSocketObject](./transports/domainsocket.md) 针对 Domain Socket 连接的配置。 @@ -96,7 +96,7 @@ 是否启用传输层加密,支持的选项有 - `"none"` 表示不加密(默认值) - `"tls"` 表示使用 [TLS](https://en.wikipedia.org/wiki/base/transport_Layer_Security)。 -- `"xtls"` 表示使用 [XTLS](./examples/xtls)。 +- `"xtls"` 表示使用 [XTLS](./features/xtls.md)。 > `tlsSettings`: [TLSObject](#tlsobject) @@ -105,7 +105,7 @@ TLS 配置。TLS 由 Golang 提供,通常情况下TLS协商的结果为使用 > `xtlsSettings`: [XTLSObject](#tlsobject) XTLS 配置。XTLS 是 Xray 的原创黑科技, 也是使 Xray 性能一骑绝尘的核心动力. -XTLS 与 TLS 有相同的安全性, 配置方式也和TLS一致. 点击此处查看[XTLS的技术细节剖析](./examples/xtls) +XTLS 与 TLS 有相同的安全性, 配置方式也和TLS一致. 点击此处查看[XTLS的技术细节剖析](./features/xtls.md) ::: danger TLS / XTLS 是目前最安全的传输加密方案, 且外部看来流量类型和正常上网具有一致性. @@ -113,31 +113,31 @@ TLS / XTLS 是目前最安全的传输加密方案, 且外部看来流量类型 当 `security` 的值从'tls'改为'xtls'时, 只需将`tlsSettings` 修改成为 `xtlsSettings` ::: -> `tcpSettings`: [TcpObject](./transports/tcp) +> `tcpSettings`: [TcpObject](./transports/tcp.md) 当前连接的 TCP 配置,仅当此连接使用 TCP 时有效。配置内容与上面的全局配置相同。 -> `kcpSettings`: [KcpObject](./transports/mkcp) +> `kcpSettings`: [KcpObject](./transports/mkcp.md) 当前连接的 mKCP 配置,仅当此连接使用 mKCP 时有效。配置内容与上面的全局配置相同。 -> `wsSettings`: [WebSocketObject](./transports/websocket) +> `wsSettings`: [WebSocketObject](./transports/websocket.md) 当前连接的 WebSocket 配置,仅当此连接使用 WebSocket 时有效。配置内容与上面的全局配置相同。 -> `httpSettings`: [HttpObject](./transports/h2) +> `httpSettings`: [HttpObject](./transports/h2.md) 当前连接的 HTTP/2 配置,仅当此连接使用 HTTP/2 时有效。配置内容与上面的全局配置相同。 -> `quicSettings`: [QUICObject](./transports/quic) +> `quicSettings`: [QUICObject](./transports/quic.md) 当前连接的 QUIC 配置,仅当此连接使用 QUIC 时有效。配置内容与上面的全局配置相同。 -> `grpcSettings`: [GRPCObject](./transports/grpc) +> `grpcSettings`: [GRPCObject](./transports/grpc.md) 当前连接的 gRPC 配置,仅当此连接使用 gRPC 时有效。配置内容与上面的全局配置相同。 -> `dsSettings`: [DomainSocketObject](./transports/domainsocket) +> `dsSettings`: [DomainSocketObject](./transports/domainsocket.md) 当前连接的 Domain socket 配置,仅当此连接使用 Domain socket 时有效。配置内容与上面的全局配置相同。 @@ -386,7 +386,7 @@ ocspStapling 检查更新时间间隔。 单位:秒 透明代理需要 Root 或 CAP\_NET\_ADMIN 权限。 ::: danger -当 [Dokodemo-door](./inbounds/dokodemo) 中指定了 `followRedirect`为`true`,且 Sockopt设置中的`tproxy` 为空时,Sockopt设置中的`tproxy` 的值会被设为 `"redirect"`。 +当 [Dokodemo-door](./inbounds/dokodemo.md) 中指定了 `followRedirect`为`true`,且 Sockopt设置中的`tproxy` 为空时,Sockopt设置中的`tproxy` 的值会被设为 `"redirect"`。 ::: > `domainStrategy`: "AsIs" | "UseIP" | "UseIPv4" | "UseIPv6" @@ -395,7 +395,7 @@ ocspStapling 检查更新时间间隔。 单位:秒 在目标地址为域名时, 配置相应的值, SysteDailer 的行为模式如下: - `"AsIs"`: 通过系统DNS服务器解析获取IP, 向此域名发出连接。 -- `"UseIP"`、`"UseIPv4"` 和 `"UseIPv6"`: Xray 使用[内置 DNS 服务器](../dns)解析获取IP, 向此域名发出连接。 +- `"UseIP"`、`"UseIPv4"` 和 `"UseIPv6"`: Xray 使用[内置 DNS 服务器](./dns.md)解析获取IP, 向此域名发出连接。 默认值为 `"AsIs"`。 diff --git a/docs/guide/README.md b/docs/guide/README.md index f33925d5d..c18b4c9cc 100644 --- a/docs/guide/README.md +++ b/docs/guide/README.md @@ -1,6 +1,4 @@ ---- -title: 快速入门 ---- +# 快速入门 > **这个章节将告诉您如何用最简单的方式获得Xray,并且开始使用Xray.** @@ -8,22 +6,22 @@ title: 快速入门 Xray支持各种平台,并且您可以从多种渠道和方式获得Xray的各种版本. -请点击[如何下载安装Xray](./install)以获取Xray +请点击[如何下载安装Xray](./install.md)以获取Xray ## 配置运行 下载并安装Xray后,只需对他进行配置即可使用. -请点击[如何配置运行Xray](./config)以学习最简单的配置方式. +请点击[如何配置运行Xray](./config.md)以学习最简单的配置方式. ## 命令参数 Xray有多种命令和参数可用,因此变得灵活和强大. -请点击[Xray的命令参数](./command)查看Xray的更多命令和参数用法. +请点击[Xray的命令参数](./command.md)查看Xray的更多命令和参数用法. ## 改进文档 -如果你有兴趣,请点击[使用文档](./document)帮助我们改进文档,或者点击页面下方的 `帮助我们改善此页面!` +如果你有兴趣,请点击[使用文档](./document.md)帮助我们改进文档,或者点击页面下方的 `帮助我们改善此页面!` 我们十分感谢每一位 contributor 作出的贡献!是你们让 Project X 变得更加强大! diff --git a/docs/guide/command.md b/docs/guide/command.md index 18d81ee03..e27a4ba8e 100644 --- a/docs/guide/command.md +++ b/docs/guide/command.md @@ -1,7 +1,4 @@ ---- -lang: zh-CN -title: 命令参数 ---- +# 命令参数 ::: tip Xray 使用 go 风格的命令及参数 @@ -112,6 +109,6 @@ xray uuid ::: tip 当`-config`没有指定时,Xray 将先后尝试从以下路径加载`config.json`: - 工作目录(Working Directory) -- [环境变量](../config/env)中`Xray.location.asset`所指定的路径 +- [环境变量](../config/features/env.md#资源文件路径)中`Xray.location.asset`所指定的路径 ::: diff --git a/docs/guide/config.md b/docs/guide/config.md index 8c8e9fb96..9e35207d3 100644 --- a/docs/guide/config.md +++ b/docs/guide/config.md @@ -1,13 +1,10 @@ ---- -lang: zh-CN -title: 配置运行 ---- +# 配置运行 [下载并安装](./install) 了 Xray 之后,您需要对它进行一下配置。 为了演示,这里只介绍简单的配置方式. -如需配置更复杂的功能,请参考更详细的 [配置文件](../../config) 中相关说明。 +如需配置更复杂的功能,请参考更详细的 [配置文件](../config/) 中相关说明。 ## 服务端配置 @@ -100,4 +97,4 @@ title: 配置运行 - 运行 `xray run -c /etc/xray/config.json` - 或使用 systemd 等工具将 Xray 作为服务在后台运行。 -更多详细的说明可以参考 [配置文档](../config) 和 [使用心得](../documents)。 +更多详细的说明可以参考 [配置文档](../config/) 和 [使用心得](../documents/)。 diff --git a/docs/guide/document.md b/docs/guide/document.md index ef6d225d5..00797cb6d 100644 --- a/docs/guide/document.md +++ b/docs/guide/document.md @@ -1,9 +1,4 @@ ---- -title: 使用文档 -lang: zh-CN ---- - -## 改进文档 +# 改进文档 Project X 的文档托管在[github](https://github.com/XTLS/XTLS.github.io)上. diff --git a/docs/guide/install.md b/docs/guide/install.md index 0b38e94b3..22577414b 100644 --- a/docs/guide/install.md +++ b/docs/guide/install.md @@ -1,9 +1,4 @@ ---- -date: "2020-12-23T00:00:00.000Z" -description: Project X 的文档. -title: 下载安装 -weight: 1 ---- +# 下载安装 ## 平台支持 diff --git a/docs/links.md b/docs/links.md index ea423761c..6f4f3b5c4 100644 --- a/docs/links.md +++ b/docs/links.md @@ -1,7 +1,4 @@ ---- -lang: zh-CN -title: 链接 ---- +# 链接 ## 安装脚本