mirror of
https://github.com/nickyeoman/docker-compose-cookbooks.git
synced 2026-09-04 02:46:23 +00:00
Updated Heimdall
This commit is contained in:
@@ -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