yeager

README

yeager

Yeager is a tool for bypassing network restrictions, supports the following features:

• SOCKS5 and HTTP/HTTPS proxy
• Self-implement lightweight proxy
  • security via TLS
  • transport over TCP, gRPC or QUIC
• Rule-based routing

Prerequisites

• The server is reachable from the public Internet and exposes TCP port 9000
• Docker

Usage

As server

Generate certificate files:

mkdir -p /usr/local/etc/yeager
cd /usr/local/etc/yeager
docker run --rm \
    --workdir /usr/local/etc/yeager \
    -v /usr/local/etc/yeager:/usr/local/etc/yeager \
    ghcr.io/chenen3/yeager \
    yeager cert --host [server-public-ip]

Create config file /usr/local/etc/yeager/config.json

{
    "inbounds": {
        "yeager": {
            "listen": "0.0.0.0:9000",
            "transport": "tcp",
            "security": "tls-mutual",
            "mtls": {
                "certFile": "/usr/local/etc/yeager/server-cert.pem",
                "keyFile": "/usr/local/etc/yeager/server-key.pem",
                "clientCAFile": "/usr/local/etc/yeager/ca-cert.pem"
            }
        }
    }
}

Launch:

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

As client

Install

• Via homebrew (macOS only)

brew tap chenen3/yeager
brew install yeager

• Via docker

docker pull ghcr.io/chenen3/yeager

Configure

At server side we have generated certificate files: client-cert.pem, client-key.pem, ca-cert.pem. Ensure you have copy these files to client device, and place in directory /usr/local/etc/yeager

create config file /usr/local/etc/yeager/config.json

{
    "inbounds": {
        "socks": {
            "address": "127.0.0.1:1080"
        },
        "http": {
            "address": "127.0.0.1:8080"
        }
    },
    "outbounds": [
        {
            "tag": "PROXY",
            "address": "server-ip:9000", // replace server-ip
            "transport": "tcp",
            "security": "tls-mutual",
            "mtls": {
                "certFile": "/usr/local/etc/yeager/client-cert.pem",
                "keyFile": "/usr/local/etc/yeager/client-key.pem",
                "rootCAFile": "/usr/local/etc/yeager/ca-cert.pem"
            }
        }
    ],
    "rules": [
        "IP-CIDR,127.0.0.1/8,DIRECT",
        "IP-CIDR,192.168.0.0/16,DIRECT",
        "GEOSITE,private,DIRECT",
        "GEOSITE,google,PROXY",
        "GEOSITE,twitter,PROXY",
        "GEOSITE,cn,DIRECT",
        "GEOSITE,apple@cn,DIRECT",
        "FINAL,PROXY"
    ]
}

Run

• Via homebrew on MacOS

brew services start yeager

• Via docker

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

After running client side yeager, do not forget to setup SOCKS5 or HTTP proxy for client device. Good luck.

Advance usage

Routing rule

Routing rule supports two forms:ruleType,value,outboundTag and FINAL,outboundTag. Outbound tag specified by the user, and yeager also comes with two built-in outbound tags:

• DIRECT means sending traffic directly, do not pass by proxy
• REJECT means rejecting traffic and close the connection

rule example:

• IP-CIDR,127.0.0.1/8,DIRECT matches if destination IP is in specified CIDR
• DOMAIN,www.apple.com,DIRECT matches if destination domain is the given one
• DOMAIN-SUFFIX,apple.com,DIRECT matches if destination domain has the suffix, AKA subdomain name
• DOMAIN-KEYWORD,apple,DIRECT matches if destination domain has the keyword
• GEOSITE,cn,DIRECT matches if destination domain is in geosite
• FINAL,PROXY determine where the traffic be send to while all above rules not match. It must be the last rule, by default is FINAL,DIRECT

Upgrade

Via homebrew on macOS

brew update
brew upgrade yeager
brew services restart yeager

Via docker

docker pull ghcr.io/chenen3/yeager
docker stop yeager
docker rm yeager
# then create the container again as described above

Uninstall

via homebrew:

brew uninstall yeager
brew untap chenen3/yeager

via docker:

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

Credit

• v2ray
• quic-go