https://github.com/vilicvane/plug2proxy

Transparent Proxy over HTTP2 or QUIC.
https://github.com/vilicvane/plug2proxy

http2 p2p plug2proxy proxy quic transparent-proxy

Last synced: about 1 month ago
JSON representation

Transparent Proxy over HTTP2 or QUIC.

• Host: GitHub
• URL: https://github.com/vilicvane/plug2proxy
• Owner: vilicvane
• License: mit
• Created: 2021-11-29T00:55:11.000Z (about 3 years ago)
• Default Branch: master
• Last Pushed: 2024-11-04T12:04:47.000Z (2 months ago)
• Last Synced: 2024-11-30T15:41:59.217Z (about 1 month ago)
• Topics: http2, p2p, plug2proxy, proxy, quic, transparent-proxy
• Language: Rust
• Homepage: https://plug2proxy.com
• Size: 1.07 MB
• Stars: 22
• Watchers: 1
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![MIT License](https://img.shields.io/badge/license-MIT-0969da?style=flat-square)](./LICENSE)

[![Discord](https://img.shields.io/badge/chat-discord-5662f6?style=flat-square)](https://discord.com/invite/vanVrDwSkS)

# Plug2Proxy

> Checkout the original Node.js version at branch [nodejs](https://github.com/vilicvane/plug2proxy/tree/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.

```sh

# 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](src/config.rs) for the complete configuration options available.

### IN Server

```json

{

    "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

```json

{

    "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.