📚 文档中心

从零基础到高级用法，手把手带你用好 深常乐-sdwan

🚀 快速入门

只需三步，五分钟内完成你的第一个企业组网。无需专业知识，无需复杂配置。

1

注册账号

访问控制台，使用邮箱或手机号注册，立即获得 3 个免费节点额度。

2

安装客户端

在需要联网的设备上安装客户端。支持 Windows、macOS、Linux、NAS、Docker。

3

完成组网

所有设备自动加入同一虚拟局域网，互访如同在本地。开始使用了！

小贴士：免费版支持 N 个直连节互联点。如需使用中心节点互联互通，请升级使用。

📝 注册与登录

注册新账号

打开控制台，点击"注册"按钮。填写以下信息：

  • 用户名 — 你的登录账号，4-20 个字符
  • 手机号 — 用于接收验证码和重要通知
  • 密码 — 建议包含大小写字母和数字，至少 8 位
  • 公司名称（选填）— 方便后续团队协作

登录方式

支持两种登录方式：

方式说明
账号密码登录使用注册时设置的用户名和密码
短信验证码登录输入手机号，接收 6 位验证码后登录
注意：为了账号安全，首次登录后建议立即在"个人信息"中设置安全邮箱作为备用恢复方式。

🔗 创建第一个组网

注册并登录后，按照以下步骤创建你的第一个组网：

1

进入节点管理

登录控制台后，在左侧菜单点击"我的节点"，进入节点管理页面。

2

添加第一个节点

点击"添加节点"，输入节点名称（如"总部服务器"），选择节点类型（服务端/客户端），确认创建。

3

下载配置文件

节点创建成功后，点击"下载配置"，获取该节点的专属配置文件。

4

安装并导入配置

在目标设备上安装客户端，导入上一步下载的配置文件。客户端自动连接并加入网络。

5

验证联通

在任意节点上 ping 其他节点的内网 IP，确认互通。至此组网完成！

🐳 Docker 部署

推荐使用 Docker 部署，一行命令即可启动，是最便捷的部署方式。

📥 下载 Dockerfile 📥 下载 docker-compose.yml 📥 下载 entrypoint.sh

前提条件

  • 已安装 Docker（版本 20.10 及以上）
  • 已安装 Docker Compose（版本 v2 及以上）
  • 已在控制台创建节点并获取授权 Token

方式一：docker-compose（推荐）

1

下载部署文件

下载上面三个文件到同一目录，或使用命令行：

# 创建部署目录 mkdir sdwan-client && cd sdwan-client # 下载部署文件 wget https://<YOUR_SERVER>/download/docker/Dockerfile wget https://<YOUR_SERVER>/download/docker/docker-compose.yml wget https://<YOUR_SERVER>/download/docker/entrypoint.sh
2

修改服务器地址

编辑 docker-compose.yml，将 SDWAN_SERVER 环境变量改为你的控制服务器地址。

# 编辑 docker-compose.yml 中的服务器地址 sed -i 's|https://|https://你的服务器地址|g' docker-compose.yml

如果已有预授权 Token，可以设置 SDWAN_TOKEN 环境变量跳过首次交互登录。

3

构建并启动

# 构建镜像 docker compose build # 启动容器 docker compose up -d # 查看日志 docker compose logs -f
4

首次交互登录（仅首次需要）

如果没有设置 SDWAN_TOKEN，容器启动后会进入交互模式等待登录：

# 进入容器交互模式 docker attach sdwan-client # 按提示输入账号密码，登录成功后 Ctrl+P Ctrl+Q 退出（不停止容器）

登录成功后配置持久化在数据卷中，后续重启自动重连。

方式二：纯 docker run

# 构建镜像 docker build -t sdwan-client . # 运行（需要 --cap-add NET_ADMIN 权限） docker run -d \ --name sdwan-client \ --restart always \ --cap-add NET_ADMIN \ --cap-add SYS_MODULE \ --sysctl net.ipv4.ip_forward=1 \ -e SDWAN_SERVER=https:// \ -v sdwan-config:/root/.saas-wg-agent \ --network host \ sdwan-client
说明：使用 --network host 可获得最佳网络性能。如无法使用 host 网络，请映射 UDP 51820 端口。

🐧 Linux 原生安装

支持 Ubuntu 20.04+、Debian 11+、CentOS 7+、Rocky Linux 8+ 等主流发行版。

📥 下载 install.sh

一键安装（推荐）

自动检测系统版本，安装 WireGuard + Python 依赖 + Agent 程序 + systemd 服务，全程约 2 分钟。

# 下载安装脚本 curl -fsSL https:///download/linux/install.sh -o install.sh # 可选：指定服务器地址（不指定则使用脚本内置默认） export SDWAN_SERVER="https://" # 运行安装（需要 root 权限） sudo bash install.sh

安装脚本会自动完成以下操作：检测系统版本 → 安装 WireGuard 和 Python3 依赖 → 部署 Agent → 创建 systemd 服务 → 设置 sdwan-client 命令行工具。

手动安装步骤

1

安装 WireGuard

# Ubuntu/Debian sudo apt install wireguard-tools -y # CentOS/Rocky sudo yum install wireguard-tools -y
2

部署 Agent

将 Agent 相关文件复制到 /opt/sdwan/agent/，安装 Python 依赖。

sudo mkdir -p /opt/sdwan/agent /root/.saas-wg-agent sudo pip3 install requests pyroute2
3

首次初始化

cd /opt/sdwan/agent sudo python3 main.py --server https://<YOUR_SERVER> init

按提示输入账号密码完成授权，配置自动保存。

4

启动守护进程

sdwan-client daemon # 前台运行 systemctl start sdwan-client # systemd 后台运行 systemctl enable sdwan-client # 开机自启

常用管理命令

命令说明
sdwan-client status查看连接状态和网络信息
sdwan-client login重新登录授权
sdwan-client connect建立 WireGuard 隧道
sdwan-client disconnect断开隧道连接
sdwan-client reset清除配置重新开始
sdwan-client log查看实时运行日志
提示：安装完成后 Agent 自动注册为系统服务并开机自启。sdwan-client 命令行工具随时可用。

🪟 Windows 安装

Windows 10/11 支持两种方式：PowerShell 一键安装脚本（推荐）或手动安装。

📥 下载 install.ps1

方式一：PowerShell 一键安装（推荐）

1

下载脚本

下载上面的 install.ps1 到本地。

2

以管理员身份运行 PowerShell

右键「开始」菜单 → Windows PowerShell (管理员) 或 终端 (管理员)。

3

执行安装

# 允许脚本执行 Set-ExecutionPolicy Bypass -Scope Process -Force # 运行安装（可指定服务器地址） .\install.ps1 -ServerUrl "https://<YOUR_SERVER>"

脚本会自动：检查管理员权限 → 安装 Python3 → 安装 WireGuard → 部署 Agent → 创建快捷命令。

4

登录并获取配置

安装完成后，有两种使用方式：

A) Agent 模式：在命令行运行 sdwan-client login，输入账号密码自动获取配置。

B) 纯 WireGuard 模式：从控制台下载 .conf 配置 → 打开 WireGuard 客户端 → 导入隧道 → 激活。

方式二：纯 WireGuard 客户端（适合不装 Python 的环境）

1

安装 WireGuard

从 wireguard.com 下载 Windows 客户端（.msi），双击安装。

2

下载节点配置

登录控制台 → 我的节点 → 点击节点 → 下载 .conf 配置文件。

3

导入并激活

打开 WireGuard → 添加隧道 → 导入配置文件 → 点击「激活」。任务栏图标变绿即连接成功。

注意：首次运行时 Windows 防火墙可能会弹出网络访问提示，请选择「允许访问」。系统重启后 WireGuard 和 Agent 都会自动启动。

🍎 macOS 安装

1

下载 macOS 客户端

从官网下载 .dmg 安装包，双击打开。

2

拖入应用程序

将 深常乐-sdwan 图标拖入 Applications 文件夹。

3

允许系统扩展

首次运行时，系统会提示需要网络扩展权限。前往"系统设置 → 隐私与安全性"，点击"允许"。

4

导入配置并连接

导入从控制台下载的配置文件，点击连接即可。

小贴士：macOS 菜单栏会显示连接状态图标 🟢（已连接）/ 🔴（未连接），点击可快速操作。

💾 NAS 接入指南

支持群晖（Synology）、威联通（QNAP）等主流 NAS 品牌。推荐使用 Docker 方式部署。

群晖 NAS（Docker 方式）

1

安装 Docker 套件

在群晖"套件中心"搜索并安装 Docker。

2

上传配置文件

将下载的 client.conf 上传到群晖的某个共享文件夹，如 /volume1/docker/sdwan/。

3

创建容器

打开 Docker → 注册表，搜索 saas-sdwan/client，下载后创建容器。在"卷"设置中挂载配置文件。

4

启动容器

勾选"使用高权限执行容器"，启动。在"容器"列表中确认状态为运行中。

群晖 NAS（SSH 命令行方式）

# SSH 登录群晖 ssh admin@your-nas-ip # 使用 Docker 部署 docker run -d \ --name sdwan-client \ --restart always \ --cap-add NET_ADMIN \ -v /volume1/docker/sdwan/client.conf:/etc/sdwan/client.conf \ saas-sdwan/client:latest
重要：NAS 通过 Docker 接入后，局域网内的其他设备不会自动加入组网。如需整网接入，请参考下方"路由器配置"章节。

📡 路由器配置

支持 OpenWrt、iKuai 等主流软路由系统。路由器接入后，局域网内所有设备自动加入组网，无需逐台安装客户端。

📥 下载 OpenWrt 安装脚本

OpenWrt 一键安装

适用于 OpenWrt 21.02+，支持 x86_64 / arm / mips 架构。

1

下载并上传脚本

# 直接在路由器上下载 wget https://<YOUR_SERVER>/download/openwrt/install.sh -O /tmp/install.sh

或从电脑下载后 scp 上传到路由器 /tmp/ 目录。

2

运行安装脚本

cd /tmp sh install.sh

脚本会自动：检测 OpenWrt 版本和架构 → 安装 wireguard-tools → 可选安装 Python Agent → 配置 init.d 启动脚本和防火墙规则。

3

获取配置并启动

安装时可选择两种模式：

Agent 模式（需 Python3，约 10MB）：自动从控制台拉取配置，支持心跳和远程管理。

纯 WireGuard 模式（推荐低配路由器）：从控制台下载 .conf → 放到 /etc/wireguard/wg0.conf → sdwan-client start。

OpenWrt 管理命令

命令说明
sdwan-client status查看 WireGuard 接口和服务状态
sdwan-client start启动 WireGuard 隧道和 Agent
sdwan-client stop停止服务
sdwan-client enable设置开机自启
sdwan-client log查看 sdwan 相关系统日志

旁路模式 vs 主路由模式

模式适用场景优点
旁路模式不想改变现有网络结构即插即用，拔掉即恢复原状
主路由模式整网所有设备都需要加入组网统一管理，性能更好
推荐：门店和分支机构建议使用旁路模式，将一台小型软路由接入现有交换机，无需改动任何现有网络设备。

🛡️ 安全最佳实践

1

开启多因素认证（MFA）

在控制台"个人信息"中绑定 TOTP 验证器（如 Google Authenticator），为账号加一层保护。

2

合理设置访问控制

遵循最小权限原则。普通员工节点只开放必要端口访问，财务/核心系统节点限制访问来源。

3

定期检查审计日志

在管理员后台"日志审计"页面检查异常登录和操作记录，及时发现安全风险。

4

及时更新客户端

保持客户端版本为最新，安全补丁会随版本更新及时推送。

🔧 故障排查

常见问题与解决方法

节点显示离线

✓

检查客户端是否正在运行：systemctl status sdwan-client

✓

检查设备能否正常访问外网：ping 8.8.8.8

✓

查看客户端日志：sdwan-client logs 或 docker logs sdwan-client

✓

检查防火墙是否放行了所需端口（默认 UDP 端口请参考配置文件）

连接成功但 ping 不通其他节点

✓

检查目标节点是否在线

✓

确认访问控制规则没有阻止双方通信

✓

检查两个节点是否在同一个分组中

✓

尝试使用内网 IP（10.x.x.x）而非公网 IP 进行通信

速度比预期慢

✓

确认是否启用了点对点直连（P2P），直连模式下不经过中继节点

✓

检查当前带宽套餐是否满足需求，可按需升级

✓

确认设备 CPU/内存未过载，加密传输需要一定的计算资源

需要更多帮助？如果以上方法无法解决，请联系技术支持（support@szcl.net.cn），提供客户端日志以便快速定位问题。

❓ 常见问题

传统 VPN 需要专业人员配置，部署周期长，且所有设备互相可见，安全风险高。我们实现自动化部署，五分钟上线，支持精确到设备级的权限控制，真正做到零信任安全。

采用银行级端到端加密传输，支持多因素认证（MFA），操作日志全程审计，满足企业合规要求。所有通信都经过严格的身份验证。

支持全平台：Windows、macOS、Linux、群晖 NAS、OpenWrt 路由器、Docker 容器。Windows/macOS 提供图形化客户端，其他平台一行命令即可接入。

按节点数量和带宽计费。免费版支持 3 个节点。点对点直连流量完全免费、不限量。详见定价页面。

不会。组网是在现有网络之上叠加的虚拟层，不改变原有网络结构和 IP 地址。支持旁路模式，上网流量走本地，工作流量走加密隧道，互不影响。

点对点直连模式下，延迟仅取决于两端的物理网络距离。智能选路引擎自动选择最优路径，同城延迟通常不超过 5ms，跨省延迟 10-30ms。

免费版最多支持 3 个节点、10 Mbps 带宽，包含基础的访问控制功能。没有时间限制，可以永久免费使用。适合个人和小团队体验。

企业版支持私有化部署，所有数据存储在您自己的服务器上。联系我们了解私有部署方案。

可以渐进式迁移。先在关键节点部署我们的客户端，与现有 VPN 并行运行，验证无误后逐步切换。整个过程不影响业务。

团队版支持 50 个节点，通常可以覆盖 1 个总部 + 10-20 个分支门店。节点数不够时可以随时升级到企业版，不限节点数量。

📋 更新日志

v2.1.0 — 2026-07-15

  • 新增访问控制规则批量导入导出
  • 优化跨运营商连接的稳定性
  • 控制台新增用量趋势图表
  • 修复部分 NAS 型号 Docker 兼容性问题

v2.0.0 — 2026-06-01

  • 全新自服务门户上线，租户可自助管理节点和套餐
  • 多租户 SaaS 管理体系正式发布
  • AAA 计费模块上线，支持流量统计和自动出账

v1.5.0 — 2026-04-20

  • 支持 N2N P2P 直连，延迟降低 60%
  • 新增 Docker 一键部署方式
  • Windows/macOS 图形化客户端发布