about summary refs log tree commit diff stats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md28
1 files changed, 20 insertions, 8 deletions
diff --git a/README.md b/README.md
index 25e7190..cb40138 100644
--- a/README.md
+++ b/README.md
@@ -47,22 +47,34 @@ See `.env-dist` for configuration options.
 Development
 -----------
 
+Run the stack with the dev overlay, which bind-mounts the source tree into the
+`app` and `web-nginx` containers and exposes PostgreSQL on `127.0.0.1:15432`:
+
+    npm run dev            # docker compose -f docker-compose.yml -f docker-compose.dev.yml
+    npm run dev -- up
+    npm run dev -- up -d app
+    npm run dev -- logs -f app
+
+The overlay is deliberately plain Compose (no `!override` YAML tag), so it works
+with both Docker Compose and `podman-compose`, which only concatenates the volume
+lists of the two files and keeps the last entry per mount target.
+
+Docker Compose v2.24+ users who prefer auto-loading may keep a local
+`docker-compose.override.yml` instead, where the `!override` tag replaces volume
+lists outright:
+
 ```yaml
 services:
-  db:
-    ports:
-      - 127.0.0.1:15432:5432/tcp
-
   app:
     volumes: !override
       - .:/var/www/html/books
       - ${BOOKS_DIR}:/books:ro
-
-  web-nginx:
-    volumes: !override
-      - .:/var/www/html/books:ro
 ```
 
+Note that `podman-compose` cannot parse that tag and loads
+`docker-compose.override.yml` automatically, so remove or rename the file if you
+use `podman-compose` without explicit `-f` arguments.
+
 License
 -------