hysteria README

The project's README from github.com/HyNetworks/hysteria. As one markdown file: README.md.

Hysteria 2

License Release Telegram Discussions

Hysteria is a powerful, lightning-fast, and censorship-resistant proxy.

Get Started

中文文档

Hysteria 1.x (legacy)


🛠️ Jack of all trades

Wide range of modes including SOCKS5, HTTP Proxy, TCP/UDP Forwarding, Linux TProxy, TUN - with more features being added constantly.

⚡ Blazing fast

Powered by a customized QUIC protocol, Hysteria is designed to deliver unparalleled performance over unreliable and lossy networks.

✊ Censorship resistant

The protocol masquerades as standard HTTP/3 traffic, making it very difficult for censors to detect and block without widespread collateral damage.

💻 Cross-platform

We have builds for every major platform and architecture. Deploy anywhere & use everywhere. Not to mention the long list of 3rd party apps.

🔗 Easy integration

With built-in support for custom authentication, traffic statistics & access control, Hysteria is easy to integrate into your infrastructure.

🤗 Chill and supportive

We have well-documented specifications and code for developers to contribute and/or build their own apps. And a helpful community, too.


If you find Hysteria useful, consider giving it a ⭐️!

Star History Chart

hysteria (HyNetworks/hysteria)

relay
Searching Database…

22.7K ·GitHub
What is this?Hysteria is an open-source proxy tool — powerful, lightning-fast and censorship-resistant. It routes your traffic through a server you control with a protocol built to withstand blocking.
How do my apps actually connect through it?Through standard interfaces: the client exposes SOCKS5, HTTP Proxy, TCP/UDP Forwarding, Linux TProxy and TUN modes, so nearly any app can send its traffic via Hysteria.
How do I get it running?Grab a ready build for your platform and follow the Get Started guide linked at the top of the README.
Do I need to set up my own server for this to work?Yes — Hysteria is client-server software: you deploy the server side on a host outside the censored network (a Docker image is provided) and run the client on your own device.
How hard is it for censors to detect and block it?Very hard by design: the protocol masquerades as standard HTTP/3 traffic, so an attempt to block it would cause widespread collateral damage for the censor.
Will it run on my phone, or is it desktop-only?There are official builds for every major platform and architecture, plus a long list of third-party apps — desktops, servers and phones are all covered.
Why is it fast on poor or lossy connections?It runs on a customized QUIC protocol explicitly designed to deliver unparalleled performance over unreliable and lossy networks.
What does the server offer for integration into my infrastructure?Built-in support for custom authentication, traffic statistics and access control, which the README says makes Hysteria easy to integrate into your existing infrastructure.
Is the documentation available in Chinese?Yes — the README links a separate Chinese docs section (中文文档) right next to the English Get Started guide.
I keep finding Hysteria 1.x guides — should I follow them?Better not — the README marks Hysteria 1.x as legacy, so new setups should target the current version and its docs.
Creator
HyNetworks
Size
10.4 MB
Stars
22.7K
Age
6y
Commits · 90 Days