Xray-docs-next/docs/config/inbound.md

136 lines
4.6 KiB
Markdown
Raw Normal View History

2021-03-15 15:59:11 +00:00
# 入站代理
2021-03-25 14:33:41 +00:00
入站连接用于接收发来的数据,可用的协议请见[inbound 可用协议列表](./inbounds/)。
2021-03-15 15:59:11 +00:00
## InboundObject
`InboundObject` 对应配置文件中 `inbounds` 项的一个子元素。
```json
{
"inbounds": [
{
"listen": "127.0.0.1",
"port": 1080,
"protocol": "协议名称",
"settings": {},
"streamSettings": {},
"tag": "标识",
"sniffing": {
"enabled": true,
"destOverride": ["http", "tls"]
},
"allocate": {
"strategy": "always",
"refresh": 5,
"concurrency": 3
}
}
]
}
```
2021-03-26 06:01:07 +00:00
> `listen`: address
2021-03-15 15:59:11 +00:00
监听地址IP 地址或 Unix domain socket默认值为 `"0.0.0.0"`,表示接收所有网卡上的连接.
可以指定一个系统可用的 IP 地址。
2021-03-20 15:25:07 +00:00
支持填写 Unix domain socket格式为绝对路径形如 `"/dev/shm/domain.socket"`,可在开头加 `@` 代表 [abstract](https://www.man7.org/linux/man-pages/man7/unix.7.html)`@@` 则代表带 padding 的 abstract。
2021-03-15 15:59:11 +00:00
填写 Unix domain socket 时,`port` 和 `allocate` 将被忽略,协议目前可选 VLESS、VMess、Trojan传输方式可选 TCP、WebSocket、HTTP/2。
2021-03-26 06:01:07 +00:00
> `port`: number | "env:variable" | string
2021-03-15 15:59:11 +00:00
端口。接受的格式如下:
- 整型数值:实际的端口号。
- 环境变量:以 `"env:"` 开头,后面是一个环境变量的名称,如 `"env:PORT"`。Xray 会以字符串形式解析这个环境变量。
- 字符串:可以是一个数值类型的字符串,如 `"1234"`;或者一个数值范围,如 `"5-10"` 表示端口 5 到端口 10这 6 个端口。
当只有一个端口时Xray 会在此端口监听入站连接。当指定了一个端口范围时,取决于 `allocate` 设置。
2021-03-26 06:01:07 +00:00
> `protocol`: string
2021-03-15 15:59:11 +00:00
2021-03-25 14:33:41 +00:00
连接协议名称,可选的协议类型见 [inbound 可用协议列表](./inbounds/)。
2021-03-15 15:59:11 +00:00
2021-03-26 06:01:07 +00:00
> `settings`: InboundConfigurationObject
2021-03-15 15:59:11 +00:00
具体的配置内容,视协议不同而不同。详见每个协议中的 `InboundConfigurationObject`
2021-03-26 06:01:07 +00:00
> `streamSettings`: [StreamSettingsObject](./transport.md#streamsettingsobject)
2021-03-15 15:59:11 +00:00
底层传输方式transport是当前 Xray 节点和其它节点对接的方式
2021-03-26 06:01:07 +00:00
> `tag`: string
> 此入站连接的标识,用于在其它的配置中定位此连接。
2021-03-15 15:59:11 +00:00
::: danger
2021-03-20 15:25:07 +00:00
当其不为空时,其值必须在所有 `tag` 中**唯一**。
2021-03-15 15:59:11 +00:00
:::
2021-03-26 06:01:07 +00:00
> `sniffing`: [SniffingObject](#sniffingobject)
2021-03-15 15:59:11 +00:00
流量探测主要作用于在透明代理等用途.
比如一个典型流程如下:
2021-03-26 06:01:07 +00:00
1. 如有一个设备上网,去访问 abc.com,首先设备通过 DNS 查询得到 abc.com 的 IP 是 1.2.3.4,然后设备会向 1.2.3.4 去发起连接.
2. 如果不设置嗅探,Xray 收到的连接请求是 1.2.3.4,并不能用于域名规则的路由分流.
3. 当设置了 sniffing 中的 enable 为 true,Xray 处理此连接的流量时,会从流量的数据中,嗅探出域名,即 abc.com
4. Xray 会把 1.2.3.4 重置为 abc.com.路由就可以根据域名去进行路由的域名规则的分流
2021-03-15 15:59:11 +00:00
2021-03-26 06:01:07 +00:00
因为变成了一个向 abc.com 请求的连接, 就可以做更多的事情, 除了路由域名规则分流, 还能重新做 DNS 解析等其他工作.
2021-03-15 15:59:11 +00:00
2021-03-26 06:01:07 +00:00
当设置了 sniffing 中的 enable 为 true, 还能嗅探出 bittorrent 类型的流量, 然后可以在路由中配置"protocol"项来设置规则处理 BT 流量, 比如服务端用来拦截 BT 流量, 或客户端固定转发 BT 流量到某个 VPS 去等.
2021-03-15 15:59:11 +00:00
2021-03-26 06:01:07 +00:00
> `allocate`: [AllocateObject](#allocateobject)
当设置了多个 port 时, 端口分配的具体设置
2021-03-15 15:59:11 +00:00
### SniffingObject
```json
{
"enabled": true,
"destOverride": ["http", "tls", "fakedns"],
"metadataOnly": false
}
```
2021-03-26 06:01:07 +00:00
> `enabled`: true | false
2021-03-15 15:59:11 +00:00
是否开启流量探测。
2021-03-26 06:01:07 +00:00
> `destOverride`: \["http" | "tls" | "fakedns" \]
2021-03-15 15:59:11 +00:00
当流量为指定类型时,按其中包括的目标地址重置当前连接的目标。
2021-03-26 06:01:07 +00:00
> `metadataOnly`: true | false
2021-03-15 15:59:11 +00:00
当启用时,将仅使用连接的元数据嗅探目标地址。此时,`http` 与 `tls` 将不能使用。
### AllocateObject
```json
{
"strategy": "always",
"refresh": 5,
"concurrency": 3
}
```
2021-03-26 06:01:07 +00:00
> `strategy`: "always" | "random"
端口分配策略。
2021-03-15 15:59:11 +00:00
- `"always"` 表示总是分配所有已指定的端口,`port` 中指定了多少个端口Xray 就会监听这些端口。
- `"random"` 表示随机开放端口,每隔 `refresh` 分钟在 `port` 范围中随机选取 `concurrency` 个端口来监听。
2021-03-26 06:01:07 +00:00
> `refresh`: number
2021-03-15 15:59:11 +00:00
随机端口刷新间隔,单位为分钟。最小值为 `2`,建议值为 `5`。这个属性仅当 `strategy` 设置为 `"random"` 时有效。
2021-03-26 06:01:07 +00:00
> `concurrency`: number
2021-03-15 15:59:11 +00:00
随机端口数量。最小值为 `1`,最大值为 `port` 范围的三分之一。建议值为 `3`