mirror of
https://github.com/apernet/hysteria.git
synced 2025-03-31 11:07:39 +03:00
chore: update README
This commit is contained in:
Toby
parent
dc7d62f6f8
commit
dadf6bf0ab
3 changed files with 53 additions and 52 deletions
3
CHANGELOG.md
Normal file
3
CHANGELOG.md
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
# Changelog
|
||||
|
||||
https://v2.hysteria.network/docs/Changelog/
|
||||
101
README.md
101
README.md
|
|
@ -1,62 +1,59 @@
|
|||
# Hysteria 2 Prototype
|
||||
# Hysteria 2
|
||||
|
||||
> **Warning**
|
||||
> The code on this branch is a work-in-progress prototype of what will become Hysteria 2.0. It is currently very
|
||||
> unfinished, and unless you know what you are doing, you should stick with the stable 1.x releases for now.
|
||||
|
||||
|
||||
> **警告**
|
||||
> 此分支的代码是 Hysteria 2.0 的原型，目前仍在开发中，完成度十分有限。除非你十分确定自己在做什么，否则请继续使用稳定的 1.x
|
||||
> 版本。
|
||||
[![License][1]][2] [![Release][3]][4] [![Telegram][5]][6] [![Discussions][7]][8]
|
||||
|
||||
## Build (编译)
|
||||
[1]: https://img.shields.io/badge/license-MIT-blue
|
||||
[2]: LICENSE.md
|
||||
[3]: https://img.shields.io/github/v/release/apernet/hysteria?style=flat-square
|
||||
[4]: https://github.com/apernet/hysteria/releases
|
||||
[5]: https://img.shields.io/badge/chat-Telegram-blue?style=flat-square
|
||||
[6]: https://t.me/hysteria_github
|
||||
[7]: https://img.shields.io/github/discussions/apernet/hysteria?style=flat-square
|
||||
[8]: https://github.com/apernet/hysteria/discussions
|
||||
|
||||
Use the environment variable `HY_APP_PLATFORMS` to control which platforms to build for. For
|
||||
example: `"windows/amd64,linux/amd64,linux/arm"`
|
||||
<h2 style="text-align: center;">Hysteria is a powerful, lightning fast and censorship resistant proxy.</h2>
|
||||
|
||||
用环境变量 `HY_APP_PLATFORMS` 来控制编译哪些平台的可执行文件。例如：`"windows/amd64,linux/amd64,linux/arm"`
|
||||
<p align="center">
|
||||
<a href="https://v2.hysteria.network/" style="padding: 14px 28px; background-color: #4A7B9D; color: white; border: none; border-radius: 8px; text-align: center; text-decoration: none; display: inline-block; font-size: 16px; margin: 4px 2px; cursor: pointer; box-shadow: 0px 4px 8px 0px rgba(0,0,0,0.25);">
|
||||
Get Started
|
||||
</a>
|
||||
<a href="https://v2.hysteria.network/zh/" style="padding: 14px 28px; background-color: #922D50; color: white; border: none; border-radius: 8px; text-align: center; text-decoration: none; display: inline-block; font-size: 16px; margin: 4px 2px; cursor: pointer; box-shadow: 0px 4px 8px 0px rgba(0,0,0,0.25);">
|
||||
中文文档
|
||||
</a>
|
||||
</p>
|
||||
|
||||
```bash
|
||||
python ./hyperbole.py build
|
||||
```
|
||||
---
|
||||
|
||||
Builds will be placed in `./build` (编译输出在 `./build` 目录下)
|
||||
<div class="feature-grid">
|
||||
<div>
|
||||
<h3>🛠️ Packed to the gills</h3>
|
||||
<p>Expansive range of modes including SOCKS5, HTTP proxy, TCP/UDP forwarding, Linux TProxy - not to mention additional features continually being added.</p>
|
||||
</div>
|
||||
|
||||
## Usage (使用)
|
||||
<div>
|
||||
<h3>⚡ Lightning fast</h3>
|
||||
<p>Powered by a custom QUIC protocol, Hysteria delivers unparalleled performance over even the most unreliable and lossy networks.</p>
|
||||
</div>
|
||||
|
||||
### Server
|
||||
<div>
|
||||
<h3>✊ Censorship resistant</h3>
|
||||
<p>Our protocol is designed to masquerade as standard HTTP/3 traffic, making it very difficult to detect and block without widespread collateral damage.</p>
|
||||
</div>
|
||||
|
||||
<div>
|
||||
<h3>💻 Cross-platform</h3>
|
||||
<p>We have builds for all major platforms and architectures. Deploy anywhere & use everywhere.</p>
|
||||
</div>
|
||||
|
||||
```bash
|
||||
./hysteria server -c config.yaml
|
||||
```
|
||||
|
||||
[Example sever config (示例服务器配置)](app/server.example.yaml)
|
||||
|
||||
### Client
|
||||
|
||||
```bash
|
||||
./hysteria client -c config.yaml
|
||||
```
|
||||
|
||||
[Example client config (示例客户端配置)](app/client.example.yaml)
|
||||
|
||||
## Logging (日志)
|
||||
|
||||
The following environment variables for controlling logging are supported:
|
||||
|
||||
- `HYSTERIA_LOG_LEVEL` - supported values are `debug`, `info`, `warn`, `error`
|
||||
|
||||
- `HYSTERIA_LOG_FORMAT` - supported values are `console`, `json`
|
||||
|
||||
支持通过以下环境变量来控制日志：
|
||||
|
||||
- `HYSTERIA_LOG_LEVEL` - 支持的值有 `debug`, `info`, `warn`, `error`
|
||||
|
||||
- `HYSTERIA_LOG_FORMAT` - 支持的值有 `console`, `json`
|
||||
|
||||
## Test HTTP/3 masquerading (测试 HTTP/3 伪装)
|
||||
|
||||
```bash
|
||||
chrome --origin-to-force-quic-on=example.com:443
|
||||
```
|
||||
|
||||
Then visit `https://example.com/` in Chrome.
|
||||
<div>
|
||||
<h3>🔗 Easy integration</h3>
|
||||
<p>With built-in support for custom authentication, traffic statistics & access control, Hysteria is easy to integrate into your infrastructure.</p>
|
||||
</div>
|
||||
|
||||
<div>
|
||||
<h3>🤗 Open standards</h3>
|
||||
<p>We have well-documented specifications and code for developers to contribute and build their own apps.</p>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
1
logo.svg
Normal file
1
logo.svg
Normal file
|
|
@ -0,0 +1 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?><svg id="Layer_1" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 1075.71 133.37"><defs><style>.cls-1{fill:#ffbc00;}</style></defs><polygon points="30.03 57.93 24.79 117.79 42.29 117.79 45.99 75.43 46.01 75.43 47.52 57.93 30.03 57.93"/><polygon points="51.21 15.57 33.72 15.57 31.43 41.81 48.92 41.81 51.21 15.57"/><polygon points="131.32 117.79 148.68 117.79 150.98 91.55 133.61 91.55 131.32 117.79"/><polygon points="157.61 15.58 140.25 15.58 135.78 66.68 91.2 66.68 85.37 133.37 120.77 83.26 180.95 83.26 182.4 66.68 153.14 66.68 157.61 15.58"/><polygon points="233.26 63.97 191.59 15.57 167.6 15.57 223.1 80.17 219.81 117.79 237.31 117.79 240.6 80.17 307.38 15.57 283.4 15.57 233.26 63.97"/><path d="m411.89,15.57h-79.05c-13.99,0-26.37,11.38-27.6,25.38l-.8,9.1c-1.22,13.99,9.16,25.37,23.16,25.37h73.26c4.35,0,7.59,3.54,7.2,7.89l-.8,9.09c-.38,4.35-4.23,7.88-8.58,7.88h-95.28l-1.53,17.49h95.28c13.92,0,26.24-11.38,27.46-25.37l.8-9.09c1.22-14-9.1-25.39-23.02-25.39h-73.26c-4.35,0-7.57-3.53-7.19-7.88l.8-9.1c.39-4.42,4.24-8.01,8.58-8.01h163.21l-7.42,84.85h17.5l7.42-84.85h53.13l1.52-17.36h-154.78Z"/><path d="m834.81,40.95c1.22-13.99-9.11-25.37-23.04-25.37h-98.64l-3.71,42.36h-117.55s1.49-16.99,1.49-16.99c.39-4.42,4.24-8.01,8.6-8.01h95.27l1.52-17.36h-95.27c-14,0-26.39,11.38-27.61,25.38l-4.5,51.46c-1.22,13.99,9.17,25.37,23.17,25.37h95.27l1.53-17.49h-95.27c-4.35,0-7.59-3.53-7.21-7.88l1.49-16.99h216.2c4.35,0,7.57,3.55,7.19,7.9l-3.02,34.46h17.36l3.02-34.47c.53-6.17-1.14-12.04-4.72-16.64,4.39-4.62,7.08-10.48,7.62-16.63l.81-9.11Zm-18.17,9.1c-.38,4.35-4.22,7.88-8.56,7.88h-81.16l2.19-25h81.14c4.34,0,7.57,3.59,7.19,8.01l-.81,9.1Z"/><polygon points="707.18 83.72 704.21 117.79 721.7 117.79 724.67 83.72 707.18 83.72"/><polygon points="842.46 117.79 859.95 117.79 868.89 15.57 851.4 15.57 842.46 117.79"/><path d="m981.9,15.57h-73.24c-14,0-26.39,11.38-27.61,25.38l-6.72,76.83h17.49l6.72-76.83c.39-4.42,4.24-8.02,8.6-8.02h73.24c4.36,0,7.58,3.6,7.2,8.02l-1.49,16.98h-80.75l-1.53,17.49h80.75l-3.71,42.36h17.35l6.72-76.83c1.22-14-9.11-25.38-23.03-25.38Z"/><path d="m1033.98,40.73h29.75c5.89,0,11.1-4.81,11.62-10.73l.32-3.69c.52-5.92-3.85-10.73-9.74-10.73h-39.12l-.69,7.89h39.12c1.53,0,2.67,1.27,2.53,2.84l-.32,3.69c-.13,1.53-1.49,2.78-3.02,2.78h-29.75c-5.92,0-11.15,4.81-11.67,10.73l-1.26,14.42h49.86l.7-7.95h-41.91l.57-6.47c.13-1.53,1.49-2.78,3.02-2.78Z"/><polygon class="cls-1" points="61.63 50.11 1.45 50.11 0 66.68 91.2 66.68 97.03 0 61.63 50.11"/></svg>
|
||||
|
After Width: | Height: | Size: 2.4 KiB |
Loading…
Add table
Add a link
Reference in a new issue