快速开始#

本页目标：在 10 分钟内跑起 Dockrev，并验证从“发现服务”到“执行检查”的主流程。

前置条件#

• Docker Engine 可用
• Docker Compose 可用（docker-compose 或 docker compose）
• 本机可访问端口 50883
• 已准备 Docker registry 凭据（私有镜像场景）

一键启动（最小方式）#

cd deploy
mkdir -p data
# Dockrev stages this file for update-job Docker/Compose auth; no extra /root/.docker/config.json mount is required.
cp ~/.docker/config.json data/docker-config.json
# If you rely on Docker contexts, configure DOCKREV_DOCKER_CONFIG with a real config.json path instead of a renamed copy.

docker compose up --build

访问入口：

• UI: http://127.0.0.1:50883/
• API health: http://127.0.0.1:50883/api/health
• Supervisor: http://127.0.0.1:50883/supervisor/

5 分钟验收（必须全部通过）#

1. GET /api/health 返回 ok。
2. 首页能看到服务列表，不出现 401。
3. 执行一次“立即扫描”后，Queue 中出现 discovery 任务并结束为 success。
4. 对任意服务执行一次 check，任务日志中能看到 registry 请求与结果。

第一次验证清单#

1. 打开 Overview 页面，确认可以加载服务列表。
2. 点击“立即扫描”，确认系统可触发 Discovery。
3. 对任意服务触发 Check，确认 Job 进入队列并有日志。
4. 打开 Queue 页面，确认 Job 状态变化完整（running -> success/failed）。

本地开发启动（非容器）#

工作区依赖#

bun run hooks:install
bun run bootstrap:worktree

hooks:install 会安装 shared Git post-checkout hook。新 linked worktree 切入后会自动运行项目内依赖 bootstrap：根目录、web/、docs-site/ 的 Bun 依赖，以及 cargo fetch --locked。它不会安装 Bun、Rust、Playwright browsers 或系统包；如需临时跳过自动运行，设置 DOCKREV_BOOTSTRAP_SKIP=1。

后端#

DOCKREV_HTTP_ADDR=127.0.0.1:50883 DOCKREV_DB_PATH=/tmp/dockrev.sqlite3 cargo run -p dockrev-api --bin dockrev

Supervisor#

DOCKREV_SUPERVISOR_HTTP_ADDR=127.0.0.1:50884 cargo run -p dockrev-supervisor --bin dockrev-supervisor

前端#

cd web
bun install
bun run dev

下一步#

• 进入 部署指南 完成生产部署。
• 进入 配置参考 完成认证、镜像识别和重试参数配置。

启动失败时先看这里#

• 容器启动失败：docker compose logs --tail=200
• API 不通：确认 50883 未被占用（lsof -iTCP:50883 -sTCP:LISTEN -n -P）
• 页面 401：检查反向代理是否注入了 X-Forwarded-User（以及你配置的组头，如 Remote-Groups），并确认 Dockrev 允许的用户/组配置正确