Skip to content

快速开始

仓库目前支持两套启动方式:

  • 推荐:远程优先的 deploy.sh 工作流
  • 备选:直接在目标主机上手工执行 docker compose

推荐工作流:deploy.sh

这条路径与仓库当前的主部署流程一致。

bash
# 1. 让 deploy.sh 知道目标主机
cp deploy.conf.example deploy.conf
$EDITOR deploy.conf

# 2. 在目标主机预拉取固定的 Rust builder 镜像
ssh root@<server> "docker pull rust:1.95.0-bookworm"

# 3. 一次性初始化
./deploy.sh --init

# 4. 检查远端运行配置
ssh root@<server> "cd <repo-root> && vi deploy/docker/.env"
# 旁路模式:设置 SNIFFER_INTERFACE
# 可选:AI_ENABLED=true、HF_ENDPOINT=https://hf-mirror.com
# MTA 模式:设置 MTA_DOWNSTREAM_HOST、MTA_DOWNSTREAM_PORT、MTA_LOCAL_DOMAINS

# 5. 部署你要的拓扑
./deploy.sh
./deploy.sh --backend
./deploy.sh --frontend
./deploy.sh --sniffer
./deploy.sh --mta

# 6. 正式发布打包
./deploy.sh --production
./deploy.sh --production --mta

./deploy.sh 是推荐的日常路径。它会同步仓库、在远端 vigilyx-rust-builder 里执行 clippy/test、构建 release-fast 二进制、打包镜像并重启当前拓扑。

备选:手工 Docker Compose

1. 生成密钥和密码

在项目根目录执行:

bash
bash scripts/generate-secrets.sh

这会生成 deploy/docker/.env,里面包含随机密码和密钥。

2. 修改部署配置

打开 deploy/docker/.env,按你的环境调整配置。

常见项:

  • SNIFFER_INTERFACE:旁路模式抓包网卡
  • AI_ENABLED=true:启用可选 AI 服务
  • HF_ENDPOINT=https://hf-mirror.com:中国大陆环境的 HuggingFace 镜像
  • MTA_DOWNSTREAM_HOSTMTA_DOWNSTREAM_PORT:Inline MTA 下游地址

3. 构建容器

bash
cd deploy/docker
docker compose build

4. 启动需要的模式

旁路镜像模式:

bash
docker compose --profile mirror up -d

旁路镜像模式 + AI:

bash
docker compose --profile mirror --profile ai up -d

Inline MTA 模式:

bash
docker compose --profile mta up -d

如果只执行 docker compose up -d,只会启动控制面容器(vigilyxpostgresredis)。要处理真实流量,必须显式加 --profile mirror--profile mta

5. 打开界面

  • HTTPS 入口:https://<server-or-domain>
  • 本机 API 调试入口:http://127.0.0.1:8088

登录信息:

  • 用户名:默认 admin,除非 .env 中设置了 API_USERNAME
  • 密码:deploy/docker/.env 里的 API_PASSWORD

说明

  • 生产环境建议保持 API_LISTEN=127.0.0.1,然后在前面接 Caddy 或 Nginx 做 TLS。
  • 不要假设有默认密码,API_PASSWORD 必须显式设置。
  • AI 是可选增强项,不开启 AI 时核心检测链依然可运行。

如果你需要更详细的部署说明,继续看 部署说明

基于 AGPL-3.0-only 发布。