allucanget/calminer
2
0
Fork 0
Code Pull Requests Actions Packages Releases Activity

docs: Add summary for Postgres container setup in quickstart guide

Browse Source
This commit is contained in:
zwitschi
2025-10-25 17:05:49 +02:00
parent 4e1658a638
commit f3ce095b71
1 changed files with 7 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
docs/quickstart.md
View File

@@ -128,6 +128,13 @@ For local validation without installing Postgres directly, use the provided comp
docker compose -f docker-compose.postgres.yml up -d
```
#### Summary
1. Start the Postgres container with `docker compose -f docker-compose.postgres.yml up -d`.
2. Export the granular database environment variables (host `127.0.0.1`, port `5433`, database `calminer_local`, user/password `calminer`/`secret`).
3. Run the setup script twice: first with `--dry-run` to preview actions, then without it to apply changes.
4. When finished, stop and optionally remove the container/volume using `docker compose -f docker-compose.postgres.yml down`.
The service exposes Postgres 16 on `localhost:5433` with database `calminer_local` and role `calminer`/`secret`. When the container is running, set the granular environment variables before invoking the setup script:
```powershell