Operations · Deployment

部署 WAFred,先明确服务边界。

从单机 Compose 到 server + agent 分布式拓扑,共用控制面和数据面模型。部署方案应匹配流量入口、网络隔离和运维责任。

Docker ComposeLinux · systemd自托管
01 · Compose

Docker Compose:单机启动

Compose 配置启动 WAFred all-in-one 服务和 PostgreSQL。适合体验、开发和单机部署。首次启动前设置数据库密码、JWT secret 和管理员密码,健康检查确认服务就绪后再登录控制台。

TERMINALCompose v2
git clone https://github.com/oyport/wafred.git
cd wafred
docker compose up -d
docker compose ps

完整的环境变量、持久卷和升级指令请以仓库中当前版本的 deployment.md 为准。

02 · Distributed

server + 多个 agent:分开管理与流量入口

server 运行控制台、REST API、gRPC 服务和数据库连接;agent 连接控制面,运行在需要接入流量的位置。各节点之间需要具备相互可达的管理链路和正确的 TLS 信任配置。

server 通过 gRPC 管理多个独立的边缘 Agent;all-in-one 模式则在同一实例运行控制面和 Agent。
Agent 在流量入口代理请求;Server 集中下发策略与收集状态。
  1. 将管理面放在受限的管理网络。
  2. 只向预期 Agent 开放 gRPC 连接端口。
  3. 在各 Agent 部署数据面流量入口,并确认其到源站的网络路径。
  4. 通过控制台检查节点心跳、站点同步和请求日志。
阅读架构说明
03 · Listeners

监听端口和访问边界

端口用途边界建议
80 / 443HTTP/S 代理请求开放给需要经过 WAFred 的流量。
9080管理控制台、REST API、健康检查限制为受信任的运维网络。
9090Agent 到控制面的 gRPC 连接限制为已部署的 Agent 和管理网络。

具体监听地址、TLS 行为和端口映射以所选运行模式与配置为准。

04 · TLS

规划证书与加密连接

  • 站点证书可使用 ACME HTTP-01 或 DNS-01 流程签发与续期。
  • 配置 server 与 agent 间的 gRPC TLS 信任,Agent 应连接到与证书匹配的主机名。
  • 外部 TLS 终止代理后的控制台连接,需要按部署方式明确启用 TLS 行为。
  • 若上游提供受信任证书,应显式配置回源证书校验。
05 · Operations

备份、升级与恢复

数据库和配置数据属于自托管环境的运维责任。上线前建立备份计划,发布升级前查看兼容说明,并在可恢复的测试环境检查回滚方案。

数据库

备份 PostgreSQL 数据并定期确认恢复流程。

配置版本

控制台支持快照差异比较和确认后回滚。

发行版本

升级前阅读对应版本的 release notes。

运行日志

根据保留需求配置日志存储和磁盘容量。

Full reference

查看随版本维护的完整部署资料

端口默认值、配置项和升级步骤会随项目版本更新。正式操作时,请核对当前部署版本对应的源仓库文档。

打开 GitHub 部署文档