2018-06-23 00:44:28 +08:00
|
|
|
<h1 align="center">
|
|
|
|
|
<img src="https://github.com/Dreamacro/clash/raw/master/docs/logo.png" alt="Clash" width="200">
|
2019-02-11 15:55:17 +08:00
|
|
|
<br>Clash<br>
|
2018-06-23 00:44:28 +08:00
|
|
|
</h1>
|
|
|
|
|
|
2018-12-11 00:25:05 +08:00
|
|
|
<h4 align="center">A rule-based tunnel in Go.</h4>
|
2018-06-23 00:44:28 +08:00
|
|
|
|
|
|
|
|
<p align="center">
|
2019-12-08 12:34:05 +08:00
|
|
|
<a href="https://github.com/Dreamacro/clash/actions">
|
|
|
|
|
<img src="https://img.shields.io/github/workflow/status/Dreamacro/clash/Go?style=flat-square" alt="Github Actions">
|
|
|
|
|
</a>
|
2018-06-23 00:44:28 +08:00
|
|
|
<a href="https://goreportcard.com/report/github.com/Dreamacro/clash">
|
2019-02-11 15:55:17 +08:00
|
|
|
<img src="https://goreportcard.com/badge/github.com/Dreamacro/clash?style=flat-square">
|
2018-06-23 00:44:28 +08:00
|
|
|
</a>
|
|
|
|
|
<a href="https://github.com/Dreamacro/clash/releases">
|
|
|
|
|
<img src="https://img.shields.io/github/release/Dreamacro/clash/all.svg?style=flat-square">
|
|
|
|
|
</a>
|
|
|
|
|
</p>
|
2018-06-10 22:50:03 +08:00
|
|
|
|
|
|
|
|
## Features
|
|
|
|
|
|
2020-06-28 10:39:30 +08:00
|
|
|
- Local HTTP/HTTPS/SOCKS server with authentication support
|
|
|
|
|
- VMess, Shadowsocks, Trojan, Snell protocol support for remote connections
|
|
|
|
|
- Built-in DNS server that aims to minimize DNS pollution attack impact, supports DoH/DoT upstream and fake IP.
|
2020-03-20 12:35:30 +08:00
|
|
|
- Rules based off domains, GEOIP, IP CIDR or ports to forward packets to different nodes
|
|
|
|
|
- Remote groups allow users to implement powerful rules. Supports automatic fallback, load balancing or auto select node based off latency
|
|
|
|
|
- Remote providers, allowing users to get node lists remotely instead of hardcoding in config
|
2020-06-28 10:39:30 +08:00
|
|
|
- Netfilter TCP redirecting. Deploy Clash on your Internet gateway with `iptables`.
|
|
|
|
|
- Comprehensive HTTP RESTful API controller
|
2018-08-14 18:06:56 +08:00
|
|
|
|
2020-06-28 10:39:30 +08:00
|
|
|
## Getting Started
|
|
|
|
|
Documentations are now moved to [GitHub Wiki](https://github.com/Dreamacro/clash/wiki).
|
2019-04-15 19:05:01 +08:00
|
|
|
|
2020-03-20 12:35:30 +08:00
|
|
|
## Credits
|
2018-08-12 04:22:14 +08:00
|
|
|
|
2020-06-28 10:39:30 +08:00
|
|
|
* [riobard/go-shadowsocks2](https://github.com/riobard/go-shadowsocks2)
|
|
|
|
|
* [v2ray/v2ray-core](https://github.com/v2ray/v2ray-core)
|
2018-09-16 23:08:04 +08:00
|
|
|
|
2018-07-15 22:32:20 +08:00
|
|
|
## License
|
2018-08-12 04:22:14 +08:00
|
|
|
|
2020-06-28 10:39:30 +08:00
|
|
|
This software is released under the GPL-3.0 license.
|
|
|
|
|
|
2018-07-15 22:32:20 +08:00
|
|
|
[](https://app.fossa.io/projects/git%2Bgithub.com%2FDreamacro%2Fclash?ref=badge_large)
|
|
|
|
|
|
2018-06-10 22:50:03 +08:00
|
|
|
## TODO
|
|
|
|
|
|
2018-08-12 04:22:14 +08:00
|
|
|
- [x] Complementing the necessary rule operators
|
|
|
|
|
- [x] Redir proxy
|
2019-04-25 16:32:15 +08:00
|
|
|
- [x] UDP support
|
2019-12-08 12:34:05 +08:00
|
|
|
- [x] Connection manager
|
2020-07-22 21:34:37 +08:00
|
|
|
- [ ] ~~Event API~~
|
