Clash.Meta/README.md

63 lines
1.3 KiB
Markdown
Raw Normal View History

2018-06-10 22:50:03 +08:00
# Clash
A rule based proxy in Go.
## Features
- HTTP/HTTPS and SOCKS proxy
- Surge like configuration
- GeoIP rule support
## Install
You can build from source:
```sh
go get -u -v github.com/Dreamacro/clash
```
2018-06-15 17:49:14 +08:00
Pre-built binaries are available: [release](https://github.com/Dreamacro/clash/releases)
2018-06-10 22:50:03 +08:00
Requires Go >= 1.10.
2018-06-15 00:35:33 +08:00
## 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:
```sh
pm2 start clash
```
2018-06-10 22:50:03 +08:00
## Config
Configuration file at `$HOME/.config/clash/config.ini`
Below is a simple demo configuration file:
```ini
[General]
port = 7890
socks-port = 7891
[Proxy]
2018-06-15 00:35:33 +08:00
# 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
2018-06-10 22:50:03 +08:00
Proxy = ss, server, port, AEAD_CHACHA20_POLY1305, password
[Rule]
DOMAIN-SUFFIX,google.com,Proxy
DOMAIN-KEYWORD,google,Proxy
DOMAIN-SUFFIX,ad.com,REJECT
GEOIP,CN,DIRECT
2018-06-15 00:35:33 +08:00
FINAL,,Proxy # note: there is two ","
2018-06-10 22:50:03 +08:00
```
## TODO
- [ ] Complementing the necessary rule operators