Files
docker-compose-cookbooks/AGENTS.md
T

1.3 KiB

AGENTS.md

Stack conventions

  • Every stack has at least 3 files: compose.yaml (dockhand style), sample.env, README.md
  • _dev = experimental, _notes = docs/minimal examples, no suffix = production-ready
  • Always references an external proxy network (docker network create proxy once)
  • Volumes use ${VOL_PATH:-/data} as the base path
  • Timezone defaults to America/Vancouver, but only include if the container requires it.
  • Restart policy, image tag, and port are configurable via env vars with sensible defaults
  • New stacks: copy from _docs/template-compose.md and _docs/template-readme.md
  • Compose section order: imagerestartvolumesenvironmentportsnetworksdepends_onhealthchecklabelscommanduser
  • README section order: OverviewGetting StartedDocker RunProject DetailsEnvironment Variable NotesVolume NotesNetwork NotesAdditional Notes / GotchasDockhand Stack, Deploy from Git
  • Every compose file must declare the external proxy network at the root level:

networks: proxy: external: true


## No CI/CD, no dependency management

This is a Docker Compose file collection, not a code project. No tests, no build tools, no lockfiles.