mirror of https://gitclone.com/github.com/MetaCubeX/Clash.Meta synced 2024-11-14 21:31:16 +08:00

Go to file

Dreamacro 5c7fa6b18b Break Change: use yml, which is easier to parse, as the config format		2018-10-02 15:26:36 +08:00
adapters	Break Change: use yml, which is easier to parse, as the config format	2018-10-02 15:26:36 +08:00
common	Feat: add structure helper	2018-09-30 16:30:11 +08:00
component	Chore: make the code more semantic	2018-09-30 12:25:52 +08:00
config	Break Change: use yml, which is easier to parse, as the config format	2018-10-02 15:26:36 +08:00
constant	Break Change: use yml, which is easier to parse, as the config format	2018-10-02 15:26:36 +08:00
docs	Update: README.md logo and badges	2018-06-23 00:44:28 +08:00
hub	Chore: make the code more semantic	2018-09-30 12:25:52 +08:00
proxy	Chore: make the code more semantic	2018-09-30 12:25:52 +08:00
rules	Chore: make the code more semantic	2018-09-30 12:25:52 +08:00
tunnel	Chore: make the code more semantic	2018-09-30 12:25:52 +08:00
.gitignore	Init: first commit 🎉	2018-06-10 22:50:03 +08:00
.travis.yml	Feature: repalce dep with go module	2018-10-01 19:38:54 +08:00
Dockerfile	Feature: repalce dep with go module	2018-10-01 19:38:54 +08:00
go.mod	Break Change: use yml, which is easier to parse, as the config format	2018-10-02 15:26:36 +08:00
go.sum	Break Change: use yml, which is easier to parse, as the config format	2018-10-02 15:26:36 +08:00
LICENSE	Initial commit	2018-06-10 22:28:14 +08:00
main.go	Update: Initialize the config file outside of the init function	2018-07-31 17:54:16 +08:00
Makefile	Fix: Makefile	2018-08-12 14:06:50 +08:00
README.md	Update: README.md	2018-09-16 23:08:04 +08:00

README.md

Clash

A rule based proxy in Go.

Features

HTTP/HTTPS and SOCKS proxy
Surge like configuration
GeoIP rule support
Support Vmess/Shadowsocks/Socks5
Support for Netfilter TCP redirect

Discussion

Telegram Group

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

# redir proxy for Linux and macOS
redir-port = 7892

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

[Proxy]
# name = ss, server, port, cipher, password(, obfs=tls/http, obfs-host=bing.com)
# 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
ss1 = ss, server1, port, AEAD_CHACHA20_POLY1305, password
ss2 = ss, server2, port, AEAD_CHACHA20_POLY1305, password

# name = vmess, server, port, uuid, alterId, cipher(, tls=true)
# cipher support auto/aes-128-gcm/chacha20-poly1305/none
vmess1 = vmess, server, port, uuid, 32, auto, tls=true

# name = socks5, server, port
socks = socks5, server, port

[Proxy Group]
# url-test select which proxy will be used by benchmarking speed to a URL.
# name = url-test, [proxies], url, interval(second)
auto = url-test, ss1, ss2, http://www.google.com/generate_204, 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 = select, [proxies]
Proxy = select, ss1, ss2, auto

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

Thanks

riobard/go-shadowsocks2

v2ray/v2ray-core

License

TODO

Complementing the necessary rule operators
Redir proxy
UDP support
Connection manager