This is the updated docker-compose repo of all the media and home server apps described in the following guides on our website:
- Docker Media Server with Traefik 2 Reverse Proxy: https://www.smarthomebeginner.com/traefik-2-docker-tutorial/
Old Posts: The following 3 posts have been combined and updated for Traefik v2 (linked above):
- Docker Media Server without Reverse Proxy (- https://www.smarthomebeginner.com/docker-home-media-server-2018-basic/
- Docker Media Server with Traefik 1 Reverse Proxy - https://www.smarthomebeginner.com/traefik-reverse-proxy-tutorial-for-docker/
- Docker with Google OAuth 2 - https://www.smarthomebeginner.com/google-oauth-with-traefik-docker/
Update (April 19, 2020): We have switched from Traefik v1 to Traefik v2, which is now our default. Therefore, the setup for Traefik v1 will only receive minor security related updates (if any). If you are new, follow instructions for Traefik v2.
- docker-compose-t2.yml
- docker-compose-t2-vpn.yml
- docker-compose-t2-obsolete.yml (Apps that we do not use anymore)
- docker-compose-t1.yml
- docker-compose-t1-vpn.yml
- docker-compose-t1-obsolete.yml (Apps that we do not use anymore)
- docker-compose-t1-swarm.yml
We will try to keep this repo up-to-date. For now, here are the apps currently included in our stack:
- Traefik - Reverse Proxy
- OAuth - Forward Authentication
- Portainer - Container Management
- Organizr - Unified Frontend
- Heimdall - Unified Frontend Alternative
- Autoindex - Plain text Index to All Files
- HA-Dockermon - Manage Docker containers in Home Assistant
- Mosquitto - MQTT Broker
- ZoneMinder - Video Surveillance
- MiFlora - MiFlora MQTT Daemon (MiFlora Plant Sensors) (OBSOLETE)
- MariaDB - MySQL Database
- phpMyAdmin - Database management
- InfluxDB - Database for sensor data
- Postgres - Database
- Grafana - Graphical data visualization for InfluxDB data
- Varken - Monitor Plex, Sonarr, Radarr, and Other Data (OBSOLETE)
- jDownloader - Download management
- TransmissionBT with VPN - Torrent Downloader
- SABnzbd - Binary newsgrabber (NZB downloader)
- qBittorrent with VPN - Torrent downloader
- NZBHydra2 - NZB meta search
- Jackett - Torrent proxy
- Lidarr - Music Management
- Radarr - Movie management
- Sonarr - TV Shows management
- AirSonic - Music Server
- Plex - Media Server
- Emby - Media Server
- Jellyfin - Media Server
- Ombi - Media Requests
- Tautulli - Previously PlexPy. Plex statistics and monitoring
- Plex-Sync - For Syncing watched status between plex servers
- PhotoShow - Personal Photo Gallery and viewer
- TellyTv- IPTV proxy for Plex (OBSOLETE)
- xTeve- IPTV proxy for Plex (OBSOLETE)
- Bazarr - Subtitle Management
- Picard - Music Library Tagging and Management
- Handbrake - Video Conversion (Transcoding and compression)
- MKVToolNix - Video Editing (Remuxing - changing media container while keeping original source quality)
- MakeMKV - Video Editing (Ripping from Disks)
- FileBot - File renamer
- Firefox - Web Broswer
- Glances - System Information
- APCUPSD - APC UPS Management
- Logarr - Log Management (OBSOLETE)
- Monitorr - Webfront to display the status of any webapp or service (OBSOLETE)
- Guacamole - Remote desktop, SSH, on Telnet on any HTML5 Browser
- Guacamole Daemon - Needed for Guacamole
- Dozzle - Docker logs viewer
- qDirStat - Directory Statistics
- VS Code Server - Code Editor
- StatPing - Status Page & Monitoring Server
- SmokePing - Network Latency Monitoring
- Ouroboros - Automatic Docker Container Updates
- Docker-GC - Automatic Docker Garbage Collection
Some of the containers are behind VPN for privacy and security. We have been using IPVanish for a while now. The following apps are behind IPVanish VPN:
- Jackett
- qBittorrent
- Transmission BT
- jDownloader
Based on the docker-compose blocks for the above apps, you can almost any of the apps behind VPN.
Some of the containers in docker-compose.yml (eg. ZoneMinder, Guacamole, phpMyAdmin, etc.) need MariaDB. At this point, an external MariaDB host is specified, with the assumption that you have MariaDB running elsewhere (eg. on your NAS).
At some point, we will add a MariaDB container and use that as the database host.
First, install Docker and Docker Compose, as described in our Docker Media Server guide.
- Clone the repo.
- Configure
traefik.toml
- Rename
traefik\traefik.toml.exampletotraefik\traefik.toml - Edit it to reflect your situation
- Edit domain name.
- DNS Challenge (for LetsEncrypt verification) is enabled by default for cloudflare. Use the Traefik Reverse Proxy guide for help with this.
- For other providers other than cloudflare, check here.
- (Optional) Enable or use HTTP Basic Authentication by renaming
shared\.htpasswd.exampletoshared\.htpasswdin the folder and adding username and hashed password to it. - Configure environmental variables (
.envfile)
- Rename the included
.env.exampleto.env. - Edit variables in
.envfile. - All variables (ie.
${XXX}) in docker-compose.yml come from.envfile stored in the same place as docker-compose.yml. - Ensure good permissions for the
.envfile (recommended: 640).
- Edit
docker-compose.ymlto include only the services you want or add additional services to it. Be sure to read the comments for each app and create any required files. - Start and stop your docker stack as described in our Docker Media Server guide.
- (Optional) Put non-docker apps behind Traefik proxy by renaming
traefik\rules\app.toml.exampletotraefik\rules\app.tomland editing its contents.
I use bash_aliases to simplify starting and stopping containers/stack. Included in the repo is an example of bash_aliases I use (replace USER with your Linux username). Here are some example alias commands:
- dc1up or dc2up - Create network and start Docker Traefik 1 or 2 stack
- dc1down or dc2down - Stop Docker Traefik 1 or 2 stack
- dcup1 or dcup2 - Start Docker Traefik 1 or 2 stack
- dcup1v or dcup2v - Start Docker Trafik 1 or 2 VPN stack
- dcdown1 or dcdown2 - Stop Docker Traefik 1 or 2 stack
- dcdown1v or dcdown2v - Stop Docker Traefik 1 or 2 VPN stack
- dcrec1 or dcrec2 - Start or recreate a specific service
- dcstop1 or dcstop2 - Stop a specific service
- dcrestart1 or dcrestart2 - Restart a specific service
- dclogs1 or dclogs1v or dclogs2 or dclogs2v - See real-time logs for the corresponding stack or service
- dcpull1 or dcpull1v or dcpull2 or dcpull2v - Pull new images for the corresponding stack or service