Skip to content

README.md

Latest commit

聽

History

History
64 lines (48 loc) 路 1.66 KB

README.md

File metadata and controls

64 lines (48 loc) 路 1.66 KB
Raw

GovTool Docker Compose

This folder contains a compose file for running GovTool services locally.

Prerequisites

  • Docker and Docker Compose
  • A reachable db-sync Postgres instance

Configure environment

From the repo root

cd docker
cp .env.example .env

Note

Update the backend config file used by the govtool-backend service in example-config.json before starting the stack.

Also create the frontend and metadata-validation environment files:

cp ../govtool/frontend/.env.example ../govtool/frontend/.env
cp ../govtool/metadata-validation/.env.example ../govtool/metadata-validation/.env

Docker Compose loads the frontend container's runtime configuration from govtool/frontend/.env. Edit that file to configure the backend and metadata-validation URLs, network, and optional frontend integrations.

Fill in the db-sync details and required service URLs in docker/.env.

Note: The .env.example in this folder is for the outcomes service only.

Edit docker/.env with real values:

  • DBSYNC_POSTGRES_HOST
  • DBSYNC_POSTGRES_PORT
  • DBSYNC_DATABASE
  • DBSYNC_POSTGRES_USER
  • DBSYNC_POSTGRES_PASSWORD
  • IPFS_GATEWAY
  • PDF_API_URL

Validate the resolved Compose configuration before starting services:

docker compose config

Start services

Option A: build locally (uses Dockerfiles)

docker compose up -d --build

Option B: use images only (no build)

docker compose pull
docker compose up -d --no-build

Service endpoints