Add: document level-1&2

This commit is contained in:
JimhHan
2021-03-25 22:33:41 +08:00
parent d0627944b2
commit c58fabe474
44 changed files with 3343 additions and 217 deletions
+11 -11
View File
@@ -32,46 +32,46 @@ Xray 的配置文件为 json 格式, 客户端和服务端的配置格式没有
## 基础配置模块
> log:[LogObject](./basis/log.md)
> log:[LogObject](./log.md)
日志配置,控制 Xray输出日志的方式.
> api:[ApiObject](./basis/api.md)
> api:[ApiObject](./api.md)
提供了一些API接口供远程调用。
> dns: [DnsObject](./basis/dns.md)
> dns: [DnsObject](./dns.md)
内置的 DNS 服务器. 如果没有配置此项,则使用系统的 DNS 设置。
> routing: [RoutingObject](./basis/routing.md)
> routing: [RoutingObject](./routing.md)
路由功能。可以设置规则分流数据从不同的outbound发出.
> policy: [PolicyObject](./basis/policy.md)
> policy: [PolicyObject](./policy.md)
本地策略,可以设置不同的用户等级和对应的策略设置。
> inbounds: \[ [InboundObject](./basis/inbound.md) \]
> inbounds: \[ [InboundObject](./inbound.md) \]
一个数组,每个元素是一个入站连接配置。
> outbounds: \[ [OutboundObject](./basis/outbound.md) \]
> outbounds: \[ [OutboundObject](./outbound.md) \]
一个数组,每个元素是一个出站连接配置。
> transport: [TransportObject](./basis/transport.md)
> transport: [TransportObject](./transport.md)
用于配置 Xray 其它服务器建立和使用网络连接的方式。
> stats: [StatsObject](./basis/stats.md)
> stats: [StatsObject](./stats.md)
用于配置流量数据的统计。
> reverse: [ReverseObject](./basis/reverse.md)
> reverse: [ReverseObject](./reverse.md)
反向代理。可以把服务器端的流量向客户端转发,即逆向流量转发
> fakedns: [FakeDnsObject](./basis/fakedns.md)
> fakedns: [FakeDnsObject](./fakedns.md)
FakeDNS. 可配合透明代理使用,以获取实际域名。

Before

Width:  |  Height:  |  Size: 659 KiB

After

Width:  |  Height:  |  Size: 659 KiB

@@ -1,6 +1,6 @@
# 入站代理
入站连接用于接收发来的数据,可用的协议请见[inbound 可用协议列表](../inbounds/)。
入站连接用于接收发来的数据,可用的协议请见[inbound 可用协议列表](./inbounds/)。
## InboundObject
@@ -52,7 +52,7 @@
>`protocol`: string
连接协议名称,可选的协议类型见 [inbound 可用协议列表](../inbounds/)。
连接协议名称,可选的协议类型见 [inbound 可用协议列表](./inbounds/)。
>`settings`: InboundConfigurationObject
@@ -1,6 +1,6 @@
# 出站代理
出站连接用于发送数据,可用的协议请见 [outbound 可用协议列表](../outbounds/)。
出站连接用于发送数据,可用的协议请见 [outbound 可用协议列表](./outbounds/)。
## OutboundObject
@@ -34,7 +34,7 @@
用于发送数据的 IP 地址,当主机有多个 IP 地址时有效,默认值为 `"0.0.0.0"`。
>`protocol`: string
连接协议名称,可选的协议类型见 [outbound 可用协议列表](../outbounds/)。
连接协议名称,可选的协议类型见 [outbound 可用协议列表](./outbounds/)。
>`settings`: OutboundConfigurationObject
具体的配置内容,视协议不同而不同。详见每个协议中的 `OutboundConfigurationObject`。
@@ -29,31 +29,31 @@
}
```
> `tcpSettings`: [TcpObject](../transports/tcp.md)
> `tcpSettings`: [TcpObject](./transports/tcp.md)
针对 TCP 连接的配置。
> `kcpSettings`: [KcpObject](../transports/mkcp.md)
> `kcpSettings`: [KcpObject](./transports/mkcp.md)
针对 mKCP 连接的配置。
> `wsSettings`: [WebSocketObject](../transports/websocket.md)
> `wsSettings`: [WebSocketObject](./transports/websocket.md)
针对 WebSocket 连接的配置。
> `httpSettings`: [HttpObject](../transports/h2.md)
> `httpSettings`: [HttpObject](./transports/h2.md)
针对 HTTP/2 连接的配置。
> `quicSettings`: [QuicObject](../transports/quic.md)
> `quicSettings`: [QuicObject](./transports/quic.md)
针对 QUIC 连接的配置。
> `grpcSettings`: [GRPCObject](../transports/grpc.md)
> `grpcSettings`: [GRPCObject](./transports/grpc.md)
针对 gRPC 连接的配置。
> `dsSettings`: [DomainSocketObject](../transports/domainsocket.md)
> `dsSettings`: [DomainSocketObject](./transports/domainsocket.md)
针对 Domain Socket 连接的配置。
@@ -111,31 +111,31 @@ TLS / XTLS 是目前最安全的传输加密方案, 且外部看来流量类型
当 `security` 的值从 `tls` 改为 `xtls` 时, 只需将 `tlsSettings` 修改成为 `xtlsSettings`
:::
> `tcpSettings`: [TcpObject](../transports/tcp.md)
> `tcpSettings`: [TcpObject](./transports/tcp.md)
当前连接的 TCP 配置,仅当此连接使用 TCP 时有效。配置内容与上面的全局配置相同。
> `kcpSettings`: [KcpObject](../transports/mkcp.md)
> `kcpSettings`: [KcpObject](./transports/mkcp.md)
当前连接的 mKCP 配置,仅当此连接使用 mKCP 时有效。配置内容与上面的全局配置相同。
> `wsSettings`: [WebSocketObject](../transports/websocket.md)
> `wsSettings`: [WebSocketObject](./transports/websocket.md)
当前连接的 WebSocket 配置,仅当此连接使用 WebSocket 时有效。配置内容与上面的全局配置相同。
> `httpSettings`: [HttpObject](../transports/h2.md)
> `httpSettings`: [HttpObject](./transports/h2.md)
当前连接的 HTTP/2 配置,仅当此连接使用 HTTP/2 时有效。配置内容与上面的全局配置相同。
> `quicSettings`: [QUICObject](../transports/quic.md)
> `quicSettings`: [QUICObject](./transports/quic.md)
当前连接的 QUIC 配置,仅当此连接使用 QUIC 时有效。配置内容与上面的全局配置相同。
> `grpcSettings`: [GRPCObject](../transports/grpc.md)
> `grpcSettings`: [GRPCObject](./transports/grpc.md)
当前连接的 gRPC 配置,仅当此连接使用 gRPC 时有效。配置内容与上面的全局配置相同。
> `dsSettings`: [DomainSocketObject](../transports/domainsocket.md)
> `dsSettings`: [DomainSocketObject](./transports/domainsocket.md)
当前连接的 Domain socket 配置,仅当此连接使用 Domain socket 时有效。配置内容与上面的全局配置相同。