mirror of
https://github.com/nickyeoman/docker-compose-cookbooks.git
synced 2026-09-04 02:46:23 +00:00
1.3 KiB
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
proxynetwork (docker network create proxyonce) - 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.mdand_docs/template-readme.md - Compose section order:
image→restart→volumes→environment→ports→networks→depends_on→healthcheck→labels→command→user - README section order:
Overview→Getting Started→Docker Run→Project Details→Environment Variable Notes→Volume Notes→Network Notes→Additional Notes / Gotchas→Dockhand Stack, Deploy from Git - Every compose file must declare the external
proxynetwork 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.