mirror of
https://gitclone.com/github.com/MetaCubeX/Clash.Meta
synced 2024-11-15 13:41:23 +08:00
102 lines
3.2 KiB
Markdown
102 lines
3.2 KiB
Markdown
<h1 align="center">
|
|
<img src="Meta.png" alt="Meta Kennel" width="200">
|
|
<br>Meta Kernel<br>
|
|
</h1>
|
|
|
|
<h3 align="center">Another Clash Kernel.</h3>
|
|
|
|
<p align="center">
|
|
<a href="https://goreportcard.com/report/github.com/Clash-Mini/Clash.Meta">
|
|
<img src="https://goreportcard.com/badge/github.com/Clash-Mini/Clash.Meta?style=flat-square">
|
|
</a>
|
|
<img src="https://img.shields.io/github/go-mod/go-version/Dreamacro/clash?style=flat-square">
|
|
<a href="https://github.com/Clash-Mini/Clash.Meta/releases">
|
|
<img src="https://img.shields.io/github/release/Clash-Mini/Clash.Meta/all.svg?style=flat-square">
|
|
</a>
|
|
<a href="https://github.com/Clash-Mini/Clash.Meta">
|
|
<img src="https://img.shields.io/badge/release-Meta-00b4f0?style=flat-square">
|
|
</a>
|
|
</p>
|
|
|
|
## Features
|
|
|
|
- Local HTTP/HTTPS/SOCKS server with authentication support
|
|
- VMess, VLESS, Shadowsocks, Trojan, Snell, TUIC, Hysteria protocol support
|
|
- 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 hard-coding in config
|
|
- Netfilter TCP redirecting. Deploy Clash on your Internet gateway with `iptables`.
|
|
- Comprehensive HTTP RESTful API controller
|
|
|
|
## Dashboard
|
|
|
|
A web dashboard with first-class support for this project has been created; it can be checked out at [metacubexd](https://github.com/MetaCubeX/metacubexd).
|
|
|
|
## Configration example
|
|
|
|
Configuration example is located at [/docs/config.yaml](https://github.com/MetaCubeX/Clash.Meta/blob/Alpha/docs/config.yaml).
|
|
|
|
## Docs
|
|
|
|
Documentation can be found in [Clash.Meta Docs](https://clash-meta.wiki).
|
|
|
|
## For development
|
|
|
|
Requirements:
|
|
[Go 1.20 or newer](https://go.dev/dl/)
|
|
|
|
Build Clash.Meta:
|
|
|
|
```shell
|
|
git clone https://github.com/MetaCubeX/Clash.Meta.git
|
|
cd Clash.Meta && go mod download
|
|
go build
|
|
```
|
|
|
|
Set go proxy if a connection to GitHub is not possible:
|
|
|
|
```shell
|
|
go env -w GOPROXY=https://goproxy.io,direct
|
|
```
|
|
|
|
Build with gvisor tun stack:
|
|
|
|
```shell
|
|
go build -tags with_gvisor
|
|
```
|
|
|
|
### IPTABLES configuration
|
|
|
|
Work on Linux OS which supported `iptables`
|
|
|
|
```yaml
|
|
# Enable the TPROXY listener
|
|
tproxy-port: 9898
|
|
|
|
iptables:
|
|
enable: true # default is false
|
|
inbound-interface: eth0 # detect the inbound interface, default is 'lo'
|
|
```
|
|
|
|
## Debugging
|
|
|
|
Check [wiki](https://wiki.metacubex.one/api/#debug) to get an instruction on using debug
|
|
API.
|
|
|
|
## Credits
|
|
|
|
- [Dreamacro/clash](https://github.com/Dreamacro/clash)
|
|
- [SagerNet/sing-box](https://github.com/SagerNet/sing-box)
|
|
- [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.
|
|
|
|
[](https://app.fossa.io/projects/git%2Bgithub.com%2FDreamacro%2Fclash?ref=badge_large)
|