Docker usage¶
EPT can be run with Docker Compose using the configuration under deploy/docker/.
Get Docker¶
Install Docker from Docker's official website.
Start EPT from prebuilt images (no clone)¶
Both the API and the frontend are published on GHCR — pull and run them without cloning any repository:
export EPT_VERSION=latest # or another tag
docker network create ept-net
docker run -d --name ept-api --network ept-net -p 8000:8000 \
-v ept_workspace:/app/workspace -v ept_data:/app/data \
ghcr.io/edito-infra/edito-publishing-toolkit-backend:${EPT_VERSION}
# frontend — proxies /api to the backend
docker run -d --name ept-frontend --network ept-net -p 3000:8080 \
-e EPT_API_UPSTREAM=http://ept-api:8000 \
ghcr.io/edito-infra/edito-publishing-toolkit-frontend:${EPT_VERSION}
- Frontend (UI):
http://localhost:3000— it proxies/apito the backend - API:
http://localhost:8000· Swagger UI:http://localhost:8000/docs
No environment variables are required — the image bakes in the default
service URLs (publishing service, STAC API, Keycloak, MinIO) and client ID.
Set EDITO_*/PUBLISHING_API_URL with -e only to override them.
The workspace/ and data/ mounts keep exports and the deployment's
data/owner.state across container removals — same behaviour as the
from-source setup below.
Start EPT from source¶
From the repository root:
To run in the background:
The API is then available at:
- API index:
http://localhost:8000/v1 - Swagger UI:
http://localhost:8000/docs - OpenAPI schema:
http://localhost:8000/openapi.json
Check the container¶
Show the services managed by the Compose project:
The Compose service is named ept-api. Use that service name with docker compose commands.
View logs¶
Follow the API console logs:
EPT also writes an ephemeral log file inside the container at:
Read or follow it inside the running container with, for example, docker compose exec ept-api cat /tmp/ept/logs/api.log or a tail/Get-Content -Wait variant after opening a shell.
The file is removed with the container. Use docker compose logs or configure a Docker logging driver when logs must be retained outside the container.
Open a shell in the container¶
Open a shell in the running EPT service:
Once inside the container, read /tmp/ept/logs/api.log with the tools available in the image (for example cat or tail).
docker compose exec expects the Compose service name (ept-api), not the generated container name shown by docker ps.
Stop EPT¶
Stop and remove the Compose containers:
Persisted state¶
workspace/ and data/ next to the compose file are bind-mounted into the container, so they survive rebuilds, down, and even down -v (which only removes named volumes). data/owner.state records which EDITO user claimed this deployment — to release it, delete that file (root-owned when the container runs as root):