From 4ea3ab335ac7e8caf3bf633bb38c8898ba1cb4aa Mon Sep 17 00:00:00 2001
From: Dnomd343 <dnomd343@163.com>
Date: Sat, 5 Mar 2022 23:18:37 +0800
Subject: [PATCH] docs: define of Hysteria proxy info

---
 docs/ProxyObject/Hysteria.md | 80 ++++++++++++++++++++++++++++++++++++
 1 file changed, 80 insertions(+)
 create mode 100644 docs/ProxyObject/Hysteria.md

diff --git a/docs/ProxyObject/Hysteria.md b/docs/ProxyObject/Hysteria.md
new file mode 100644
index 0000000..d9b376d
--- /dev/null
+++ b/docs/ProxyObject/Hysteria.md
@@ -0,0 +1,80 @@
+## Hysteria
+
+> **remark**
+> 
+> + 类型：*str*
+> + 说明：节点备注名称
+> + 缺省：''
+> + 可选值：不限
+
+```
+{
+    'type': 'hysteria',
+    'server': ...,
+    'port': ...,
+    'protocol': ...,
+    'obfs': ...,
+    'auth': ...,
+    'sni': ...,
+    'alpn': ...,
+    'verify': ...
+}
+```
+
+**server**
+
++ 类型：*str*
++ 说明：服务器地址
++ 缺省：必选
++ 可选值：合法的IP地址或域名
+
+**port**
+
++ 类型：*int*
++ 说明：服务器端口
++ 缺省：必选
++ 可选值：1 ～ 65535
+
+**protocol**
+
++ 类型：*str*
++ 说明：Hysteria连接方式
++ 缺省：'udp'
++ 可选值：`udp`,`wechat-video`,`faketcp`
+
+**obfs**
+
++ 类型：*None* / *str*
++ 说明：Hysteria混淆密码
++ 缺省：None
++ 可选值：不限
+
+**auth**
+
++ 类型：*None* / *str*
++ 说明：Hysteria验证密码
++ 缺省：None
++ 可选值：不限
+
+**sni**
+
++ 类型：*str*
++ 说明：TLS握手SNI字段
++ 缺省： ''
++ 可选值：不限
++ 建议值：合法域名
+
+**alpn**
+
++ 类型：*None* / *str*
++ 说明：TLS握手协商协议
++ 缺省：None
++ 可选值：不限
+
+**verify**
+
++ 类型：*bool*
++ 说明：是否验证服务端证书
++ 缺省：True
++ 可选值：不限
++ 建议值：True