mirror of
https://github.com/cmz0228/hysteria-dev.git
synced 2025-06-08 13:29:53 +00:00
Minor README improvements
This commit is contained in:
parent
6ecd4bd9b8
commit
fc4d573f3d
26
README.md
26
README.md
@ -16,11 +16,10 @@
|
|||||||
|
|
||||||
[中文 README](README.zh.md)
|
[中文 README](README.zh.md)
|
||||||
|
|
||||||
Hysteria is a TCP relay & SOCKS5/HTTP proxy tool optimized for poor network environments (satellite networks,
|
Hysteria is a TCP relay & SOCKS5/HTTP proxy tool optimized for networks of poor quality (e.g. satellite connections,
|
||||||
connections from China to foreign servers, etc.) powered by a custom version of QUIC protocol.
|
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 previous (now abandoned)
|
It is essentially a spiritual successor of my abandoned project https://github.com/dragonite-network/dragonite-java
|
||||||
project https://github.com/dragonite-network/dragonite-java
|
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
@ -31,8 +30,8 @@ project https://github.com/dragonite-network/dragonite-java
|
|||||||
|
|
||||||
## Quick Start
|
## Quick Start
|
||||||
|
|
||||||
Note: The configs provided in this section are only for people to get started quickly and may not meet your needs.
|
Note: This is only a bare-bones example to get the server and client running. Go to [Advanced usage](#advanced-usage)
|
||||||
Please go to [Advanced usage](#advanced-usage) to see all the available options and their meanings.
|
for all the available options.
|
||||||
|
|
||||||
### Server
|
### Server
|
||||||
|
|
||||||
@ -49,15 +48,16 @@ Create a `config.json` under the root directory of the program:
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
A TLS certificate (not necessarily issued by a trusted CA) is required on the server side.
|
A TLS certificate is required on the server side. It does not have to be valid and trusted, but in that case the clients
|
||||||
|
need additional configuration.
|
||||||
|
|
||||||
The (optional) `obfs` option obfuscates the protocol using the provided password, so that it is not apparent that this
|
The (optional) `obfs` option obfuscates the protocol using the provided password, so that it is not apparent that this
|
||||||
is Hysteria/QUIC, which could be useful for bypassing DPI blocking or QoS. If the passwords of the server and client do
|
is Hysteria/QUIC, which could be useful for bypassing DPI blocking or QoS. If the passwords of the server and client do
|
||||||
not match, no connection can be established. Therefore, this can also serve as a simple password authentication. For
|
not match, no connection can be established. Therefore, this can also serve as a simple password authentication. For
|
||||||
more advanced authentication schemes, see `auth` below.
|
more advanced authentication schemes, see `auth` below.
|
||||||
|
|
||||||
`up_mbps` and `down_mbps` limit the maximum upload and download speed of the server for each client. These are also
|
`up_mbps` and `down_mbps` limit the maximum upload and download speed of the server for each client. Feel free to remove
|
||||||
optional and can be removed if not needed.
|
them if you don't need.
|
||||||
|
|
||||||
To launch the server, simply run
|
To launch the server, simply run
|
||||||
|
|
||||||
@ -95,19 +95,19 @@ Same as the server side, create a `config.json` under the root directory of the
|
|||||||
```
|
```
|
||||||
|
|
||||||
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, and a TCP relay to `123.123.123.123:22`
|
||||||
at the same time. Please modify or remove these entries depending on your actual needs.
|
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
|
If your server certificate is not issued by a trusted CA, you need to specify the CA used
|
||||||
with `"ca": "/path/to/file.ca"` on the client or use `"insecure": true` to ignore all certificate errors (not
|
with `"ca": "/path/to/file.ca"` on the client or use `"insecure": true` to ignore all certificate errors (not
|
||||||
recommended).
|
recommended).
|
||||||
|
|
||||||
`up_mbps` and `down_mbps` are mandatory on the client side. Please try to fill in these values as accurately as possible
|
`up_mbps` and `down_mbps` are mandatory on the client side. Try to fill in these values as accurately as possible
|
||||||
according to your network conditions. They are crucial for Hysteria to work in an optimal state.
|
according to your network conditions, as they are crucial for Hysteria to work optimally.
|
||||||
|
|
||||||
Some users may attempt to forward other encrypted proxy protocols such as Shadowsocks with relay. While this technically
|
Some users may attempt to forward other encrypted proxy protocols such as Shadowsocks with relay. While this technically
|
||||||
works, it's not optimal from a performance standpoint - Hysteria itself uses TLS, considering that the proxy protocol
|
works, it's not optimal from a performance standpoint - Hysteria itself uses TLS, considering that the proxy protocol
|
||||||
being forwarded is also encrypted, and the fact that almost all sites are now using HTTPS, it essentially becomes triple
|
being forwarded is also encrypted, and the fact that almost all sites are now using HTTPS, it essentially becomes triple
|
||||||
encryption. If you need a proxy, just use our proxy modes.
|
encryption. If you need a proxy, just use our proxy mode.
|
||||||
|
|
||||||
## Comparison
|
## Comparison
|
||||||
|
|
||||||
|
10
README.zh.md
10
README.zh.md
@ -14,10 +14,10 @@
|
|||||||
|
|
||||||
[6]: https://t.me/hysteria_github
|
[6]: https://t.me/hysteria_github
|
||||||
|
|
||||||
Hysteria 是专门针对恶劣网络环境(常见于卫星网络、在中国连接国外服务器等)进行优化的 TCP 连接转发和代理工具(即所谓的双边加速),
|
Hysteria 是专门针对恶劣网络环境进行优化的 TCP 连接转发和代理工具(双边加速),比如卫星网络、拥挤的公共 Wi-Fi、在中国连接国外服务器等。
|
||||||
基于修改版的 QUIC 协议。
|
基于修改版的 QUIC 协议。
|
||||||
|
|
||||||
可以理解为是我此前弃坑的项目 https://github.com/dragonite-network/dragonite-java 的续作。
|
是我此前弃坑的项目 https://github.com/dragonite-network/dragonite-java 的续作。
|
||||||
|
|
||||||
## 下载安装
|
## 下载安装
|
||||||
|
|
||||||
@ -28,7 +28,7 @@ Hysteria 是专门针对恶劣网络环境(常见于卫星网络、在中国
|
|||||||
|
|
||||||
## 快速入门
|
## 快速入门
|
||||||
|
|
||||||
注意:本节提供的配置只是为了快速上手,可能无法满足你的需求。请到 [高级用法](#高级用法) 中查看所有可用选项及其含义。
|
注意:本节提供的配置只是为了快速上手,可能无法满足你的需求。请到 [高级用法](#高级用法) 中查看所有可用选项与含义。
|
||||||
|
|
||||||
### 服务器
|
### 服务器
|
||||||
|
|
||||||
@ -45,9 +45,9 @@ Hysteria 是专门针对恶劣网络环境(常见于卫星网络、在中国
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
服务端必须要一个 TLS 证书(但并非一定要受信 CA 签发的)。
|
服务端需要一个 TLS 证书,但未必一定要是有效、可信的。(只是在这种情况下客户端需要进行额外的配置)
|
||||||
|
|
||||||
`obfs` 选项使用提供的密码对协议进行混淆,这样协议就不容易被检测出是 Hysteria/QUIC,可以用来绕过针对性的 DPI 屏蔽或者 QoS。
|
可选的 `obfs` 选项使用提供的密码对协议进行混淆,这样协议就不容易被检测出是 Hysteria/QUIC,可以用来绕过针对性的 DPI 屏蔽或者 QoS。
|
||||||
如果服务端和客户端的密码不匹配就不能建立连接,因此这也可以作为一个简单的密码验证。对于更高级的验证方案请见下文 `auth`。
|
如果服务端和客户端的密码不匹配就不能建立连接,因此这也可以作为一个简单的密码验证。对于更高级的验证方案请见下文 `auth`。
|
||||||
|
|
||||||
`up_mbps` 和 `down_mbps` 限制服务器对每个客户端的最大上传和下载速度。这些也是可选的,如果不需要可以移除。
|
`up_mbps` 和 `down_mbps` 限制服务器对每个客户端的最大上传和下载速度。这些也是可选的,如果不需要可以移除。
|
||||||
|
Loading…
x
Reference in New Issue
Block a user