vproxy

中文文档

Intro

VProxy is a zero-dependency TCP Loadbalancer based on Java NIO. The project only requires Java 11 to run.

Clone it, compile it, then everything is ready for running.

Features

1. TCP Loadbalancer with TLS termination
2. HTTP/1.x and HTTP/2 Loadbalancer with Host header consideration
3. Other tcp based protocol loadbalancer, such as grpc, dubbo
4. Socks5 server
5. DNS server and customizable A|AAAA records
6. Kubernetes integration
7. Many other standalone extended apps, such as WebSocksProxyAgent and WebSocksProxyServer

Make

./gradlew clean jar
java -jar build/libs/vproxy.jar -Deploy=HelloWorld

make jlink
./build/image/bin/vproxy -Deploy=HelloWorld

docker build --no-cache -t vproxy:latest https://raw.githubusercontent.com/wkgcass/vproxy/master/docker/Dockerfile
docker run --rm vproxy -Deploy=HelloWorld

./gradlew clean jar
native-image -jar build/libs/vproxy.jar --enable-all-security-services --no-fallback --no-server vproxy
./vproxy -Deploy=HelloWorld

make vfdposix
java -Dvfd=posix -Djava.library.path=./base/src/main/c -jar build/libs/vproxy.jar -Deploy=HelloWorld

make vfdwindows
java -Dvfd=posix -Djava.library.path=./base/src/main/c -jar build/libs/vproxy.jar -Deploy=HelloWorld

./gradlew runTest

# requires virtualbox installed

cd ./misc/auto-setup/
./auto-setup.sh
./auto-verify.sh

Aim

• Zero dependency: no dependency other than java standard library, and no jni extensions.
• Simple: keep code simple and clear.
• Modifiable when running: no need to reload for configuration update.
• Fast: performance is one of our main priorities.
• TCP Loadbalancer: we now support TCP and TCP based protocols, also allow your own protocols.
• Kubernetes: integrate vproxy resources into k8s.

How to use

kubectl apply -f https://github.com/vproxy-tools/vpctl/blob/master/misc/crd.yaml
kubectl apply -f https://github.com/vproxy-tools/vpctl/blob/master/misc/k8s-vproxy.yaml

kubectl apply -f https://github.com/vproxy-tools/vpctl/blob/master/misc/cr-example.yaml

java -Deploy=Simple -jar vproxy.jar \  
                bind {port} \
                backend {host1:port1,host2:port2} \
                [ssl {path of cert1,cert2} {path of key} \]
                [protocol {...} \]

Doc

• how-to-use.md: How to use config file and controllers.
• api.yaml: api doc for http-controller in swagger format.
• command.md: Detailed command document.
• lb-example.md: An example about running a loadbalancer.
• docker-example.md: An example about building and running vproxy in docker.
• architecture.md: Something about the architecture.
• extended-app.md: The usage of extended applications.
• websocks.md: The WebSocks Protocol.
• vproxy-kcp-tunnel.md: The KCP Tunnel Protocol.
• using-application-layer-protocols.md: About how to use (customized) application layer protocols.
• fstack-how-to.md: How to run vproxy upon F-Stack. Chinese version only for now.
• vpws-direct-relay.md: How to use direct-relay in vpws-agent.

Contribute

Currently only I myself is working on this project. I would be very happy if you want to join :)

Thanks to Jetbrains for their great IDEs and the free open source license.