A rule-based tunnel in Go.
Go to file
Dreamacro 283e4e1f4f Update: README.md logo and badges 2018-06-23 00:44:28 +08:00
adapters Improve: gofmt -s for shadowsocks.go 2018-06-22 23:56:41 +08:00
constant Add: config hub route 2018-06-20 22:41:02 +08:00
docs Update: README.md logo and badges 2018-06-23 00:44:28 +08:00
hub Improve: add log level 2018-06-22 13:15:20 +08:00
observable Init: first commit 🎉 2018-06-10 22:50:03 +08:00
proxy Fixed: handle chunked data 2018-06-22 10:26:56 +08:00
rules Add: config hub route 2018-06-20 22:41:02 +08:00
tunnel Improve: add log level 2018-06-22 13:15:20 +08:00
.gitignore Init: first commit 🎉 2018-06-10 22:50:03 +08:00
.travis.yml Improve: ci config and Dockerfile & update dependencies 2018-06-18 18:24:11 +08:00
Dockerfile Improve: ci config and Dockerfile & update dependencies 2018-06-18 18:24:11 +08:00
Gopkg.lock Improve: ci config and Dockerfile & update dependencies 2018-06-18 18:24:11 +08:00
Gopkg.toml Improve: ci config and Dockerfile & update dependencies 2018-06-18 18:24:11 +08:00
LICENSE Initial commit 2018-06-10 22:28:14 +08:00
Makefile Add: add windows release 2018-06-20 23:00:16 +08:00
README.md Update: README.md logo and badges 2018-06-23 00:44:28 +08:00
main.go Add: external controller 2018-06-18 11:31:49 +08:00

README.md

Clash
Clash

A rule based proxy in Go.

Travis-CI

Features

  • HTTP/HTTPS and SOCKS proxy
  • Surge like configuration
  • GeoIP rule support

Install

You can build from source:

go get -u -v github.com/Dreamacro/clash

Pre-built binaries are available: release

Requires Go >= 1.10.

Daemon

Unfortunately, there is no native elegant way to implement golang's daemon.

So we can use third-party daemon tools like pm2, supervisor, and so on.

In the case of pm2, we can start the daemon this way:

pm2 start clash

If you have Docker installed, you can run clash directly using docker-compose.

Run clash in docker

Config

Configuration file at $HOME/.config/clash/config.ini

Below is a simple demo configuration file:

[General]
port = 7890
socks-port = 7891

# A RESTful API for clash
external-controller = 127.0.0.1:8080

[Proxy]
# name = ss, server, port, cipher, password
# The types of cipher are consistent with go-shadowsocks2
# support AEAD_AES_128_GCM AEAD_AES_192_GCM AEAD_AES_256_GCM AEAD_CHACHA20_POLY1305 AES-128-CTR AES-192-CTR AES-256-CTR AES-128-CFB AES-192-CFB AES-256-CFB CHACHA20-IETF XCHACHA20
Proxy1 = ss, server1, port, AEAD_CHACHA20_POLY1305, password
Proxy2 = ss, server2, port, AEAD_CHACHA20_POLY1305, password

[Proxy Group]
# url-test select which proxy will be used by benchmarking speed to a URL.
# name = url-test, [proxys], url, interval(second)
Proxy = url-test, Proxy1, Proxy2, http://www.google.com/generate_204, 300

[Rule]
DOMAIN-SUFFIX,google.com,Proxy
DOMAIN-KEYWORD,google,Proxy
DOMAIN-SUFFIX,ad.com,REJECT
GEOIP,CN,DIRECT
FINAL,,Proxy # note: there is two ","

TODO

  • Complementing the necessary rule operators