Compose 示例来自项目仓库,可先查看文件再启动
Docker Compose · All-in-One

先让 WAFred 在你的环境里运行。

以下流程使用仓库中的 Docker Compose 文件启动 WAFred 与 PostgreSQL。建议先生成独立的数据库、JWT 和管理员密码,再开放控制台端口。

Docker Engine 24+Compose v2Linux amd64 / arm64
Before you begin

准备运行环境

  • 安装 Docker Engine 24 或更新版本,并启用 Docker Compose v2。
  • 准备可用的主机名或测试域名;生产部署还需规划 80、443、9080 与 9090 端口的网络边界。
  • 生产环境使用独立的随机密码和 JWT secret,不要保留示例默认值。
01 · Get the source

克隆项目仓库

TERMINALShell
git clone https://github.com/oyport/wafred.git
cd wafred

Compose 文件包含 WAFred 服务和 PostgreSQL。启动前可先查看 docker-compose.yml 与环境变量定义。

02 · Set secrets

为当前 Shell 生成密钥

示例使用 OpenSSL 生成随机值。它们保存在当前终端会话中,随后 Compose 会读取这些环境变量。

TERMINALSecrets
export POSTGRES_PASSWORD="$(openssl rand -hex 16)"
export JWT_SECRET="$(openssl rand -hex 32)"
export ADMIN_PASSWORD="$(openssl rand -hex 16)"
export ADMIN_EMAIL="[email protected]"
export ALLOW_REGISTRATION="false"

生产环境请谨慎保管密钥。如果改用 .env 文件,仓库文档提醒该文件不会自动被 Git 忽略。确认它不会进入版本控制,并限制文件读取权限。

03 · Start services

启动并查看服务状态

TERMINALDocker Compose
docker compose up -d
docker compose ps
docker compose logs -f wafred

启动日志可确认数据库健康检查、控制面监听和 Agent 初始化情况。首次拉取容器镜像需要额外时间。

04 · Verify

检查健康状态并登录控制台

TERMINALHealth check
curl -sf http://localhost:9080/healthz

健康接口返回成功后,在浏览器打开 https://localhost:9080。登录账号为配置的管理员邮箱,密码为本次生成的 ADMIN_PASSWORD。本地首次启动通常使用自签名证书;生产环境应配置自己的主机名与 TLS。

05 · Protect a site

添加站点,再显式开启防护

流量进入 Agent 后按策略放行、挑战或拦截,验证通过的请求继续访问源站。
流程示意:具体响应由每个站点启用的策略决定。
  1. 在控制台创建站点,填写域名、监听方式和源站地址。
  2. 将测试域名指向 WAFred Agent,并确认请求能正常转发到源站。
  3. 按需开启 WAF 或其他防护能力。默认关闭的策略不会自动替你改变站点流量。
  4. 发送正常和测试请求,在请求日志中确认路由、判决与命中规则。
了解判决和检测链路
Next steps

从单机扩展到你的网络边界

生产部署

查看端口、TLS、备份和升级建议。

打开部署指南 →
分布式 Agent

了解控制面和数据面的网络关系。

查看架构 →
Need another install path?

按部署环境选择安装方式。

Compose、Linux 二进制和源码构建各自适合不同的运维流程。