summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorTyler Hoang <tyler@tylerhoang.xyz>2026-07-09 21:49:56 -0700
committerTyler Hoang <tyler@tylerhoang.xyz>2026-07-09 21:49:56 -0700
commit1d043702ef136e8f2e516c5304a57be5718f1f6f (patch)
tree9b3ad070f11dad5994c58acd41a15db8043745aa /README.md
Initial commit: docker compose files for all self-hosted servicesHEADmaster
12 services: adguard, ampache, azuracast, flood, glance, glances, grafana, immich, invidious, jellyfin, openwebui, watchtower Each service includes a docker-compose.yml, README.md with setup instructions, and .env.example where applicable.
Diffstat (limited to 'README.md')
-rw-r--r--README.md43
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.