mirror of
https://github.com/nickyeoman/docker-compose-cookbooks.git
synced 2026-09-03 18:36:22 +00:00
Updated Heimdall
This commit is contained in:
@@ -0,0 +1,38 @@
|
||||
# Docker Compose Template
|
||||
|
||||
Adopting an order/template to the docker compose files as follows:
|
||||
|
||||
```
|
||||
# [App Name] Docker Compose Template (e.g., CORXN)
|
||||
|
||||
services:
|
||||
[service-name]:
|
||||
image: ${APPNAME_IMAGE_NAME:-user/name:latest}
|
||||
restart: ${APPNAME_RESTART:-unless-stopped}
|
||||
volumes: # Templated with VOL_PATH, CONFIG_PATH or LOG_PATH
|
||||
- ${VOL_PATH:-./data}/appname/dir:/data
|
||||
- ${CONFIG_PATH:-./config}/appname/dir:/config
|
||||
- ${LOG_PATH:-./logs}/appname/dir:/var/logs
|
||||
- /etc/localtime:/etc/localtime:ro
|
||||
environment: # Grouped: Universal first, app-specific after
|
||||
- TZ=${TZ:-UTC}
|
||||
- [APP_VAR1]=${[APP_VAR1]:-default}
|
||||
- [APP_VAR2]=${[APP_VAR2]:-default}
|
||||
ports: # Can remove this for proxy
|
||||
- "${APP_PORT:-9999}:9999"
|
||||
networks:
|
||||
- proxy
|
||||
- internal
|
||||
network_mode: "host"
|
||||
depends_on:
|
||||
- [db-service] # e.g., mariadb
|
||||
healthcheck: # Optional: App-specific
|
||||
test: ["CMD", "curl", "-f", "http://localhost:[port]"]
|
||||
interval: 30s
|
||||
timeout: 10s
|
||||
retries: 3
|
||||
labels: # Optional
|
||||
- "traefik.enable=false"
|
||||
command: # Override entrypoint if needed
|
||||
user: "1000:1000" # Non-root
|
||||
```
|
||||
@@ -0,0 +1,39 @@
|
||||
# Project Name
|
||||
|
||||
## Overview
|
||||
|
||||
A short 1--3 sentence description of what this Docker Compose project
|
||||
does.
|
||||
|
||||
## Project Details
|
||||
|
||||
- **Project Repository:** [Link](https://example.com)
|
||||
- **Container Image:** [Docker Hub](https://dockerhub.com)
|
||||
- **Compose Example:** [Compose](https://dockerhub.com)
|
||||
- **Documentation:** [Docs](https://dockerhub.com)
|
||||
- **Reverse Proxy Port:** `80`
|
||||
|
||||
## Environment Variable Notes
|
||||
|
||||
List any required or optional environment variables, where they come
|
||||
from, and how they are used.
|
||||
|
||||
Example:
|
||||
|
||||
VAR_NAME – explanation of purpose
|
||||
ANOTHER_VAR – where to get the value
|
||||
|
||||
## Volume Notes
|
||||
|
||||
Describe important volumes, what they store, and whether they need
|
||||
manual creation or backups.
|
||||
|
||||
Example:
|
||||
|
||||
/data – persistent application storage
|
||||
/config – configuration files
|
||||
|
||||
## Additional Notes / Gotchas
|
||||
|
||||
Add any special information someone should know before running the
|
||||
project---quirks, caveats, network requirements, etc.
|
||||
Reference in New Issue
Block a user