gosuto/clash repository overview

⁠
Clash

⁠A rule-based tunnel in Go.

⁠ ⁠ ⁠

⁠Features

• Local HTTP/HTTPS/SOCKS server with/without authentication
• VMess, Shadowsocks, Trojan (experimental), Snell protocol support for remote connections. UDP is supported.
• Built-in DNS server that aims to minimize DNS pollution attacks, supports DoH/DoT upstream. Fake IP is also supported.
• 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
• Netfilter TCP redirecting. You can deploy Clash on your Internet gateway with iptables.
• Comprehensive HTTP API controller

⁠Install

Clash requires Go >= 1.13. You can build it from source:

$ go get -u -v github.com/Hk-Gosuto/clash

Pre-built binaries are available here: release⁠ Pre-built Premium binaries are available here: Premium release⁠. Source is not currently available.

Check Clash version with:

$ clash -v

⁠Daemonize Clash

Unfortunately, there is no native or elegant way to implement daemons on Golang. We recommend using third-party daemon management tools like PM2, Supervisor or the like to keep Clash running as a service.

In the case of pm2⁠, start the daemon this way:

$ pm2 start clash

If you have Docker installed, it's recommended to deploy Clash directly using docker-compose: run Clash in Docker⁠

⁠Config

The default configuration directory is $HOME/.config/clash.

The name of the configuration file is config.yaml.

If you want to use another directory, use -d to control the configuration directory.

For example, you can use the current directory as the configuration directory:

$ clash -d .

⁠Advanced

Provider⁠

⁠Documentations

https://clash.gitbook.io/⁠

⁠Credits

riobard/go-shadowsocks2⁠

v2ray/v2ray-core⁠

⁠License

⁠TODO

• Complementing the necessary rule operators
• Redir proxy
• UDP support
• Connection manager
• Event API