一个高可用,低时延,反审查的组网工具.
这个项目编译出的命令行版本可执行文件根据参数区分以服务端模式运行还是客户端模式运行,因此安装不区分客户端与服务端.
针对 Linux 环境差异,提供多种安装方式.请选择适合自己的方式安装.
建议使用 Docker 镜像,已上传到 Docker Hub 和 Github Packages.
容器需要管理员权限读取设备创建虚拟网卡并设置路由,同时需要 Host 网络命名空间共享虚拟网卡.
docker run --rm --privileged=true --net=host docker.io/lanthora/candy:latest --help使用 AUR 或者 archlinuxcn 仓库
# AUR
paru candy
# archlinuxcn
pacman -S candy使用 GURU 仓库
eselect repository enable guru
emerge --sync guru && emerge -av candy使用 OBS 仓库
# 以 Tumbleweed 为例,更新仓库缓存时选择信任签名
zypper addrepo https://download.opensuse.org/repositories/home:lanthora:candy/openSUSE_Tumbleweed/home:lanthora:candy.repo
zypper refresh && zypper install candy下载 DEB 安装包后通过以下命令安装
apt install --fix-broken ./xxx.deb当上述所有方式都不适用时,尝试单文件可执行程序.
该程序由交叉编译脚本构建.
请参考 Homebrew 中提供的方法安装.
本项目仅提供命令行版本,用户可以在此基础上自行定制.
依赖 C++20 的编译器.
cmake -B build -DCANDY_STATIC=1
cmake --build build
cmake --install build根据实际情况设置以下环境变量,查看受支持的系统和架构.
# 下载和编译所用目录的绝对路径
export CANDY_WORKSPACE=$HOME/workspace
# 操作系统
export CANDY_OS=linux
# 目标文件的架构
export CANDY_ARCH=x86_64执行构建脚本.构建时将下载编译工具链及依赖库,请确保网络通畅.
scripts/build-standalone.sh生成的二进制文件为 $CANDY_WORKSPACE/output/$CANDY_OS-$CANDY_ARCH/candy.
使用默认配置启动即可接入测试网络.客户端会缓存服务端分配的地址,并在下次启动时优先申请使用这个地址,地址保存在 /var/lib/candy 目录下,启动容器服务前需要在 Host 创建一个目录用于映射,否则容器重启丢失数据将导致重新分配地址.
创建与容器内相同的目录以方便理解.
mkdir -p /var/lib/candy以容器的方式接入测试网络
docker run --detach --restart=always --privileged=true --net=host --volume /var/lib/candy:/var/lib/candy docker.io/lanthora/candy:latest以 Linux 发行版 Service 的方式接入测试网络
systemctl enable --now candy当成功部署两个及以上客户端后,客户端之间可以相互访问.得益于路由功能,网络中的客户端数量越多,访问时延越低.
参数可以由命令行指定
# 查看可用的命令行参数
candy --help也可以通过配置文件指定.使用配置文件时需要指定路径.推荐使用配置文件,可以在不重建容器的情况下修改配置.
# 指定配置文件路径
candy -c /path/to/candy.cfg监听所有网卡的 80 端口,客户端连接后自动在 10.0.0.0/24 子网分配地址,并设置登录口令为 123456
# 以服务端模式工作
mode = "server"
# 服务端不支持 wss, 需要由外部的服务加密,例如 nginx/caddy, 生产环境建议使用 wss
websocket = "ws://0.0.0.0:80"
# 不配置此项时,客户端需要指定静态地址
dhcp = "10.0.0.0/24"
# 不配置此项时,口令为空
password = "123456"与上述服务端匹配的客户端配置
# 以客户端模式工作
mode = "client"
# 示例以 ws 传输明文,客户端支持 wss 协议
websocket = "ws://127.0.0.1:80"
# 需要与服务端配置保持一致
password = "123456"
# 静态地址,服务端配置 dhcp 的情况下可以不配置此项,由服务端随机分配地址
tun = "10.0.0.1/24"
# 网卡名,区分单个机器上的多个客户端,同一台主机的网卡名不能冲突,不配置此项表示使用默认网卡名 candy
name = "test"
# STUN 服务器,用于获取建立对等连接所需的公网信息,不配置此项表示不启用对等连接
stun = "stun://stun.canets.org"- Cucurbita: Candy Server with Web Control Interface
- EasyTier: A simple, decentralized mesh VPN with WireGuard support
- TG: Click to Join
- QQ: 768305206