Awesome Open Source
Awesome Open Source

HTPC Docker Standup

PSA: Project has moved to GitLab. This repo will remain on Github as a mirror.


This is a simple docker-compose configuration to standup a new HTPC. It's based on running on an Ubuntu server, but could easily be adapted for other opertaing systems with Docker support.

It includes the following Services

  • Plex Media Server - for managing media and serving files to Plex Clients
  • Deluge + Private Internet Access or TorGuard - for downloading torrents... "safely"
  • Sonarr - for TV Series Management
  • Radarr - for Movie Management
  • Jackett - for Torrent Tracker feeds
  • Tautulli - for Plex library statistics and usage
  • Ombi - for requesting additional library content
  • Portainer - for managing all of your Docker containers
  • Watchtower - for automatically updating running containers
  • NetData - for system resource monitoring
  • Muximux - for simple web based management
  • Duplicati - for backing up data to your favorite provider
  • InfluxDB - for time series based database storage
  • Chronograf - for making pretty dashboards out of the database data
  • SpeedTest - for performing a speedtest and posting data to the database
  • Varken - for aggregating data from the Plex ecosystem into InfluxDB using Grafana for a frontend
  • Grafana - for making dashboards out of the Varken Data
  • Traefik - Reverse Proxy and SSL Support

This project was heavily inspired by the MediaBox project... Many Thanks!

Known Issues

  • [ ] Sometimes the Deluge + VPN Container disconnects and can't re-establish a forwarded port connection.

Install Instructions

Prerequisites

Server Configuration

  1. Install Ubuntu Server and get it updated - sudo apt update then sudo apt upgrade
  2. If you have existing media on a separate NTFS formatted drive:
  • Mount NTFS Drive w/ Appropriate Permissions, Link 1
  • sudo blkid - Find the block ID of your media drive
  • sudo mkdir /media/Media - make the mount point
  • Add to /etc/fstab: UUID=BC6617A366175D88 /media/Media ntfs-3g uid=1000,gid=1000,dmask=022,fmask=133 0 0
  1. Setup Samba Share (to access media outside of HTPC)
  2. Install Docker
  1. Install Docker Compose
  2. Clone Repo git clone https://gitlab.com/phikai/htpc-docker-standup.git
  3. Copy Sample Environement File cp sample.env .env
  4. Edit .env to match your environment
  5. Run Docker Environment docker-compose up -d
  6. ???
  7. Profit.

Environment File

  • LOCALUSER= - This is the local user of your linux account and account running docker
  • HOSTNAME= - Hostame of the server, can be found by executing hostname from command line
  • IP_ADDRESS= - Local IP Address of the server, should be static
  • PUID= - UID of the local user, can be found by executing id from the command line
  • PGID= - GID of the local user, can be found by executing id from the command line
  • PMSTOKEN= - The claim token for the server to obtain a real server token. If not provided, server is will not be automatically logged in. If server is already logged in, this parameter is ignored. You can obtain a claim token to login your server to your plex account by visiting https://www.plex.tv/claim
  • VPNUNAME= - Your VPN username from PIA or TorGuard
  • VPNPASS= - Your VPN password from PIA or TorGuard
  • VPNPROVIDER= - Your VPN provider, name must match a folder specified in ovpn. This defaults to pia if you copied sample.env.
  • VPN_REMOTE= - The remote server you want to connect to (must support port forwarding)
  • CIDR_ADDRESS= - IP/netmask entries which allow access to the server without requiring authorization. We recommend you set this only if you do not sign in your server. For example 192.168.1.0/24,172.16.0.0/16 will allow access to the entire 192.168.1.x range and the 172.16.x.x
  • TZ= - Set the timezone inside the container. For example: Europe/London. The complete list can be found here: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
  • PMSTAG= - Which version of Plex Media Server, available options: latest, plexpass and public. You should use latest unless you have special requirements or are a Plex Pass subscriber.
  • EMAIL= - Email address to be used for Let's Encrypt SSL certificate validation - [email protected]
  • DOMAIN= - Public domain to use for accessing services via a public domain - server.domain.com
  • WATCHTOWER_EMAIL= - Email address you'd like Watchtower to notify for any notifications - [email protected]
  • SMTP_FROM= - From address that your SMTP server uses to send email - [email protected]
  • SMTP_SERVER= - Servername of your SMTP server - smtp.domain.com
  • SMTP_PORT= - Port that your SMTP server uses to connect - 587
  • SMTP_USER= - Username that your SMTP server uses to authenticate
  • SMTP_PASS= - Password for your SMTP user to authenticate
  • SPEEDTEST_INTERVAL= - Number of seconds between tests to the Speedtest.net services
  • TRAEFIK_AUTH= - Basic Auth for the Traefik Admin htpasswd Generator
  • STACK_NAME= - This is used to specify the appropriate network Traefik should use. See #13 for details.

Email/SMTP Service


Tips and Tricks

Potential Script to setup, renew and copy SSL for Plex


If this project has helped you in anyway, and you'd like to say thanks...

Donate Donate with Bitcoin

You can also gift a Plex Pass subscription as a great way to show your appreciation.

AFFILIATE DISCLOSURE: You can also support this project by purchasing a VPN Subscription via one of the links in this README.


Disclaimer

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.


Get A Weekly Email With Trending Projects For These Topics
No Spam. Unsubscribe easily at any time.
shell (10,301
docker (2,873
vpn (253
torrent (149
letsencrypt (140
plex (79
radarr (34
sonarr (33
nginx-proxy (24
portainer (22
htpc (18
deluge (16