Clash
Clash

A rule based proxy in Go.

Travis-CI

## Features - HTTP/HTTPS and SOCKS proxy - Surge like configuration - GeoIP rule support - Support Vmess/Shadowsocks/Socks5 - Support for Netfilter TCP redirect ## Discussion [Telegram Group](https://t.me/clash_discuss) ## Install You can build from source: ```sh go get -u -v github.com/Dreamacro/clash ``` Pre-built binaries are available: [release](https://github.com/Dreamacro/clash/releases) 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](https://github.com/Unitech/pm2), we can start the daemon this way: ```sh pm2 start clash ``` If you have Docker installed, you can run clash directly using `docker-compose`. [Run clash in docker](https://github.com/Dreamacro/clash/wiki/Run-clash-in-docker) ## Config **NOTE: after v0.8.0, clash using yaml as configuration file** The default configuration directory is `$HOME/.config/clash` The name of the configuration file is `config.yml` If you want to use another directory, you can use `-d` to control the configuration directory For example, you can use the current directory as the configuration directory ```sh clash -d . ``` Below is a simple demo configuration file: ```yml # port of HTTP port: 7890 # port of SOCKS5 socks-port: 7891 # redir proxy for Linux and macOS # redir-port: 7892 allow-lan: false # Rule / Global/ Direct (default is Rule) mode: Rule # set log level to stdout (default is info) # info / warning / error / debug log-level: info # A RESTful API for clash external-controller: 127.0.0.1:9090 # Secret for RESTful API (Optional) # secret: "" Proxy: # shadowsocks # 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 # In addition to what go-shadowsocks2 supports, it also supports chacha20 rc4-md5 xchacha20-ietf-poly1305 - { name: "ss1", type: ss, server: server, port: 443, cipher: AEAD_CHACHA20_POLY1305, password: "password" } - { name: "ss2", type: ss, server: server, port: 443, cipher: AEAD_CHACHA20_POLY1305, password: "password", obfs: tls, obfs-host: bing.com } # vmess # cipher support auto/aes-128-gcm/chacha20-poly1305/none - { name: "vmess", type: vmess, server: server, port: 443, uuid: uuid, alterId: 32, cipher: auto } # with tls - { name: "vmess", type: vmess, server: server, port: 443, uuid: uuid, alterId: 32, cipher: auto, tls: true } # with tls and skip-cert-verify - { name: "vmess", type: vmess, server: server, port: 443, uuid: uuid, alterId: 32, cipher: auto, tls: true, skip-cert-verify: true } # with ws - { name: "vmess", type: vmess, server: server, port: 443, uuid: uuid, alterId: 32, cipher: auto, network: ws, ws-path: /path } # with ws + tls - { name: "vmess", type: vmess, server: server, port: 443, uuid: uuid, alterId: 32, cipher: auto, network: ws, ws-path: /path, tls: true } # socks5 - { name: "socks", type: socks5, server: server, port: 443 } # with tls - { name: "socks", type: socks5, server: server, port: 443, tls: true } # with tls and skip-cert-verify - { name: "socks", type: socks5, server: server, port: 443, tls: true, skip-cert-verify: true } Proxy Group: # url-test select which proxy will be used by benchmarking speed to a URL. - { name: "auto", type: url-test, proxies: ["ss1", "ss2", "vmess1"], url: http://www.gstatic.com/generate_204, interval: 300 } # fallback select an available policy by priority. The availability is tested by accessing an URL, just like an auto url-test group. - { name: "fallback-auto", type: fallback, proxies: ["ss1", "ss2", "vmess1"], url: http://www.gstatic.com/generate_204, interval: 300 } # select is used for selecting proxy or proxy group # you can use RESTful API to switch proxy, is recommended for use in GUI. - { name: "Proxy", type: select, proxies: ["ss1", "ss2", "vmess1", "auto"] } Rule: - DOMAIN-SUFFIX,google.com,Proxy - DOMAIN-KEYWORD,google,Proxy - DOMAIN,google.com,Proxy - DOMAIN-SUFFIX,ad.com,REJECT - IP-CIDR,127.0.0.0/8,DIRECT - GEOIP,CN,DIRECT # note: there is two "," - FINAL,,Proxy ``` ## Thanks [riobard/go-shadowsocks2](https://github.com/riobard/go-shadowsocks2) [v2ray/v2ray-core](https://github.com/v2ray/v2ray-core) ## License [![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2FDreamacro%2Fclash.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2FDreamacro%2Fclash?ref=badge_large) ## TODO - [x] Complementing the necessary rule operators - [x] Redir proxy - [ ] UDP support - [ ] Connection manager