sneak/upaas
1
0
Fork 0
Code Issues 14 Pull Requests 2 Actions Packages Projects Releases Wiki Activity

docs: expand Important note — HOST_DATA_DIR must be absolute path
All checks were successful
Check / check (pull_request) Successful in 11m32s
Details

Browse Source 
Explain why relative paths break container builds and add usage example.
Addresses sneak's review feedback on PR #126.
This commit is contained in:
clawbot 2026-02-23 13:17:21 -08:00
parent e115aa765a
commit 5791d33720
1 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -199,8 +199,12 @@ services:
# - METRICS_PASSWORD=secret # - METRICS_PASSWORD=secret
``` ```
**Important**: When running µPaaS inside a container, set `UPAAS_HOST_DATA_DIR` to the host path **Important**: You **must** set `HOST_DATA_DIR` to an **absolute path** on the host before running
that maps to `UPAAS_DATA_DIR`. This is required for Docker bind mounts during builds to work correctly. `docker compose up`. This value is bind-mounted into the container and passed as `UPAAS_HOST_DATA_DIR`
so that Docker bind mounts during builds resolve correctly. Relative paths (e.g. `./data`) will break
container builds because the Docker daemon resolves paths relative to the host, not the container.
Example: `HOST_DATA_DIR=/srv/upaas/data docker compose up -d`
Session secrets are automatically generated on first startup and persisted to `$UPAAS_DATA_DIR/session.key`. Session secrets are automatically generated on first startup and persisted to `$UPAAS_DATA_DIR/session.key`.