README.md

Plug2Proxy

Checkout the original Node.js version at branch nodejs.

Plug2Proxy is a transparent proxy currently in development that:

• Connects IN to OUT with TCP (HTTP2) or UDP (QUIC) tunnels.
• Utilizes a match server (currently only Redis server is supported) to exchange peer configuration.
• Supports routing based on GeoLite2 and fake-IP DNS (no traffic sniffing).

Currently only IPv4 TCP is supported, will probably add UDP support soon and then IPv6 as well.

Usage

You'll need to compile it yourself for now, so make sure you have reasonably new Rust installed.

The template is now available only for Ubuntu.

# install to IN server
./scripts/install-to-server.sh -m in -c common,ubuntu -d "in-server-address"
# install to OUT server
./scripts/install-to-server.sh -m out -c common,ubuntu -d "out-server-address"

Configuration

The configuration file provided by the installation template is located at /etc/plug2proxy/config.json.

If you are using the binary directly, just do plug2proxy config.json.

Checkout src/config.rs for the complete configuration options available.

IN Server

{
    "mode": "in",
    "tunneling": {
        "match_server": "redis://username:password@redis-server/"
    },
    "routing": {
        "rules": [
            {
                "type": "geoip",
                "match": "CN",
                "out": "DIRECT"
            },
            {
                "type": "domain",
                "match": "chatgpt.com",
                "out": "us",
                "tag": "warp"
            },
            {
                "type": "fallback",
                "out": "ANY"
            }
        ]
    }
}

OUT Server

{
    "mode": "out",
    "tunneling": {
        "label": "us",
        "match_server": "redis://username:password@redis-server/"
    },
    "outputs": [
        {
            "tag": "warp",
            "type": "socks5",
            "address": "127.0.0.1:1080"
        }
    ]
}

License

MIT License.