选择与你的运行环境和运维方式相符的安装路径
Installation

按你的基础设施,选择部署路径。

Compose 适合快速启动和单机部署;Linux 二进制适用于 systemd 运维;源码构建适用于贡献者和需要定制构建的团队。

all-in-one 将控制面和 Agent 合并运行;分布式模式由 server 管理多个独立 Agent。
根据流量入口和管理边界选择运行模式。拓扑图中的节点为逻辑组件示意。
Recommended · Docker Compose

使用 Compose 运行 all-in-one

项目提供 Compose 配置,启动 WAFred 与 PostgreSQL。正式启动前先设置随机数据库密码、JWT secret 和管理员密码。

OPTIONAL INSTALLERLinux · Docker
curl -fsSL https://raw.githubusercontent.com/oyport/wafred/main/deploy/compose/install.sh | bash

安装脚本会获取 Compose 文件、写入本地环境配置并启动服务。可先在 GitHub 阅读 脚本源码;也可以使用 手动快速开始,自行检查每一步。

Linux · systemd

使用预编译二进制部署

从 GitHub Releases 获取对应 Linux 架构的发布文件,配置 PostgreSQL、服务参数和 systemd 单元。生产环境应单独规划控制面与数据面访问边界。

查看可用发行包

From source

从源码构建

适合贡献者、需要修改代码或希望自行构建二进制的团队。源码路径需要 Rust 工具链和项目要求的前端、协议编译工具。

查看仓库构建步骤

Choose a mode

运行模式决定服务边界

模式运行职责常见部署
all-in-one控制面和数据面同时运行单机、试用、小型站点
server管理控制台、API 和 gRPC 服务集中管理节点
agent连接 server,代理并检查流量靠近流量入口的边缘主机
查看架构图
Network planning

按用途规划监听端口

端口服务部署建议
80 / 443Agent 的 HTTP/S 代理流量对需要保护的外部流量开放
9080控制台、REST API 与健康检查仅从受信任管理网络访问
9090控制面的 gRPC 服务仅允许配置过的 Agent 连接
Before production

上线前检查项

  • 替换所有示例管理员、数据库和 JWT 凭据,使用足够长度的随机密钥。
  • 限制控制台与 API 的网络可达范围,不要将管理端口无条件暴露到公网。
  • 明确证书签发方式、Agent 与控制面的 TLS 信任关系和回源证书校验策略。
  • 为 PostgreSQL 与配置数据安排备份,并在升级前查看发行说明。
  • 先使用测试站点验证路由、判决和日志,再将真实流量切换至 WAFred。

安全提示。快速启动示例用于帮助理解配置,不应替代生产环境安全审查。请参考仓库部署指南中的完整安全清单。

References

部署文档与发行说明

部署指南

Docker、systemd、分布式部署、TLS、备份与升级。

打开部署指南 →
发行版本

查看仓库中正式发布的版本、文件和升级说明。

查看 GitHub Releases ↗