Update READMEs

README.md

@@ -16,7 +16,7 @@
 
 [中文 README](README.zh.md)
 
-Hysteria is a TCP relay & SOCKS5/HTTP proxy tool optimized for networks of poor quality (e.g. satellite connections,
+Hysteria is a TCP/UDP relay & SOCKS5/HTTP proxy tool optimized for networks of poor quality (e.g. satellite connections,
 congested public Wi-Fi, connecting from China to servers abroad) powered by a custom version of QUIC protocol.
 
 It is essentially a spiritual successor of my abandoned project https://github.com/dragonite-network/dragonite-java
@@ -87,14 +87,19 @@ Same as the server side, create a `config.json` under the root directory of the
   "http": {
     "listen": "127.0.0.1:8080"
   },
-  "relay": {
+  "relay_tcp": {
     "listen": "127.0.0.1:2222",
     "remote": "123.123.123.123:22"
+  },
+  "relay_udp": {
+    "listen": "127.0.0.1:5333",
+    "remote": "8.8.8.8:53"
   }
 }
 ```
 
-This config enables a SOCKS5 proxy (with both TCP & UDP support), an HTTP proxy, and a TCP relay to `123.123.123.123:22`
+This config enables a SOCKS5 proxy (with both TCP & UDP support), an HTTP proxy, a TCP relay to `123.123.123.123:22` and
+a UDP relay to `8.8.8.8:53`
 at the same time. Please modify or remove these entries according to your actual needs.
 
 If your server certificate is not issued by a trusted CA, you need to specify the CA used
@@ -217,11 +222,16 @@ hysteria_traffic_uplink_bytes_total{auth="aGFja2VyISE="} 37452
     "cert": "/home/ubuntu/my_cert.crt", // Cert file (HTTPS proxy)
     "key": "/home/ubuntu/my_key.crt" // Key file (HTTPS proxy)
   },
-  "relay": {
+  "relay_tcp": {
-    "listen": "127.0.0.1:2222", // Relay listen address
+    "listen": "127.0.0.1:2222", // TCP relay Listen address
-    "remote": "123.123.123.123:22", // Relay remote address
+    "remote": "123.123.123.123:22", // TCP relay remote address
     "timeout": 300 // TCP timeout in seconds
   },
+  "relay_udp": {
+    "listen": "127.0.0.1:5333", // UDP relay Listen address
+    "remote": "8.8.8.8:53", // UDP relay remote address
+    "timeout": 60 // UDP session timeout in seconds
+  },
   "acl": "my_list.acl", // See ACL below
   "obfs": "AMOGUS", // Obfuscation password
   "auth": "[BASE64]", // Authentication payload in Base64

README.zh.md

@@ -14,7 +14,7 @@
 
 [6]: https://t.me/hysteria_github
 
-Hysteria 是专门针对恶劣网络环境进行优化的 TCP 连接转发和代理工具（双边加速），比如卫星网络、拥挤的公共 Wi-Fi、在中国连接国外服务器等。
+Hysteria 是专门针对恶劣网络环境进行优化的 TCP/UDP 转发和代理工具（双边加速），比如卫星网络、拥挤的公共 Wi-Fi、在中国连接国外服务器等。
 基于修改版的 QUIC 协议。
 
 是我此前弃坑的项目 https://github.com/dragonite-network/dragonite-java 的续作。
@@ -80,14 +80,19 @@ Hysteria 是专门针对恶劣网络环境进行优化的 TCP 连接转发和代
   "http": {
     "listen": "127.0.0.1:8080"
   },
-  "relay": {
+  "relay_tcp": {
     "listen": "127.0.0.1:2222",
     "remote": "123.123.123.123:22"
+  },
+  "relay_udp": {
+    "listen": "127.0.0.1:5333",
+    "remote": "8.8.8.8:53"
   }
 }
 ```
 
-这个配置同时开了 SOCK5 (支持 TCP & UDP) 代理，HTTP 代理和到 `123.123.123.123:22` 的 TCP 转发。请根据自己实际需要修改和删减。
+这个配置同时开了 SOCK5 (支持 TCP & UDP) 代理，HTTP 代理，到 `123.123.123.123:22` 的 TCP 转发和到 `8.8.8.8:53` 的 UDP 转发。
+请根据自己实际需要修改和删减。
 
 如果你的服务端证书不是由受信任的 CA 签发的，需要用 `"ca": "/path/to/file.ca"` 指定使用的 CA 或者用 `"insecure": true` 忽略所有
 证书错误（不推荐）。
@@ -205,11 +210,16 @@ hysteria_traffic_uplink_bytes_total{auth="aGFja2VyISE="} 37452
     "cert": "/home/ubuntu/my_cert.crt", // 证书 (变为 HTTPS 代理)
     "key": "/home/ubuntu/my_key.crt" // 证书密钥 (变为 HTTPS 代理)
   },
-  "relay": {
+  "relay_tcp": {
-    "listen": "127.0.0.1:2222", // 转发监听地址
+    "listen": "127.0.0.1:2222", // TCP 转发监听地址
-    "remote": "123.123.123.123:22", // 转发目标地址
+    "remote": "123.123.123.123:22", // TCP 转发目标地址
     "timeout": 300 // TCP 超时秒数
   },
+  "relay_udp": {
+    "listen": "127.0.0.1:5333", // UDP 转发监听地址
+    "remote": "8.8.8.8:53", // UDP 转发目标地址
+    "timeout": 60 // UDP 超时秒数
+  },
   "acl": "my_list.acl", // 见下文 ACL
   "obfs": "AMOGUS", // 混淆密码
   "auth": "[BASE64]", // Base64 验证密钥