Skip to content

DOCKER.md

Latest commit

 

History

History
162 lines (108 loc) · 3.79 KB

DOCKER.md

File metadata and controls

162 lines (108 loc) · 3.79 KB
Raw

Docker

This project runs as a single Docker Compose service named dphe-data-api.

Files

  • Dockerfile builds the Node.js API image.
  • docker-compose.yml defines the Compose service and port mapping.
  • .env sets local Compose overrides such as DB_PATH and PORT.
  • docker-compose.env is an optional tracked env file you can pass with --env-file.

Database Path Rules

The Docker image includes the local test fixture at /app/test/resources/deepphe.sqlite3. Because the API runs inside the container, DB_PATH must be a container path, not a macOS/Linux host path. These are both valid for the bundled fixture:

DB_PATH=./test/resources/deepphe.sqlite3
DB_PATH=/app/test/resources/deepphe.sqlite3

The SQLite client opens the database read/write, so any externally mounted database directory must be writable.

Serve The 500-Patient Fixture

The image also bundles a larger fixture at /app/test/resources/deepphe-500.sqlite3. To serve it instead of the default, point DB_PATH at it. For example, in .env:

DB_PATH=./test/resources/deepphe-500.sqlite3

Or for a single run without editing .env:

DB_PATH=./test/resources/deepphe-500.sqlite3 docker compose up --build

.env Overrides Defaults

Compose automatically reads .env and uses those values to fill docker-compose.yml. Values in .env override the Docker defaults in Compose.

To run with the bundled test fixture, put this in .env:

DB_PATH=./test/resources/deepphe.sqlite3
PORT=3333

Then build and start:

docker compose up --build

Open:

http://localhost:3333/docs

Run in the background:

docker compose up --build -d

View logs:

docker compose logs -f dphe-data-api

Stop the service:

docker compose down

Start With A Different Env File

Create another env file, for example docker-compose.local-db.env:

DB_PATH=/app/db/my_local_database.sqlite3
PORT=3333

Files matching docker-compose.*.env are ignored by git, except for the tracked example docker-compose.env.

Start Compose with that env file:

docker compose --env-file ./docker-compose.local-db.env up --build

Using --env-file replaces Compose's automatic .env file for that run. If you want .env to win, put the final values in .env or pass them directly before the command.

Start With DB_PATH On The Command Line Instead Of .env

For docker compose up, prefix the command with env vars:

DB_PATH=./test/resources/deepphe.sqlite3 PORT=3333 docker compose up --build

docker compose up does not support a per-service -e DB_PATH=... flag. If you specifically want -e, use docker compose run with --service-ports:

docker compose build
docker compose run --rm --service-ports \
  -e DB_PATH=./test/resources/deepphe.sqlite3 \
  dphe-data-api

If a normal Compose container is already running, stop it first so port 3333 is free:

docker compose down

Use A Database Outside This Repository

If your database lives outside this repository, mount its directory when using docker compose run:

docker compose build
docker compose run --rm --service-ports \
  -v /absolute/host/db-dir:/app/db:rw \
  -e DB_PATH=/app/db/deepphe.sqlite3 \
  dphe-data-api

Replace /absolute/host/db-dir with the host directory that contains the SQLite database file.

Ports

The Docker container listens on port 3333 by default. To expose it on a different Docker port, set PORT in .env or before running Compose:

PORT=4444 docker compose up --build

Then open:

http://localhost:4444/docs

Verify The Compose Configuration

Show the resolved Compose configuration:

docker compose config

For a quiet validation check:

docker compose config --quiet