Skip to content

📚docs: write docs/infra/docker.md #381

Description

@sotoJ24

Title: docs: write docs/infra/docker.md — Docker Compose services, PostGIS requirement, port mapping, and common docker commands

Issue Summary

Documents the Docker Compose configuration in infra/backend/docker-compose.yml: the two services (postgres with PostGIS, Hasura), why PostGIS is required (GEOMETRY columns in apartments and hotels), port mapping (5433→5432, 8080→8080), the Docker network, volume persistence, and a reference of common Docker commands every contributor needs. Without this document contributors don't understand why docker compose down -v destroys all data and why the port is 5433 not 5432.

Type of Issue

  • Documentation

Branch strategy

✅ docs/issue-N-docker → consolidation-pattern

Expected Behavior

Contributor must read:

cat infra/backend/docker-compose.yml
cat infra/backend/migrations/safetrust/1732588166945_create_apartments/up.sql | head -10
# observe: GEOMETRY(POLYGON, 4326) — requires PostGIS

docs/infra/docker.md covering:

1. Two services — postgres (postgis image) and graphql-engine, with key config

2. Why PostGIS — apartments GEOMETRY(POLYGON, 4326), hotels GEOGRAPHY(POINT, 4326)

3. Port table — host 5433 → container 5432, host 8080 → container 8080

4. Common commands table — up, down, down -v, logs, exec, ps

5. Internal vs externallocalhost:5433 from host, postgres:5432 from inside Docker

6. Admin secret — dev value, change before production

Files to create

File Approx lines
docs/infra/docker.md ~100

Make sure to follow the Git Guidelines for Atomic Commits and read Contributing Guide


Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Stellar WaveIssues in the Stellar wave program

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions