overseer
f670121489
The API deployable had no packaging of its own: its runtime deps lived only in the integration's dev group, so there was no way to deploy the service without dragging the test venv along. Package the API as a container image (Dockerfile, multi-stage slim build, non-root) with the deployable's own manifest api/requirements.txt, and run it via deploy/compose.yaml with the SQLite file on the named volume nestquest-db so recreating the container keeps household data. Secrets are supplied by the environment (ignored deploy/.env, example with placeholder names only). TLS/reverse proxy, Authentik wiring and network separation are later Feature 17 tasks; the port is bound to localhost until they land.
41 lines
1.5 KiB
YAML
41 lines
1.5 KiB
YAML
# Compose deployment scaffold for the NestQuest API service (Feature
|
|
# 17). The SQLite database lives on the NAMED VOLUME ``nestquest-db``
|
|
# mounted at /var/lib/nestquest — recreating the container keeps the
|
|
# household data (``docker compose down`` leaves named volumes alone).
|
|
#
|
|
# Configuration is supplied by the environment: the fixed database
|
|
# path here, and the secret values (panel service token, Authentik
|
|
# OIDC settings) from ``deploy/.env`` — a git-ignored file you create
|
|
# from ``deploy/.env.example`` (placeholder names only; never commit
|
|
# real values). TLS/reverse proxy, Authentik wiring and network
|
|
# separation are later Feature 17 tasks; the port is bound to
|
|
# localhost only until those land.
|
|
services:
|
|
api:
|
|
build:
|
|
context: ..
|
|
dockerfile: Dockerfile
|
|
image: nestquest-api:latest
|
|
init: true
|
|
restart: unless-stopped
|
|
ports:
|
|
- "127.0.0.1:8080:8080"
|
|
environment:
|
|
# The SQLite file inside the named volume; fixed, not a secret.
|
|
NESTQUEST_DB_PATH: /var/lib/nestquest/nestquest.db
|
|
env_file:
|
|
# Secret values (NESTQUEST_PANEL_TOKEN, NESTQUEST_OIDC_*); absent
|
|
# until you create deploy/.env from the example.
|
|
- path: .env
|
|
required: false
|
|
volumes:
|
|
- nestquest-db:/var/lib/nestquest
|
|
healthcheck:
|
|
test: ["CMD", "python", "-c", "import urllib.request; urllib.request.urlopen('http://127.0.0.1:8080/health')"]
|
|
interval: 10s
|
|
timeout: 5s
|
|
retries: 5
|
|
start_period: 15s
|
|
|
|
volumes:
|
|
nestquest-db: |