Skip to content

DOCKER_QUICKSTART.md

Latest commit

 

History

History
125 lines (90 loc) · 3.43 KB

DOCKER_QUICKSTART.md

File metadata and controls

125 lines (90 loc) · 3.43 KB
Raw

ServiceRadar Docker Quick Start

One Command Setup - RECOMMENDED

docker compose up

Uses pre-built images from GitHub Container Registry (GHCR). Fast, consistent, and production-ready.

Development (Local Build)

docker compose -f docker-compose.dev.yml up

Builds images locally from source. Best for development and testing changes.

Tip: To make the dev file the default (no -f needed), set this in .env:

COMPOSE_FILE=docker-compose.yml:docker-compose.dev.yml

What happens with one command:

  • ✅ Generate mTLS certificates automatically
  • ✅ Generate random CNPG credentials stored in the cnpg-credentials volume
  • ✅ Pull/Build Docker images
  • ✅ Start the ServiceRadar stack (CNPG, NATS, web-ng, core-elx, agent-gateway)
  • ✅ Set up networking and persistent volumes
  • ✅ Run the core-elx migration runner to bootstrap schema/extensions

Alternative Commands

# Production deployment with pre-built images (default)
docker compose up

# Development with local builds  
docker compose -f docker-compose.dev.yml up

# Using Makefile (uses pre-built images)
make -f Makefile.docker start

# All services (optionally includes Redpanda)
make -f Makefile.docker up-full

Check Status

# View service status
make -f Makefile.docker status

# View logs
make -f Makefile.docker logs

# Test connectivity
make -f Makefile.docker test

Access Services

Stop Services

docker compose down

Environment Variables (Optional)

Copy .env.example to .env to customize:

  • Database passwords
  • API keys
  • Log levels
  • Service configuration
  • Optional compose defaults (see COMPOSE_FILE in .env.example)

All values have sensible defaults, so the .env file is optional.

Note: CNPG binds to loopback by default. Set CNPG_PUBLIC_BIND=0.0.0.0 in .env if you need LAN access.

Note: Docker Compose now auto-migrates an existing PG16 CNPG data volume to PG18 during startup. For existing installs, the normal path is still:

docker compose pull
docker compose up -d

Fresh installs and already-migrated PG18 volumes automatically no-op in the migration step.

If you need to run the migration explicitly, the helper is still available:

./docker/compose/migrate-cnpg-pg16-to-pg18.sh

If you already have a CNPG data volume from a previous install, note that we now store randomly generated DB credentials in a dedicated volume instead of shipping static defaults. Seed the cnpg-credentials volume once before starting. Legacy pre-security Compose data volumes are auto-recovered using the old defaults on first restart. If you use custom credentials or lost a newer cnpg-credentials volume, seed them explicitly:

docker compose run --rm \
  -e CNPG_SUPERUSER=<postgres-or-legacy-superuser> \
  -e CNPG_PASSWORD=<app-password> \
  -e CNPG_SUPERUSER_PASSWORD=<postgres-password> \
  db-credentials

What's Running?

  • cert-generator: One-time container that generates mTLS certificates
  • core-elx: ServiceRadar control plane and business logic
  • core-elx-migrations: One-shot migration runner (exits after schema bootstrap)

For full documentation, see README-Docker.md.