add document for httpupgrade earlydata & custom header

v2fly · Jan 8, 2025 · 860813b · 860813b
1 parent 804d250
commit 860813b
Show file tree

Hide file tree

Showing 2 changed files with 34 additions and 0 deletions.
diff --git a/docs/en_US/v5/config/stream/httpupgrade.md b/docs/en_US/v5/config/stream/httpupgrade.md
@@ -16,3 +16,25 @@ Look at its [pull request](https://github.com/v2fly/v2ray-core/pull/2541) for wo
 > `host` : string
 
 The host domain name for HTTP request.
+
+> `maxEarlyData`: number
+
+The max number of bytes of early data. (v5.24.0)
+
+> `earlyDataHeaderName`: string
+
+The header name for WebSocket Early Data. (v5.24.0)
+
+> 'header': [ [Header](#header) ]
+
+The header to be sent in HTTP request. (v5.24.0)
+
+## Header
+
+> 'key' : string
+
+The HTTP header key.
+
+> 'value' : string
+
+The HTTP header value.
diff --git a/docs/v5/config/stream/httpupgrade.md b/docs/v5/config/stream/httpupgrade.md
@@ -16,3 +16,15 @@ HTTP 路径。
 > `host` : string
 
 HTTP 主机域名。
+
+> `maxEarlyData`: number
+
+所要发送的前置数据的最长长度。用于减少连接建立的时间。
+
+> `earlyDataHeaderName`: string
+> 
+发送的前置数据的 HTTP 头的名字，设置后启用基于 HTTP 头的前置数据。(v5.24.0)
+
+> `headers`: [ struct{ key, value string } ]
+
+自定义 HTTP 头，一个键值对，每个键表示一个 HTTP 头的名称，对应的值是字符串。默认值为空。(v5.24.0)