vproxy

查看 release page.

For linux

使用release页面中最新的vproxy-linux二进制文件。

或者

使用jlink打包的运行时文件：点这里下载。

For macos

使用release页面中最新的vproxy-macos二进制文件。

For windows

Java运行时可以从这里下载。

For musl

使用jlink打包的运行时文件：点这里下载。

注意：该运行时仍然处于beta阶段

仅支持macos(bsd)/linux。另外在编译前，你可能需要配置JAVA_HOME环境变量。

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

如果要使用F-Stack版本，可以按照这个文档的步骤执行：fstack-how-to.md。

此外，Windows有一个特别版本用于支持Tap设备：-Dvfd=windows，但是普通fd和事件循环依旧是jdk selector channel.

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

执行测试用例:

./gradlew runTest

测试vswitch, docker network plugin, vpctl, k8s controller:

# 需要事先安装virtualbox

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

目标

• 零依赖: 除了java标准库外不加任何依赖，也不使用jni扩展。
• 简单：代码简单易懂.
• 运行时可修改：更新配置不需要重启。
• 高效：性能是首要目标之一。
• TCP负载均衡：支持TCP以及一些基于TCP的协议，也允许你使用自己的协议。
• Kubernetes：将vproxy资源整合到k8s中。

如何使用

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 {...} \]

文档

• how-to-use.md(中文): 如何使用配置文件和controller。
• api.yaml: http-controller的api文档（swagger格式）。
• command.md: 详细的命令文档。
• lb-example.md(中文): 关于TCP负载均衡的一个使用例子。
• docker-example.md(中文): 关于构建镜像以及在docker中运行vproxy的一个例子。
• architecture.md: 架构相关。
• extended-app.md(中文): 扩展应用的使用方式。
• websocks.md: The WebSocks Protocol.
• vproxy-kcp-tunnel.md: The KCP Tunnel Protocol.
• using-application-layer-protocols.md(中文): 关于如何使用(自定义的)应用层协议。
• fstack-how-to.md(中文): 如何在F-Stack上运行vproxy。
• vpws-direct-relay.md(中文): 如何使用vpws-agent的direct-relay功能。

贡献

目前只有我自己在维护这个项目。希望能有更多人加入 :)

感谢Jetbrains制作的IDE，以及免费的开源许可证。