Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/eycorsican/leaf
A versatile and efficient proxy framework with nice features suitable for various use cases.
https://github.com/eycorsican/leaf
Last synced: about 2 months ago
JSON representation
A versatile and efficient proxy framework with nice features suitable for various use cases.
- Host: GitHub
- URL: https://github.com/eycorsican/leaf
- Owner: eycorsican
- License: apache-2.0
- Created: 2020-09-27T12:24:37.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2024-07-19T18:11:24.000Z (2 months ago)
- Last Synced: 2024-07-21T02:23:12.109Z (2 months ago)
- Language: Rust
- Homepage:
- Size: 1.73 MB
- Stars: 2,345
- Watchers: 53
- Forks: 431
- Open Issues: 109
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Leaf
A versatile and efficient proxy framework with nice features suitable for various use cases.
### Multiplexing
There are 2 transports for traffic multiplexing:
* AMux: A multiplexd transport based on reliable streams suitable for TCP-based protocols and transports
* QUIC: A UDP-based, multiplexed and secure transport
The benefit of `amux` is that we can reuse connections to reduce handshake overhead, it's not designed to be memory efficient because it focus only on reusing connections and not reducing the number of connections. While `quic` can reduce both handshake overhead and memory usage without suffering the head-of-line blocking issue.
### Transparent Proxying
There's the TUN inbound for this purpose, which is also of fundamental importance for VPN-like proxying use cases such as VPN apps on iOS and Android.
### High Availability
Outbounds such as `failover`, `tryall`, `retry`, `random` and their combinations are able to flexibly deliver reqeusts to other outbounds based on their own metrics to achieve high availability or load balancing behaviors.
### Request Routing
Rule-based request routing is also supported. Requests can be routed to different outbounds based on domain, IP, GEOIP and port rules.
## Getting Started
```ini
[General]
dns-server = 223.5.5.5
socks-interface = 127.0.0.1
socks-port = 1080
[Proxy]
Direct = direct
```
More configuration examples can be found [here](https://github.com/eycorsican/leaf/blob/master/README.zh.md). If you want more flexible control on the config options, the JSON format should be used, up-to-date examples for the JSON format could be found in the [tests](https://github.com/eycorsican/leaf/blob/master/leaf/tests), both client-side and server-side config examples are presented there.
## TUN Mode and Gateway Mode
### TUN Mode
This syntax (`tun = auto`) is supported on macOS and Linux.
```ini
[General]
dns-server = 223.5.5.5
tun = auto
[Proxy]
Direct = direct
```
### Gateway Mode
Running in gateway mode requires a configuration with TUN mode enabled. Gateway mode can be enabled by an environment variable.
```sh
GATEWAY_MODE=true leaf -c config.conf
```
## Windows
* [Maple](https://github.com/YtFlow/Maple): A lightweight Universal Windows proxy app based on leaf
## iOS & Android
## Build
Install Rust: https://www.rust-lang.org/tools/install
Install GCC or Clang.
Clone & Build:
```sh
git clone --recursive https://github.com/eycorsican/leaf.git
cd leaf
cargo build -p leaf-cli
```
Run:
```sh
./target/debug/leaf --help
```
## License
This project is licensed under the [Apache License 2.0](https://github.com/eycorsican/leaf/blob/master/LICENSE).