2018-06-22 16:44:28 +00:00
< h1 align = "center" >
< img src = "https://github.com/Dreamacro/clash/raw/master/docs/logo.png" alt = "Clash" width = "200" >
2019-02-11 07:55:17 +00:00
< br > Clash< br >
2018-06-22 16:44:28 +00:00
< / h1 >
2018-12-10 16:25:05 +00:00
< h4 align = "center" > A rule-based tunnel in Go.< / h4 >
2018-06-22 16:44:28 +00:00
< p align = "center" >
2019-12-08 04:34:05 +00:00
< a href = "https://github.com/Dreamacro/clash/actions" >
< img src = "https://img.shields.io/github/workflow/status/Dreamacro/clash/Go?style=flat-square" alt = "Github Actions" >
< / a >
2018-06-22 16:44:28 +00:00
< a href = "https://goreportcard.com/report/github.com/Dreamacro/clash" >
2019-02-11 07:55:17 +00:00
< img src = "https://goreportcard.com/badge/github.com/Dreamacro/clash?style=flat-square" >
2018-06-22 16:44:28 +00:00
< / a >
< a href = "https://github.com/Dreamacro/clash/releases" >
< img src = "https://img.shields.io/github/release/Dreamacro/clash/all.svg?style=flat-square" >
< / a >
< / p >
2018-06-10 14:50:03 +00:00
## Features
2020-06-28 02:39:30 +00:00
- Local HTTP/HTTPS/SOCKS server with authentication support
- VMess, Shadowsocks, Trojan, Snell protocol support for remote connections
- Built-in DNS server that aims to minimize DNS pollution attack impact, supports DoH/DoT upstream and fake IP.
2020-03-20 04:35:30 +00:00
- 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
2020-06-28 02:39:30 +00:00
- Netfilter TCP redirecting. Deploy Clash on your Internet gateway with `iptables` .
- Comprehensive HTTP RESTful API controller
2018-08-14 10:06:56 +00:00
2020-06-28 02:39:30 +00:00
## Getting Started
Documentations are now moved to [GitHub Wiki ](https://github.com/Dreamacro/clash/wiki ).
2019-04-15 11:05:01 +00:00
2021-07-06 07:07:05 +00:00
## Advanced usage for this fork branch
2021-07-01 14:49:29 +00:00
### TUN configuration
Support macOS Linux and Windows.
For Windows, you should download the [Wintun ](https://www.wintun.net ) driver and copy `wintun.dll` into the System32 directory.
```yaml
# Enable the TUN listener
tun:
enable: true
stack: system # system or gvisor
dns-listen: 0.0.0.0:53 # additional dns server listen on TUN
auto-route: true # auto set global route
```
### Rules configuration
- Support rule `GEOSITE`
2021-07-06 07:07:05 +00:00
- Support `multiport` condition for rule `SRC-PORT` and `DST-PORT`
- Support not match condition for rule `GEOIP`
2021-07-01 14:49:29 +00:00
- Support `network` condition for all rules
The `GEOSITE` and `GEOIP` databases via https://github.com/Loyalsoldier/v2ray-rules-dat
```yaml
rules:
# network condition for rules
2021-07-06 07:07:05 +00:00
- DOMAIN-SUFFIX,bilibili.com,DIRECT,tcp
- DOMAIN-SUFFIX,bilibili.com,REJECT,udp
# multiport condition for rule SRC-PORT and DST-PORT
- DST-PORT,123/136/137-139,DIRECT,udp
2021-07-01 14:49:29 +00:00
# rule GEOSITE
- GEOSITE,category-ads-all,REJECT
- GEOSITE,icloud@cn,DIRECT
- GEOSITE,apple@cn,DIRECT
- GEOSITE,microsoft@cn,DIRECT
2021-07-06 07:07:05 +00:00
- GEOSITE,facebook,PROXY
2021-07-01 14:49:29 +00:00
- GEOSITE,youtube,PROXY
- GEOSITE,geolocation-cn,DIRECT
2021-07-06 07:07:05 +00:00
- GEOSITE,gfw,PROXY
- GEOSITE,greatfire,PROXY
2021-07-01 14:49:29 +00:00
#- GEOSITE,geolocation-!cn,PROXY
2021-07-06 07:07:05 +00:00
- GEOIP,telegram,PROXY,no-resolve
2021-07-01 14:49:29 +00:00
- GEOIP,private,DIRECT,no-resolve
- GEOIP,cn,DIRECT
# Not match condition for rule GEOIP
#- GEOIP,!cn,PROXY
- MATCH,PROXY
```
### IPTABLES auto-configuration
Only work on Linux OS who support `iptables` , Clash will auto-configuration iptables for tproxy listener when `tproxy-port` value isn't zero.
2021-07-06 07:07:05 +00:00
If `TPROXY` is enabled, the `TUN` must be disabled.
2021-07-01 14:49:29 +00:00
```yaml
# Enable the TPROXY listener
tproxy-port: 9898
# Disable the TUN listener
tun:
enable: false
```
2021-07-06 07:07:05 +00:00
Create user given name `clash`
2021-07-01 14:49:29 +00:00
Run Clash by user `clash` as a daemon.
Create the systemd configuration file at /etc/systemd/system/clash.service:
```shell
[Unit]
Description=Clash daemon, A rule-based proxy in Go.
After=network.target
[Service]
Type=simple
User=clash
Group=clash
CapabilityBoundingSet=cap_net_admin
AmbientCapabilities=cap_net_admin
Restart=always
ExecStart=/usr/local/bin/clash -d /etc/clash
[Install]
WantedBy=multi-user.target
```
Launch clashd on system startup with:
```shell
$ systemctl enable clash
```
Launch clashd immediately with:
```shell
$ systemctl start clash
```
### Display Process name
Add field `Process` to `Metadata` and prepare to get process name for Restful API `GET /connections`
To display process name in GUI please use https://yaling888.github.io/yacd/
2020-12-26 16:14:24 +00:00
## Premium Release
[Release ](https://github.com/Dreamacro/clash/releases/tag/premium )
2021-06-13 15:11:49 +00:00
## Development
If you want to build an application that uses clash as a library, check out the the [GitHub Wiki ](https://github.com/Dreamacro/clash/wiki/use-clash-as-a-library )
2020-03-20 04:35:30 +00:00
## Credits
2018-08-11 20:22:14 +00:00
2020-06-28 02:39:30 +00:00
* [riobard/go-shadowsocks2 ](https://github.com/riobard/go-shadowsocks2 )
* [v2ray/v2ray-core ](https://github.com/v2ray/v2ray-core )
2018-09-16 15:08:04 +00:00
2018-07-15 14:32:20 +00:00
## License
2018-08-11 20:22:14 +00:00
2020-06-28 02:39:30 +00:00
This software is released under the GPL-3.0 license.
2018-07-15 14:32:20 +00:00
[![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)
2018-06-10 14:50:03 +00:00
## TODO
2018-08-11 20:22:14 +00:00
- [x] Complementing the necessary rule operators
- [x] Redir proxy
2019-04-25 08:32:15 +00:00
- [x] UDP support
2019-12-08 04:34:05 +00:00
- [x] Connection manager