yeager

README

yeager

A proxy that helps speed up the internet connection.

Features:

• tunnel over gRPC or QUIC, secure by mutual TLS
• rule-based routing
• SOCKS and HTTP proxy

Here is how the traffic flows:

browser -> [HTTP proxy -> yeager client] -> firewall -> [yeager server] -> endpoints

Install

Binaries

Manually download the release

# assuming Linux, amd64 architecture
curl -LO https://github.com/chenen3/yeager/releases/latest/download/yeager-linux-amd64.tar.gz
tar -xzvf yeager-linux-amd64.tar.gz
mv yeager /usr/local/bin/yeager
# on client side
mkdir -p /usr/local/share/yeager
mv geosite.dat /usr/local/share/yeager/geosite.dat

Docker

docker pull ghcr.io/chenen3/yeager

Homebrew

brew tap chenen3/yeager
brew install yeager

Source

go install github.com/chenen3/yeager@latest

As remote server

1. Generate config

mkdir -p /usr/local/etc/yeager
cd /usr/local/etc/yeager
yeager -genconf
# if you prefer docker:
# docker run --rm --workdir /usr/local/etc/yeager -v /usr/local/etc/yeager:/usr/local/etc/yeager ghcr.io/chenen3/yeager yeager -genconf
ln -s server.json config.json

here generates a pair of config:

• /usr/local/etc/yeager/server.json
• /usr/local/etc/yeager/client.json (should be copyed to local machine later)

2. Run service

yeager -config /usr/local/etc/yeager/config.json
# if you prefer docker:
# docker run -d --restart=always --name yeager -v /usr/local/etc/yeager:/usr/local/etc/yeager -p 9001:9001 ghcr.io/chenen3/yeager

3. Update firewall

Allow TCP port 9001

As local client

1. Configure

On remote machine we have generated client config /usr/local/etc/yeager/client.json, now copy it to local machine as /usr/local/etc/yeager/config.json

2. Run service

For the binary:

yeager -config /usr/local/etc/yeager/config.json

For Homebrew (macOS only):

brew services start yeager

For Docker:

docker run -d \
    --restart=always \
    --network host \
    --name yeager \
    -v /usr/local/etc/yeager:/usr/local/etc/yeager \
    ghcr.io/chenen3/yeager

3. Setup proxy

• setting HTTP and HTTPS proxy to localhost:8080
• setting SOCKS proxy to localhost:1080

That's all, good luck.

(For more details, see below...)

Routing rule

Routing rule specifies where the incomming traffic be sent to. It supports two forms:

• type,value,policy
• final,policy

The proxy policy is specified by config, also yeager comes with two built-in proxy policy:

• direct means connecting directly, not through a tunnel server
• reject means connection rejected

For example:

• ip-cidr,127.0.0.1/8,direct access directly if IP matches
• domain,www.apple.com,direct access directly if domain name matches
• domain-suffix,apple.com,directaccess directly if root domain name matches
• domain-keyword,apple,direct access directly if keyword matches
• geosite,cn,direct access directly if the domain name is located in mainland China. The geosite rule supports domain-list-community
• final,proxy access through the proxy server. If present, must be the last rule, by default is final,direct

Uninstall

For the pre-built binary:

rm /usr/local/bin/yeager
rm /usr/local/share/yeager/geosite.dat
rmdir /usr/local/share/yeager
# remove the configuration files if you wish:
#   rm /usr/local/etc/yeager/config.json
#   rmdir /usr/local/etc/yeager

For Homebrew:

brew uninstall yeager
brew untap chenen3/yeager

For Docker:

docker stop yeager
docker rm yeager
docker image rm ghcr.io/chenen3/yeager

Credit

• trojan-gfw/trojan
• v2fly/v2ray-core
• v2fly/domain-list-community
• lucas-clemente/quic-go