clash/README.md

188 lines
5.8 KiB
Markdown
Raw Normal View History

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>
<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>
2021-09-20 09:22:40 +00:00
<img src="https://img.shields.io/github/go-mod/go-version/Dreamacro/clash?style=flat-square">
2018-06-22 16:44:28 +00:00
<a href="https://github.com/Dreamacro/clash/releases">
<img src="https://img.shields.io/github/release/Dreamacro/clash/all.svg?style=flat-square">
</a>
2021-09-20 09:22:40 +00:00
<a href="https://github.com/Dreamacro/clash/releases/tag/premium">
<img src="https://img.shields.io/badge/release-Premium-00b4f0?style=flat-square">
</a>
2018-06-22 16:44:28 +00:00
</p>
2018-06-10 14:50:03 +00:00
## Features
- 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.
2021-09-20 09:22:40 +00:00
- Rules based off domains, GEOIP, IPCIDR or Process 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
- Netfilter TCP redirecting. Deploy Clash on your Internet gateway with `iptables`.
- Comprehensive HTTP RESTful API controller
2018-08-14 10:06:56 +00:00
## Getting Started
Documentations are now moved to [GitHub Wiki](https://github.com/Dreamacro/clash/wiki).
## Advanced usage for this branch
2021-07-01 14:49:29 +00:00
### TUN configuration
2021-09-23 20:37:04 +00:00
Supports macOS, Linux and Windows.
2021-07-01 14:49:29 +00:00
2021-09-23 20:37:04 +00:00
On Windows, you should download the [Wintun](https://www.wintun.net) driver and copy `wintun.dll` into Clash home directory.
2021-07-01 14:49:29 +00:00
```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
2021-07-08 18:19:43 +00:00
- Support rule `GEOSITE`.
- Support `multiport` condition for rule `SRC-PORT` and `DST-PORT`.
- Support not match condition for rule `GEOIP`.
- Support `network` condition for all rules.
2021-09-23 20:37:04 +00:00
- Support source IPCIDR condition for all rules, just append to the end.
2021-07-01 14:49:29 +00:00
The `GEOSITE` databases via https://github.com/Loyalsoldier/v2ray-rules-dat.
2021-07-01 14:49:29 +00:00
```yaml
rules:
2021-09-23 20:37:04 +00:00
# network condition for all rules
- DOMAIN-SUFFIX,bilibili.com,DIRECT,tcp
- DOMAIN-SUFFIX,bilibili.com,REJECT,udp
2021-07-08 18:19:43 +00:00
# multiport condition for rules 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
2021-07-06 15:55:34 +00:00
- GEOSITE,apple-cn,DIRECT
2021-07-01 14:49:29 +00:00
- GEOSITE,microsoft@cn,DIRECT
- GEOSITE,facebook,PROXY
2021-07-01 14:49:29 +00:00
- GEOSITE,youtube,PROXY
- GEOSITE,geolocation-cn,DIRECT
- GEOSITE,gfw,PROXY
- GEOSITE,greatfire,PROXY
2021-07-01 14:49:29 +00:00
#- GEOSITE,geolocation-!cn,PROXY
- 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
2021-09-23 20:37:04 +00:00
# source IPCIDR condition for all rules in gateway proxy
#- GEOIP,!cn,PROXY,192.168.1.88/32,192.168.1.99/32
2021-07-01 14:49:29 +00:00
- MATCH,PROXY
```
2021-07-06 15:55:34 +00:00
### Proxies configuration
2021-07-08 18:19:43 +00:00
Support outbound transport protocol `VLESS`.
The XTLS only support TCP transport by the XRAY-CORE.
2021-07-06 15:55:34 +00:00
```yaml
proxies:
2021-07-08 18:19:43 +00:00
- name: "vless-tcp"
2021-07-06 15:55:34 +00:00
type: vless
server: server
port: 443
uuid: uuid
2021-07-08 18:19:43 +00:00
network: tcp
servername: example.com # AKA SNI
# flow: xtls-rprx-direct # xtls-rprx-origin # enable XTLS
2021-07-06 15:55:34 +00:00
# skip-cert-verify: true
2021-07-08 18:19:43 +00:00
- name: "vless-ws"
type: vless
server: server
port: 443
uuid: uuid
udp: true
network: ws
servername: example.com # priority over wss host
# skip-cert-verify: true
ws-path: /path
ws-headers:
Host: example.com
2021-07-06 15:55:34 +00:00
```
2021-07-01 14:49:29 +00:00
### 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.
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-08 18:19:43 +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
2021-07-08 18:19:43 +00:00
Add field `Process` to `Metadata` and prepare to get process name for Restful API `GET /connections`.
2021-07-01 14:49:29 +00:00
2021-07-08 18:19:43 +00:00
To display process name in GUI please use https://yaling888.github.io/yacd/.
2021-07-01 14:49:29 +00:00
2020-12-26 16:14:24 +00:00
## Premium Release
[Release](https://github.com/Dreamacro/clash/releases/tag/premium)
## 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)
## Credits
2018-08-11 20:22:14 +00:00
* [riobard/go-shadowsocks2](https://github.com/riobard/go-shadowsocks2)
* [v2ray/v2ray-core](https://github.com/v2ray/v2ray-core)
2021-09-20 09:22:40 +00:00
* [WireGuard/wireguard-go](https://github.com/WireGuard/wireguard-go)
2018-09-16 15:08:04 +00:00
## License
2018-08-11 20:22:14 +00:00
This software is released under the GPL-3.0 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)