From fd13f997975071b0df27fc3a98813b95a9cdc785 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E9=A3=8E=E6=89=87=E6=BB=91=E7=BF=94=E7=BF=BC?= Date: Tue, 18 Jun 2024 15:18:01 +0800 Subject: [PATCH] splithttp CN docs --- docs/config/transports/splithttp.md | 81 ++++++++++++++++++++++++++++- 1 file changed, 80 insertions(+), 1 deletion(-) diff --git a/docs/config/transports/splithttp.md b/docs/config/transports/splithttp.md index e9bcca490..c0778eeee 100644 --- a/docs/config/transports/splithttp.md +++ b/docs/config/transports/splithttp.md @@ -1,3 +1,82 @@ # SplitHTTP -TODO + +使用HTTP分块传输编码下载,使用多个HTTP POST请求进行上传。 + +可以通过不支持WebSocket的CDN上,但仍有一些要求: + +- CDN必须支持HTTP分块传输,而且不会缓冲响应,核心将会发送 `X-Accel-Buffering: no` 以告知CDN,但是需要CDN遵守此标头。 + + 如果连接被挂起,该传输很可能无法工作 + +- CDN必须禁用缓存, 或者缓存查询字符串包含查询字符串。 + +上行效率可能非常有限 + +`SplitHTTP` 也接受 `X-Forwarded-For` header。 + +## SplitHttpObject + +The `SplitHttpObject` 对应传输配置的 `splithttpSettings` 项。 + +```json +{ + "path": "/", + "host": "xray.com", + "headers": { + "key": "value" + } +} +``` + +> `path`: string + +WebSocket 所使用的 HTTP 协议路径,默认值为 `"/"`。 + +> `host`: string + +WebSocket 的HTTP请求中所发送的host,默认值为空。若服务端值为空时,不验证客户端发送来的host值。 + +当在服务端指定该值,或在 ```headers``` 中指定host,将会校验与客户端请求host是否一致。 + +客户端选择发送的host优先级 ```host``` > ```headers``` > ```address``` + +> `headers`: map \{string: string\} + +自定义 HTTP 头,一个键值对,每个键表示一个 HTTP 头的名称,对应的值是字符串。 + +> `maxUploadSize`: int + +上传分块的最大大小,默认为 1 MB. + +这个值应该小于CDN或其他HTTP反向代理所允许的最大请求体,否则将抛出 HTTP 413 错误。 + +适当提升这个值可以增加上传速率。 + +> `maxConcurrentUploads`: int + +上传连接的最大并发数,默认为10, 连接将尽可能被重用。 + +如果连接不稳定或者服务端内存占用过高可以尝试调低。 + +客户端所设定的值必须低于服务端,否则可能导致连接问题。 + +## 已知问题 + +* ALPN 协商仍未正确实现,HTTPS连接将总是使用H2. + +## 协议细节 + +讨论与建议详见 [PR](https://github.com/XTLS/Xray-core/pull/3412),这里是实现简述。 + +1. 使用 `GET /?session=UUID` 打开一个新的“虚拟”流连接。服务器立即回复 `200 OK` 和 `Transfer Encoding:chunked`, 并立即发送一个两字节的有效负载,以强制HTTP中间盒刷新标头。 + +2. 一旦客户端完成协商,它可以使用 `POST /?session=UUID?seq=0` 开始发送上行数据. `seq` 作用类似于 TCP 序列号, 数据包可以被同时发送,服务端必须按序列号将数据重组。序列号不会重置 + +3. `GET` 请求将一直保持在打开状态直到连接被终止,服务端和客户端都可以关闭连接。具体行为取决于HTTP版本 + +建议: + +* 不要假设CDN会正确传输所有标头,这个协议是为了穿透不支持WS的CDN设计的,这些CDN的架构通常不怎么友好。 + +* 应该假设所有HTTP连接都没有流式传输,所以每个包的大小应该基于延迟、吞吐量以及中间盒本身的限制考虑(类似TCP的MTU与纳格算法)。