跳转至

快速入门

在5分钟内启动并运行 R-VPN。

前提条件

  • 具有域名和 TLS 证书的服务器
  • 客户端设备(macOS、Linux 或路由器)
  • 基本的命令行知识

第一步:下载二进制文件

dist/ 文件夹下载预编译的二进制文件:

# 通用二进制文件(Intel + Apple Silicon)
curl -L -o rvpn https://your-server.com/dist/rvpn-macos-arm64
chmod +x rvpn

# 服务器二进制文件
curl -L -o rvpn-server https://your-server.com/dist/rvpn-server-macos-arm64
chmod +x rvpn-server
# x86_64
curl -L -o rvpn https://your-server.com/dist/rvpn
curl -L -o rvpn-server https://your-server.com/dist/rvpn-server-x86_64-linux
chmod +x rvpn rvpn-server

第二步:生成密钥

为客户端和服务器生成身份密钥:

# 生成服务器身份密钥
./rvpn-server keygen

# 生成客户端身份密钥
./rvpn keygen --output identity.key

第三步:生成预密钥包

为 X3DH 认证生成服务器的预密钥包:

./rvpn-server prekey-bundle --identity server_identity.key --output bundle.json

这会创建: - bundle.json - 公共预密钥包(分发给客户端) - bundle.private.json - 私有预密钥数据(保留在服务器上)

第四步:配置客户端

创建 client.toml

# 服务器连接
server_address = "wss://your-server.com:443/connect"
identity_key_file = "identity.key"
prekey_bundle = "bundle.json"

# SOCKS5 代理设置
[socks5]
listen_address = "127.0.0.1:1080"
udp_associate = true

# TUN 设备设置(可选,用于完整 VPN 模式)
[tun]
interface_name = "rvpn0"
ip_address = "10.200.0.2/24"
dns_servers = ["1.1.1.1", "8.8.8.8"]
routes = ["0.0.0.0/0"]
mtu = 1420

# 性能调优
[performance]
worker_threads = 4
recv_buffer_size = 262144
send_buffer_size = 262144

# 分流隧道
[split_tunnel]
enabled = true
builtin_bypass_countries = ["CN"]
block_ads = false
auto_reload_interval = 300

# 网络设置
[network]
ipv6_enabled = true
prefer_ipv4 = true
dns_cache_enabled = true
dns_cache_ttl = 300
dns_cache_size = 1000

第五步:配置服务器

创建 server.toml

[server]
bind_address = "0.0.0.0:443"
websocket_path = "/connect"

tls_cert_file = "certs/cert.pem"
tls_key_file = "certs/key.pem"
identity_key_file = "server_identity.key"
prekey_bundle_file = "bundle.json"

# 速率限制
[server.rate_limit]
max_connections_per_ip = 5
max_handshakes_per_minute = 10

# 网络设置
[server.network]
nat_enabled = true
dhcp_range = "10.200.0.0/24"
dns_servers = ["1.1.1.1"]

第六步:连接

运行客户端:

# SOCKS5 模式(默认)
./rvpn --config client.toml

# TUN 模式(完整 VPN)
./rvpn --config client.toml --tun

您的 SOCKS5 代理现在运行在 127.0.0.1:1080

配置您的应用程序

将浏览器或应用程序配置为使用 SOCKS5 代理:

主机:127.0.0.1
端口:1080

Systemd 服务安装

对于生产部署,请使用 scripts/ 中的 systemd 服务安装程序:

# 安装客户端服务
sudo ./scripts/install-systemd.sh

# 安装服务器服务
sudo ./scripts/install-server-systemd.sh

有关完整的配置详细信息,请参阅 scripts/README.md

下一步