Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/watfaq/clash-rs
custom protocol network proxy
https://github.com/watfaq/clash-rs
clash clash-rs clashrs hsalc ios proxy rust vpn
Last synced: 27 days ago
JSON representation
custom protocol network proxy
- Host: GitHub
- URL: https://github.com/watfaq/clash-rs
- Owner: Watfaq
- License: apache-2.0
- Created: 2022-09-20T16:25:24.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2024-05-23T06:33:42.000Z (6 months ago)
- Last Synced: 2024-05-23T06:43:20.348Z (6 months ago)
- Topics: clash, clash-rs, clashrs, hsalc, ios, proxy, rust, vpn
- Language: Rust
- Homepage: https://watfaq.gitbook.io/clashrs-user-manual/
- Size: 24.3 MB
- Stars: 485
- Watchers: 3
- Forks: 33
- Open Issues: 42
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
ClashRS
A custom protocol, rule based network proxy software.
[](https://github.com/Watfaq/clash-rs/actions/workflows/ci.yml)
## ✨ Features
- 🌈 Flexible traffic routing rules based off source/destination IP/Domain/GeoIP etc.
- 📦 Local anti spoofing DNS with support of UDP/TCP/DoH/DoT remote, and expose it as a local UDP/TCP/DoH/DoT server.
- 🛡 Run as an HTTP/Socks5 proxy, or utun device as a home network gateway.
- ⚙️ Shadowsocks/Trojan/Vmess/Wireguard(userspace)/Tor/Tuic/Socks5(TCP/UDP) outbound support with different underlying trasports(gRPC/TLS/H2/WebSocket/etc.).
- 🌍 Dynamic remote rule/proxy loader.
- 🎵 Tracing with Jaeger
## 🖥 Environment Support
- Linux
- macOS
- Windows
- You need to copy the [wintun.dll](https://wintun.net/) file which matches your architecture to the same directory as your executable and run you program as administrator.
- iOS - [TestFlight](https://testflight.apple.com/join/cLy4Ub5C)
## 📦 Install
### Use With GUI
https://github.com/LibNyanpasu/clash-nyanpasu
### Download Prebuilt Binary
Can be found at https://github.com/Watfaq/clash-rs/releases
### Docker Image
https://github.com/Watfaq/clash-rs/pkgs/container/clash-rs
### Local Build
Dependencies
* cmake (3.29 or newer)
* libclang([LLVM](https://github.com/llvm/llvm-project/releases/tag/llvmorg-16.0.4))
* [nasm](https://www.nasm.us/pub/nasm/releasebuilds/2.16/win64/) (Windows)
* protoc(for geodata proto generation)
```
$ cargo build
```
## 🔨 Usage
### Example Config
sample.yaml:
```yaml
port: 7890
```
### Run
```shell
-> % ./target/debug/clash -c sample.yaml
```
### Help
```shell
-> % ./target/debug/clash -h
Usage: clash [OPTIONS]
Options:
-d, --directory
-c, --config [default: config.yaml]
-t, --test
-h, --help Print help
-V, --version Print version
```
## 🔗 Links
- [Documentation](https://watfaq.gitbook.io/clashrs-user-manual/)
- [Config Reference](https://watfaq.github.io/clash-rs/)
- [Roadmap](https://github.com/Watfaq/clash-rs/issues/59)
## 🤝 Contributing
- [CONTRIBUTING.md](CONTRIBUTING.md)
- [Telegram User Group](https://t.me/thisisnotclash)
## ❤️ Inspired By
- [Dreamacro/clash](https://github.com/Dreamacro/clash)
- [eycorsican/leaf](https://github.com/eycorsican/leaf)