Files
docker-compose-cookbooks/_docs/template-readme.md
T
2026-03-17 23:12:57 -07:00

1.3 KiB
Raw Blame History

Project Name

Overview

A short 1--3 sentence description of what this Docker Compose project does.

Project Details

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

Network Notes

Requires proxy network

Additional Notes / Gotchas

Add any special information someone should know before running the project---quirks, caveats, network requirements, etc.

Dockhand Stack, Deploy from Git

Cookbooks Repository stackname: NAME_HERE Compose file path: SERVICENAME/compose.yaml Additional env file (optional): SERVICENAME/sample.env

Then "Load" SERVICENAME/sample.env into the Environmental variables in dockhand

Create the Stack