Skip to content
Docker media and home server stack with Docker Compose, Traefik v1.7.16, Google OAuth2, and LetsEncrypt
Branch: master
Clone or download
Latest commit f5d58df Nov 22, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
picard updates Nov 13, 2019
shared some updates Nov 7, 2019
traefik added more files Nov 7, 2019
.env.example updates Nov 8, 2019
.gitignore updates Nov 22, 2019
CHANGELOG.md updates Nov 22, 2019
LICENSE Initial commit Nov 7, 2019
README.md updates Nov 22, 2019
docker-compose-obsolete.yml updates Nov 22, 2019
docker-compose-vpn.yml updates Nov 22, 2019
docker-compose.yml updates Nov 22, 2019

README.md

Description

This is the updated docker-compose repo of all the media and home server apps described in the following guides on our website:

But what about Traefik 2.0?

At this point this stack is built on Traefik 1.0. As we move ours to Traefik 2.0, we will publish a new repository.

Having said that, Traefik 1.7.16 (the final release in v1) still works great for the purposes of a media / home server stack. Traefik 2.0 is significantly different requiring a major rework of your files. Therefore, if you are already on Traefik v1, we do not see a need to upgrade to v2 at this point.

If you are starting out, you may start with Traefik 2.0. However, documentation, community knowledge, and support for Traefik 2.0 is still quite limited at this time.

What apps are included in this stack?

We will try to keep this repo up-to-date. For now, here are the apps currently included in our stack:

FRONTENDS

  • Traefik - Reverse Proxy
  • OAuth - Forward Authentication
  • Portainer - Container Management
  • Organizr - Unified Frontend
  • Heimdall - Unified Frontend Alternative
  • Autoindex - Plain text Index to All Files

SMART HOME

  • HA-Dockermon - Manage Docker containers in Home Assistant
  • Mosquitto - MQTT Broker
  • ZoneMinder - Video Surveillance

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

DOWNLOADERS

  • jDownloader - Download management
  • SABnzbd - Binary newsgrabber (NZB downloader)
  • qBittorrent - Torrent downloader
  • TransmissionBT - Torrent Downloader

INDEXERS

  • Jackett - Torrent proxy
  • NZBHydra2 - NZB meta search

PVRS

  • Lidarr - Music Management
  • Radarr - Movie management
  • Sonarr - TV Shows management

MEDIA SERVER

  • Plex - Media Server
  • Jellyfin - Media Server
  • Emby - Media Server (OBSOLETE)
  • Tautulli - Previously PlexPy. Plex statistics and monitoring
  • Plex-Sync - For Syncing watched status between plex servers
  • Telly Tv- IPTV proxy for Plex

MEDIA FILE MANAGEMENT

  • 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

SYSTEM

  • Firefox - Web Broswer
  • Glances - System Information
  • Logarr - Log Management
  • Monitorr - Webfront to display the status of any webapp or service
  • APCUPSD - APC UPS Management
  • qDirStat - Directory Statistics
  • Guacamole - Remote desktop, SSH, on Telnet on any HTML5 Browser
  • Guacamole Daemon - Needed for Guacamole
  • StatPing - Status Page & Monitoring Server

MAINTENANCE

  • Ouroboros - Automatic Docker Container Updates
  • Docker-GC - Automatic Docker Garbage Collection

IPVanish VPN

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.

MariaDB

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.

Usage

First, install Docker and Docker Compose, as described in our Docker Media Server guide.

  1. Clone the repo.
  2. Configure traefik.toml
  • Rename traefik\traefik.toml.example to traefik\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.
  1. (Optional) Enable or use HTTP Basic Authentication by renaming shared\.htpasswd.example to shared\.htpasswd in the folder and adding username and hashed password to it.
  2. Configure environmental variables (.env file)
  • Rename the included .env.example to .env.
  • Edit variables in .env file.
  • All variables (ie. ${XXX}) in docker-compose.yml come from .env file stored in the same place as docker-compose.yml.
  • Ensure good permissions for the .env file (recommended: 640).
  1. Edit docker-compose.yml to 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.
  2. Start and stop your docker stack as described in our Docker Media Server guide.
  3. (Optional) Put non-docker apps behind Traefik proxy by renaming traefik\rules\app.toml.example to traefik\rules\app.toml and editing its contents.
You can’t perform that action at this time.