/ readme.md
readme.md
1 2 # Home Media Docker Compose 3 4 This repository contains a Docker Compose configuration and supporting folders for running a personal home media stack (Plex, qBittorrent, Sonarr, Radarr, Jackett, Bazarr, Gluetun VPN, and helpers). 5 6 **Overview** 7 - **Purpose:** Lightweight, containerized media/server environment for a home server or NAS. 8 - **Compose file:** [docker-compose.yml](docker-compose.yml) 9 10 **Prerequisites** 11 - Docker and Docker Compose installed on the host. 12 - Appropriate user/group IDs available in environment variables (`PUID`, `PGID`). 13 - A `.env` file or exported environment variables for `TIMEZONE`, `WEBPASSWORD`, VPN keys, and other settings referenced by `docker-compose.yml`. 14 15 **Quick start** 16 - Copy or create an `.env` file with required variables (see `docker-compose.yml` for references). 17 - Start the stack: 18 19 ```bash 20 docker compose up -d 21 ``` 22 23 Stop the stack: 24 25 ```bash 26 docker compose down 27 ``` 28 29 **Services included (high level)** 30 - `pihole` - network-wide adblocker (runs using `network_mode: host`). 31 - `Plex` - media server with hardware acceleration options and transcode tmpfs. 32 - `Flaresolverr` - provides the ability to solve anti-bot challenges for indexers. 33 - `Gluetun` - VPN container (WireGuard) which other services can route through. 34 - `Qbittorrent` - torrent client (optionally routed through Gluetun via `network_mode: service:Gluetun`). 35 - `Sonarr` / `Radarr` - automation for TV and movies. 36 - `Bazarr` - subtitle management. 37 - `Jackett` - indexer bridging for Sonarr/Radarr. 38 39 40 41 42