Meta Kennel
Meta Kennel

Another Clash Kennel.

## 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. - 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 ## Getting Started Documentations are now moved to [GitHub Wiki](https://github.com/Dreamacro/clash/wiki). ## Advanced usage for this branch ### DNS configuration Support `geosite` with `fallback-filter`. Restore `Redir remote resolution`. Support resolve ip with a `Proxy Tunnel`. ```yaml proxy-groups: - name: DNS type: url-test use: - HK url: http://cp.cloudflare.com interval: 180 lazy: true ``` ```yaml dns: enable: true use-hosts: true ipv6: false enhanced-mode: redir-host fake-ip-range: 198.18.0.1/16 listen: 127.0.0.1:6868 default-nameserver: - 119.29.29.29 - 114.114.114.114 nameserver: - https://doh.pub/dns-query - tls://223.5.5.5:853 fallback: - 'https://1.0.0.1/dns-query#DNS' # append the proxy adapter name or group name to the end of DNS URL with '#' prefix. - 'tls://8.8.4.4:853#DNS' fallback-filter: geoip: false geosite: - gfw # `geosite` filter only use fallback server to resolve ip, prevent DNS leaks to unsafe DNS providers. domain: - +.example.com ipcidr: - 0.0.0.0/32 ``` ### TUN configuration Supports macOS, Linux and Windows. Built-in [Wintun](https://www.wintun.net) driver. ```yaml # Enable the TUN listener tun: enable: true stack: gvisor # only gvisor dns-hijack: - 0.0.0.0:53 # additional dns server listen on TUN auto-route: true # auto set global route ``` ### Rules configuration - Support rule `GEOSITE`. - Support rule-providers `RULE-SET`. - Support `multiport` condition for rule `SRC-PORT` and `DST-PORT`. - Support `network` condition for all rules. - Support source IPCIDR condition for all rules, just append to the end. - The `GEOSITE` databases via https://github.com/Loyalsoldier/v2ray-rules-dat. ```yaml rules: # network(tcp/udp) condition for all rules - DOMAIN-SUFFIX,bilibili.com,DIRECT,tcp - DOMAIN-SUFFIX,bilibili.com,REJECT,udp # multiport condition for rules SRC-PORT and DST-PORT - DST-PORT,123/136/137-139,DIRECT,udp # rule GEOSITE - GEOSITE,category-ads-all,REJECT - GEOSITE,icloud@cn,DIRECT - GEOSITE,apple@cn,DIRECT - GEOSITE,apple-cn,DIRECT - GEOSITE,microsoft@cn,DIRECT - GEOSITE,facebook,PROXY - GEOSITE,youtube,PROXY - GEOSITE,geolocation-cn,DIRECT - GEOSITE,geolocation-!cn,PROXY # source IPCIDR condition for all rules in gateway proxy #- GEOSITE,geolocation-!cn,REJECT,192.168.1.88/32,192.168.1.99/32 - GEOIP,telegram,PROXY,no-resolve - GEOIP,private,DIRECT,no-resolve - GEOIP,cn,DIRECT - MATCH,PROXY ``` ### Proxies configuration Active health detection `urltest / fallback` (based on tcp handshake, multiple failures within a limited time will actively trigger health detection to use the node) Support `Policy Group Filter` ```yaml proxy-groups: - name: 🚀 HK Group type: select use: - ALL filter: 'HK' - name: 🚀 US Group type: select use: - ALL filter: 'US' proxy-providers: ALL: type: http url: "xxxxx" interval: 3600 path: "xxxxx" health-check: enable: true interval: 600 url: http://www.gstatic.com/generate_204 ``` Support outbound transport protocol `VLESS`. The XTLS support TCP/UDP by the XRAY-CORE. ```yaml proxies: - name: "vless-tcp" type: vless server: server port: 443 uuid: uuid network: tcp servername: example.com # AKA SNI # flow: xtls-rprx-direct # xtls-rprx-origin # enable XTLS # skip-cert-verify: true - 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 ``` ### 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. ```yaml # Enable the TPROXY listener tproxy-port: 9898 # Disable the TUN listener tun: enable: false ``` Create user given name `Clash.Meta`. Run Meta Kennel by user `Clash.Meta` as a daemon. Create the systemd configuration file at /etc/systemd/system/clash.service: ``` [Unit] Description=Clash.Meta Daemon, Another Clash Kennel. After=network.target [Service] Type=simple User=Clash.Meta Group=Clash.Meta CapabilityBoundingSet=cap_net_admin AmbientCapabilities=cap_net_admin Restart=always ExecStart=/usr/local/bin/Clash.Meta -d /etc/Clash.Meta [Install] WantedBy=multi-user.target ``` Launch clashd on system startup with: ```shell $ systemctl enable Clash.Meta ``` Launch clashd immediately with: ```shell $ systemctl start Clash.Meta ``` ### Display Process name Clash add field `Process` to `Metadata` and prepare to get process name for Restful API `GET /connections`. To display process name in GUI please use [Dashboard For Meta](https://github.com/Clash-Mini/Dashboard). ![img.png](https://github.com/Clash-Mini/Dashboard/raw/master/View/Dashboard-Process.png) ## 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 * [Dreamacro/clash](https://github.com/Dreamacro/clash) * [riobard/go-shadowsocks2](https://github.com/riobard/go-shadowsocks2) * [v2ray/v2ray-core](https://github.com/v2ray/v2ray-core) * [WireGuard/wireguard-go](https://github.com/WireGuard/wireguard-go) * [yaling888/clash-plus-pro](https://github.com/yaling888/clash) ## License 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)