diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 43 |
1 files changed, 43 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..828af0f --- /dev/null +++ b/README.md @@ -0,0 +1,43 @@ +# Docker Stack + +Docker Compose files for my self-hosted services. + +## Services + +| Service | Description | Directory | +|---------|------------|-----------| +| AdGuard Home | DNS ad-blocker | [`adguard/`](adguard/) | +| Ampache | Music streaming server | [`ampache/`](ampache/) | +| AzuraCast | Web radio management | [`azuracast/`](azuracast/) | +| Flood | Web UI for rTorrent | [`flood/`](flood/) | +| Glance | Personal dashboard | [`glance/`](glance/) | +| Glances | System monitoring | [`glances/`](glances/) | +| Grafana + Prometheus | Metrics & monitoring | [`grafana/`](grafana/) | +| Immich | Photo/video management | [`immich/`](immich/) | +| Invidious | YouTube frontend | [`invidious/`](invidious/) | +| Jellyfin + *arr Stack | Media server suite | [`jellyfin/`](jellyfin/) | +| Open WebUI | LLM chat interface | [`openwebui/`](openwebui/) | +| Watchtower | Automatic container updates | [`watchtower/`](watchtower/) | + +## Usage + +Each service directory contains: +- `docker-compose.yml` — The compose file +- `README.md` — Setup instructions and configuration guide +- `.env.example` — Template for required environment variables (where applicable) + +To deploy a service, cd into its directory and follow its README. + +### Quick Start (any service) + +```bash +cd <service> +cp .env.example .env # if present — edit with your settings +docker compose up -d +``` + +## Notes + +- All `.env` files are git-ignored. Each service provides a `.env.example` as a template. +- Secrets and API keys in the compose files reference environment variables — provide them via `.env` files. +- Volume paths and timezone settings are configured for my environment. Adjust them in the compose files or `.env` for your setup. |