From 581214ee130096bd7b8fd394042385b9f7972b37 Mon Sep 17 00:00:00 2001
From: xqzr <34030394+xqzr@users.noreply.github.com>
Date: Thu, 30 Sep 2021 01:13:53 +0800
Subject: [PATCH] Add health check for h2 (#130)

---
 docs/config/transports/h2.md | 16 +++++++++++++++-
 1 file changed, 15 insertions(+), 1 deletion(-)

diff --git a/docs/config/transports/h2.md b/docs/config/transports/h2.md
index 17eeb7886..36b02df58 100644
--- a/docs/config/transports/h2.md
+++ b/docs/config/transports/h2.md
@@ -27,7 +27,9 @@ HTTP/2 内置多路复用，不建议使用 HTTP/2 时启用 mux.cool。
 ```json
 {
   "host": ["xray.com"],
-  "path": "/random/path"
+  "path": "/random/path",
+  "read_idle_timeout": 10,
+  "health_check_timeout": 15
 }
 ```
 
@@ -42,3 +44,15 @@ HTTP/2 内置多路复用，不建议使用 HTTP/2 时启用 mux.cool。
 HTTP 路径，由 `/` 开头, 客户端和服务器必须一致。
 
 默认值为 `"/"`。
+
+> `read_idle_timeout` number
+
+单位秒，当这段时间内没有接收到数据时，将会进行健康检查。
+
+健康检查默认**不启用**。
+
+仅需在**客户端**配置。
+
+> `health_check_timeout` number
+
+单位秒，健康检查的超时时间。如果在这段时间内没有完成健康检查，即认为健康检查失败。默认值为 `15`。