Skip to content

Document docker-compose.override.yml and add examples for overriding the stack #618

Closed

Description

@rolfschmidt

Infos

  • Docker version: any
  • Docker-compose version: Compose v2 (include: needs 2.20+)
  • Operating system (Docker host): any

Expected behavior

The README explains how to adjust the stack without editing docker-compose.yml, so that git pull never conflicts with local changes. In particular it should document:

  • docker-compose.override.yml, which Compose picks up automatically next to docker-compose.yml, as the recommended place for local adjustments.

  • Pulling in one or more scenarios/*.yml files from the override file via include: instead of long -f ... -f ... command lines, e.g.:

    include:
      - scenarios/add-nginx-proxy-manager.yml
      - scenarios/apply-resource-limits.yml
  • Examples for the most common local adjustments, either as scenarios or as snippets in the README:

    • PostgreSQL tuning (shared_buffers, work_mem, max_connections, ...) via command: postgres -c key=value plus shm_size, instead of editing postgresql.conf inside the volume
    • Elasticsearch heap (ELASTICSEARCH_JAVA_OPTS) and other environment overrides
    • Changing published ports and adding ports: !reset []
    • Adding volumes for custom certificates or additional files

Actual behavior

  • The README only mentions scenarios in passing (Elasticsearch section) and does not explain docker-compose.override.yml or include: at all.
  • Users tend to edit docker-compose.yml directly or run sed inside the containers, which breaks on the next git pull or image update.
  • Tuning examples like PostgreSQL settings are not covered anywhere, although they are one of the first things needed on larger installations.

Steps to reproduce the behavior

  • Read the README as a new user and try to find out how to tune PostgreSQL or add a scenario permanently without touching docker-compose.yml.

Activity

  1. YetAnotherGerrit commented on Sep 14, 2026

    @YetAnotherGerrit

    Maybe it makes sense to add a markdown file for Coding Agents to assist in adjusting the configuration?

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

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions