mirror of
https://github.com/nickyeoman/docker-compose-cookbooks.git
synced 2026-09-04 10:56:23 +00:00
nick
a2351a266d
- Add lidarr_dev stack with compose.yaml, sample.env, and README - Rewrite prowlarr_dev to match template conventions (compose.yaml, defaults on all vars, proxy network, README sections) - Set default VOL_PATH to /data (absolute, never ./data) - Reorder README sections: Overview → Project Details → Getting Started → Env Vars → Volume Notes → Network Notes → Docker Run - Update template-readme.md and AGENTS.md with new conventions
70 lines
1.6 KiB
Markdown
70 lines
1.6 KiB
Markdown
# 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`
|
||
|
||
## Getting Started
|
||
|
||
1. Start the container: `docker compose up -d`
|
||
2. Open http://localhost:[PORT] in your browser
|
||
3. Follow the initial setup wizard to configure the application
|
||
|
||
## 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
|
||
|
||
## Docker Run
|
||
|
||
```bash
|
||
docker run -d \
|
||
--name=[SERVICE_NAME] \
|
||
# ...env vars, ports, volumes...
|
||
[IMAGE_NAME]
|
||
```
|
||
|
||
## 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
|