Quick Start#

Goal: get Dockrev running in about 10 minutes and validate the end-to-end flow.

Prerequisites#

• Docker Engine is available
• Docker Compose is available (docker-compose or docker compose)
• Local port 50883 is available

Minimal startup#

cd deploy
mkdir -p data
# Dockrev stages this file for update-job Docker/Compose auth, so you do not need an extra /root/.docker/config.json mount.
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

Entry points:

• 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/

First validation checklist#

1. Open Overview and confirm services are listed.
2. Run Discovery scan from UI.
3. Trigger one Check job for any service.
4. Open Queue and confirm state transitions.

Local dev startup (without containers)#

Worktree dependencies#

bun run hooks:install
bun run bootstrap:worktree

hooks:install installs a shared Git post-checkout hook. New linked worktrees automatically run the project-local bootstrap: root, web/, and docs-site/ Bun installs plus cargo fetch --locked. It does not install Bun, Rust, Playwright browsers, or system packages. Set DOCKREV_BOOTSTRAP_SKIP=1 to skip the automatic hook run.

Backend#

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

Web UI#

cd web
bun install
bun run dev

Next steps#

• Continue with Deployment
• Then apply Configuration