docker-compose-media-center

This respository contains the Docker compose files for standing up an entire Servarr stack along with a other supporting tools and services best suited for an at-home NAS or media center

Table of contents:

docker-compose-media-center

Useful Resources To Have On-hand

Here are some useful resources to keep on hand as you go through the instuctions below for setting up the services contained in the Docker compose files in this repository:

Servarr Wiki: Best place to start to get to understand some of the services that are setup in the set of Docker compose files in this repository, what they are, and how to set them up and troubleshoot them.
LinuxServer.io: The How To section here is full of a lot of quick introductory material for not only Docker, Docker Compose, and other good material on what forms the foundation of many of the concepts you will need to understand utilizing the Docker compose files in this repository as well as following along with the instuctions below. Not only that but LinuxServer.io has built and maintains many of the Docker images and formed, to a large extent, the formatting and structure of the Docker compose files in this repository.
TRaSH Guides: Collected here are a great set of documents that somewhat explain the services but is more of an excellent source for general best practices as well as offering tips and providing help for some edge cases you may encounter.

Docker Compose Files and the Applications and Services Within

Below are a list of all of the Docker compose files that setup a Servarr stack, some associated assisting tools, media players, and also miscellaneous self-hosted tools you can skip and and/or remove from as well as mostly links to their associated Docker image sources, GitHub repositories, or

`docker-compose-portainer.yaml`

Portainer Portainer for managing the remaining "Stacks" (docker-compose files).

`docker-compose-tools.yaml`

SearXNG: Utility for an internet metasearch engine that aggregates search results.
Syncthing: Utility for syncing files across machines.
Tailscale: Private VPN to chain together your home network and other networks and machines for sharing services and files.
Watchtower: Watchtower for watching updates to docker images and pulling them down.

`docker-compose-crypto.yaml`

NOTE: I do not set this up in later steps below as I highly doubut you will want to peg your CPU and run this utility alongside what this guide was meant to assit in setting up. You will likely find it completely unnessesary but feel free to contact me if you would like more information.

rana: A tool for finding vanity public keys used with nostr.
vanity-age: A rewrite in a fork I did of vanity-age for finding vanity public age keys.

`docker-compose-downloaders.yaml`

NOTE:: For posterity's sake I left in SABnzbdVPN and Transmission-OpenVPN but they are commented out in the docker-compose-downloaders.yaml file. I found using glueun mentioned above to be a better utility to operate as a VPN killswitch universally I could plug any container I wanted to up to it.

Deluge: Deluge for torrent downloads.
Gluetun: Utility for a base VPN killswitch container that the downloading containers filter through when downloading.
NZBGet: NZBGet for Usenet downloads.
SABnzbd SABnzbd for Usenet downloads.
~~SABnnzdVPN SABnzbd with OpenVPN for torrent downloads which includes a VPN killswitch to stop downloading on loss of a VPN connection.~~
Tranismission Transmission for torrent downloads.
~~Transmission-OpenVPN: Transmission with OpenVPN for torrent downloads which includes a VPN killswitch to stop downloading on loss of a VPN connection.~~
Unpackerr: Unpackerr for any unpacking in post-processing after download.

`docker-compose-stararr.yaml`

Bazarr: Bazarr for adding Subtitles to media found in Radarr and Sonarr.
Mylar3: Mylar3 for Comic Books.
Lidarr: Lidarr for Music.
Prowlarr: Prowlarr for adding Indexers to Stararr services.
Radarr: Radarr for Movies.
Readarr: Readarr for eBooks and Audiobooks.
Sonarr: Sonarr for TV series and shows.

`docker-compose-plex.yaml`

Jellyfin: Jellyfin media center for viewing and playing all of your media.
Jellyseerr: Jellyseerr (Overseerr fork) for browsing and discovering of new media.
Notifiarr: Notifiarr for Discord and Webhooks.
Plex: Plex media center for viewing and playing all of your media.
Tautulli: Tautulli for Plex statistics and monitoring.
Overseerr: Overseer for browsing and discovering of new media.

`docker-compose-plexmetamanager.yaml`

Plex Meta Manager: A fairly complex piece of software to render badges, evaluate audience/user/critic ratings, creat/manage collections, and a whole host of many other things. The best way to get started is probably seeing some explanations and visuals on the Plex Meta Manager main GitHub page as well as on the Plex Meta Manager wiki page.

Installation and Setup

Install Docker

Create a media network with:

docker network create \
  --driver=bridge \
  --gateway=172.16.0.1 \
  --ip-range=172.16.0.0/24 \
  --subnet=172.16.0.0/16 \
  -o "com.docker.network.bridge.enable_icc"="true" \
  -o "com.docker.network.bridge.enable_ip_masquerade"="true" \
  -o "com.docker.network.bridge.host_binding_ipv4"="0.0.0.0" \
  -o "com.docker.network.bridge.name"="media" \
  -o "com.docker.network.driver.mtu"="1500" \
  media

Edit and move the file environment_variables.env.example saving it to the file to .env substituting with values you have after starting and setting up many of the services and applications. IMPORTANT NOTE: Complete these sections as each must be completed as outlined before moving to the next step:
- Directory Structure
- Environment Variables
Run these docker compose commands in order (Note: there are few depends_on throughout though internally the docker-compose-downloaders.yaml file has containers which are dependent on another - i.e. sabnzbd and deluge use the gluetun network service to utilize it's utility as a VPN killswitch):
- First things first so we get the Portainer instance going:
  - docker compose --file docker-compose-portainer.yaml --env-file .env up --detach
- And now for the rest:
  - docker compose --file docker-compose-tools.yaml --env-file .env up --detach
  - docker compose --file docker-compose-downloaders.yaml --env-file .env up --detach
  - docker compose --file docker-compose-stararr.yaml --env-file .env up --detach
  - docker compose --file docker-compose-plex.yaml --env-file .env up --detach
- Lastly if you'd like to setup PlexMetaManager you'll want to add a cron entry you run periodically (around every 24-96 hours) with the following command:
  - docker-compose --file docker-compose-plexmetamanager.yaml --env-file .env up plexmetamanager --detach

Directory Structure

In order to start you need to create several directories to house the configurations for each service and where the Docker container will persist configurations locally between reboots, restarts, etc. This maps directly to the CONFIG_BASE_DIR directory in the .env file that we will get to later.

export CONFIG_BASE_DIR=/volume1/services # substitute for your path/preferences
mkdir -p ${CONFIG_BASE_DIR}

This sets the CONFIG_BASE_DIR directory that will store all of the subsequent directories for their Docker configurations. NOTE: I have marked items below I consider optional but note that the files included here will install them all unless you have commented them out as well. If you do not every directory below and it's subsequent service are later set up to be running and available to use. Whether you use them or not you may find you would like to try them later so my recommendation is to leave them as is and you can return later to remove them as you require. If you do skip some of the services marked optional in creating the directories below (highlighed by the # optional ... comments below then do your best to find the environment variables) and comment those out as well (to keep down the noise in your .env file. To create each of the directories run the following after the command above:

mkdir -p ${CONFIG_BASE_DIR}/bazarr
# mkdir -p ${CONFIG_BASE_DIR}/caddy
mkdir -p ${CONFIG_BASE_DIR}/deluge # optional Bittorrent client
# mkdir -p ${CONFIG_BASE_DIR}/delugevpn
mkdir -p ${CONFIG_BASE_DIR}/gluetun
mkdir -p ${CONFIG_BASE_DIR}/jellyfin # optional alternative to Plex
mkdir -p ${CONFIG_BASE_DIR}/jellyseerr # optional alternative to Overseer for Plex
mkdir -p ${CONFIG_BASE_DIR}/lidarr # optional if you are not interested in Music
mkdir -p ${CONFIG_BASE_DIR}/mylar3 # optional if you are not interested in Comics
mkdir -p ${CONFIG_BASE_DIR}/notifiarr # opptional tool to notify Discord various actions 
# mkdir -p ${CONFIG_BASE_DIR}/nzbget
mkdir -p ${CONFIG_BASE_DIR}/overseerr # optional tool for requesting media content and discover of new content
mkdir -p ${CONFIG_BASE_DIR}/plex
mkdir -p ${CONFIG_BASE_DIR}/plexmetamanager # optional for many customizations (complex) for Plex
mkdir -p ${CONFIG_BASE_DIR}/portainer
mkdir -p ${CONFIG_BASE_DIR}/prowlarr
mkdir -p ${CONFIG_BASE_DIR}/qbittorrent
mkdir -p ${CONFIG_BASE_DIR}/radarr
# mkdir -p ${CONFIG_BASE_DIR}/rana
mkdir -p ${CONFIG_BASE_DIR}/readarr # optional if you are not interested in Books/AudioBooks
mkdir -p ${CONFIG_BASE_DIR}/sabnzbd
# mkdir -p ${CONFIG_BASE_DIR}/sabnzbdvpn
mkdir -p ${CONFIG_BASE_DIR}/sonarr
mkdir -p ${CONFIG_BASE_DIR}/syncthing # optional file synchronization service
mkdir -p ${CONFIG_BASE_DIR}/tailscale # optional home network "VPN" service
mkdir -p ${CONFIG_BASE_DIR}/tautulli # optional analytics service for Plex
mkdir -p ${CONFIG_BASE_DIR}/transmission # optional Bittorrent client
# mkdir -p ${CONFIG_BASE_DIR}/transmission-openvpn
mkdir -p ${CONFIG_BASE_DIR}/unpackerr
mkdir -p ${CONFIG_BASE_DIR}/watchtower
# mkdir -p ${CONFIG_BASE_DIR}/vanity-age

Environment Variables

In environment_variables.env.example are the environment variables to use for the Docker Compose files. You will want to copy this to .env and modify the file according to the values for your setup. Here are all the environment variables and their purpose:

BOOKS_DIR_LOCAL: The directory to keep Book files that are organized locally on disk (i.e. /volume1/books)
BOOKS_DIR_RELATIVE: The directory to keep Book files that are organized relative to the container (i.e. not the actual location of the files on disk e.g. /books => ${BOOKS_DIR_LOCAL} e.g. /books => /volume1/books)
COMICS_DIR_LOCAL: The directory to keep Comic Book files that are organized locally on disk (i.e. /volume1/books)
COMICS_DIR_RELATIVE: The directory to keep Comic Book files that are organized relative to the container (i.e. not the actual location of the files on disk e.g. /books => ${BOOKS_DIR_LOCAL} e.g. /comics => /volume1/comics)
CONFIG_BASE_DIR: The base directory where each of the containers will have their configurations persistently stored between reboots, restarts, etc. (e.g. /volume1/docker... and will serve the container the directory (e.g. Deluge => /volume1/docker/deluge, Plex => /volume1/docker/plex, Tailscale => /volume1/docker/tailscale, etc.) => (e.g. Deluge => deluge, Plex => plex, Tailscale => tailscale, etc.)
CONFIG_DATA_DIR: The directory for each of the containers to store their data persistently stored between reboots, restarts, etc. (e.g. /volume1/Data... will serve the data directories for e.g. complete, incomplete, and watch for Deluge)
DATA_DIR_COMPLETE_LOCAL: The directory to keep completely downloaded files locally on disk (i.e. /volume1/data/complete)
DATA_DIR_COMPLETE_RELATIVE: The directory to keep completely downloaded files relative to the container (i.e. not the actual location of the files on disk e.g. /complete => ${DATA_DIR_COMPLETE_LOCAL} e.g. /complete => /volume1/data/complete)
DATA_DIR_INCOMPLETE_LOCAL: The directory to keep incompletely downloaded files locally on disk (i.e. /volume1/data/incomplete)
DATA_DIR_INCOMPLETE_RELATIVE: The directory to keep incompletely downloaded files relative to the container (i.e. not the actual location of the files on disk e.g. /incomplete => ${DATA_DIR_INCOMPLETE_LOCAL} e.g. /incomplete => /volume1/data/watch)
DATA_DIR_WATCH_LOCAL: The directory to keep files to be watched locally on disk (i.e. /volume1/data/watch)
DATA_DIR_WATCH_RELATIVE: The directory to keep files to be watched relative to the container (i.e. not the actual location of the files on disk e.g. /watch => ${DATA_DIR_WATCH_LOCAL} e.g. /watch => /volume1/data/watch)
GATEWAY_IP: Gateway IP for the Docker Compose subnet (e.g. 172.16.0.1)
HEALTH_CHECK_HOST: Hostname to use for VPN health checks (e.g.: google.com)
IP_RANGE: IP range for the Docker Compose subnet
KOMETA_PLEX_TOKEN: The Plex claim ID from above but without the claim- prefix
KOMETA_PLEX_URL: The internal Docker URL for the plex container for use by Kometa (previously: Plex Meta Manager) (e.g. (and probably should not change) http://plex:32400)
LAN_NETWORK: Private IP network the Docker Compose subnet is attached to on you private LAN (e.g. 192.168.0.0/24 => 192.168.0.1: router, 192.168.0.5: NAS machine, 192.168.0.88: Laptop, etc.)
MOVIES_DIR_LOCAL: The directory to keep Movie files that are organized locally on disk (i.e. /volume1/movies)
MOVIES_DIR_RELATIVE: The directory to keep Movie files that are organized relative to the container (i.e. not the actual location of the files on disk e.g. /movies => ${MOVIES_DIR_LOCAL} e.g. /movies => /volume1/movies)
MUSIC_DIR_LOCAL: The directory to keep Music files that are organized locally on disk (i.e. /volume1/music)
MUSIC_DIR_RELATIVE: The directory to keep Music files that are organized relative to the container (i.e. not the actual location of the files on disk e.g. /music => ${MUSIC_DIR_LOCAL} e.g. /music => /volume1/music)
NAME_SERVERS: The DNS servers to use when the VPN is connected
~~NZBGET_WEBUI_PASSWORD: NZBGet Password for the Web UI~~
~~NZBGET_WEBUI_USERNAME=admin: NZBGet Username for the Web UI~~
OPENVPN_CONFIG: Transmission OpenVPN configuration file(s) to use (e.g. us_west.ovpn => us_west or to use more than one file: us_west,us_california,us_east)
OPENVPN_OPTS: Transmission OpenVPN optional arguments (default: null)
OPENVPN_PROVIDER: Transmission OpenVPN Provider (e.g. PIA for Private Internet Access VPN, etc.)
PERSONAL_DIR_LOCAL: The directory where Personal videos files that are organized locally on disk (i.e. /volume1/personal/videos)
PERSONAL_DIR_RELATIVE: The directory where Personal videos files that are organized relative to the container (i.e. not the actual location of the files on disk e.g. /personal => ${PERSONAL_DIR_LOCAL} e.g. /personal => /volume1/personal/videos)
PLEX_CLAIM: The Plex claim ID received from https://plex.tv/claim when first starting the Plex service
PRIVATE_INTERNET_ACCESS_VPN_PORT_FORWARDING: Gluetun VPN killswitch setting for port forward with Private Internet Access (i.e. on or off)
~~RANA_ARGUMENTS: Arguments to pass in rana on execution to find a prefixed sub-string(s) (e.g. "-n=j0hnwyles,j0hnwyl3s -c 4")~~
SERVER_COUNTRIES: Gluetun VPN killswitch setting for the regions to use (e.g. Switzerland,Estonia,Iceland,Panama,Romania)
SUBNET: The subnet for the Docker Compose environment (e.g. 172.16.0.0/16)
SYNCTHING_MOUNT_DIR_1_LOCAL: The directory of a path locally that you would like to have Syncthing sync with other Syncthing instances (i.e. /volume1/sync)
SYNCTHING_MOUNT_DIR_1_RELATIVE: The directory Syncthing will refer to locally relative to the container (i.e. not the actual location of the files on disk e.g. /sync => ${SYNCTHING_MOUNT_DIR_1_LOCAL} e.g. /sync => /volume1/sync)
SYNCTHING_MOUNT_DIR_2_LOCAL: The directory of a path locally that you would like to have Syncthing sync with other Syncthing instances (i.e. /volume1/some_other_directory)
SYNCTHING_MOUNT_DIR_2_RELATIVE: The directory Syncthing will refer to locally relative to the container (i.e. not the actual location of the files on disk e.g. /some_other_directory => ${SYNCTHING_MOUNT_DIR_1_LOCAL} e.g. /some_other_directory => /volume1/some_other_directory)
TAILSCALE_HOSTNAME: The hostname of this tailscale instance (e.g. my-nas-server)
TAILSCALE_STATE_ARG: The Tailscale argument for the state argument variable (e.g. "mem:")
TRANSMISSION_PASS: The default password to set for Tranmission account (default: admin)
TRANSMISSION_USER: The account for access to Transmission (default: admin)
TS_ACCEPT_DNS: Tailscale setting for DNS entries (default: true)
TS_AUTH_KEY: The Tailscale authorization key from Tailscale.com > Settings > Personal Settings > Keys
TS_DEST_IP: Tailscale setting for target IP (default: null)
TS_EXTRA_ARGS: Extra arguments to pass to tailscale up (Recommended: ="--reset --advertise-exit-node --ssh")
TS_KUBE_SECRET: Kubernetes secret if you are in a K8S cluster
TS_OUTBOUND_HTTP_PROXY_LISTEN: Proxy settings if you have outbound proxy settings (default: null)
TS_ROUTES: Tailscale routing (default: null)
TS_SOCKET: Socket file for tailscaled (default: /tmp/tailscaled.sock)
TS_TAILSCALED_EXTRA_ARGS: Extra arguments to pass to start of tailscaled (default: null)
TS_USERSPACE: Userspace setting for Tailscale (default: null)
TS_SOCKS5_SERVER: SOCKS5 settings (default: null)
TS_STATE_DIR: Directory for tailscale storage state directory (default: /var/lib/tailscale)
TV_DIR_LOCAL: The directory to keep TV show files that are organized locally on disk (i.e. /volume1/tv)
TV_DIR_RELATIVE: The directory to keep TV show files that are organized relative to the container (i.e. not the actual location of the files on disk e.g. /tv => ${TV_DIR_LOCAL} e.g. /tv => /volume1/tv) /volume1/movies)
UN_LIDARR_0_API_KEY: Lidarr API key
UN_RADARR_0_API_KEY: Radarr API key
UN_READARR_0_API_KEY: Readarr API key
UN_SONARR_0_API_KEY: Sonarr API key
~~VANITY_AGE_ARGUMENTS: A RegEx that you would like to find at the beginning of a age public key (e.g. "\d+j0hn\d?wyles.*")~~
VPN_PASS: VPN password for your VPN provider
VPN_SERVICE_PROVIDER: Gluetun VPN service provider (e.g. private internet access for Private Internet Access VPN, nordvpn for NordVPN, etc.)
VPN_USER: VPN username for your VPN provider
WATCHTOWER_NOTIFICATION_URL: (optional) Watchtower Webhook Notification URL
WATCHTOWER_POLL_INTERVAL: Interval for Watchtower to check for new container images (e.g. 21600 ("6 hours"))
WIREGUARD_PRIVATE_KEY: Gluetun wireguard private key setting (Author note: I do regret if you have to go through setting this arduous process... Details here (for NordVPN at least): Getting NordVPN WireGuard details

TODO

Now personal notes to myself on some of that which remains:

P0: Consider adding photoprism
P1: Consider adding Lemmy
P1: Add instructions for wiring everything together (with pictures?)
P1: Add instructions for Gluetun containers to replace those found below
P2: Add ports and whatever else from docker-compose-*.yaml files to be passed as ENV variables
P3: See if SearXNG needs more tuning and spend some time with it
P3: Add rana and vanity-age executables, Docker build instructions, and docker compose running instructions

TODO: Change This to Gluetun Instructions

Transmission OpenVPN Setup

Even if you are not using Transmission for your torrent download client (I personally use Deluge) I found the container comes up much faster than the DelugeVPN project and it also is more stable of a connection between both the containers using it as well as with the VPN provider. Additionally the Transmission OpenVPN project is more friendly for selecting multipule VPN servers as well as configuration. Below is an example with Private Internet Access but the project supports many other services (which again is also why I did not like the DelugeVPN project). You'll want to follow similar steps for whichever provider you have chosen. However, the end goal is to get all of your OpenVPN .ovpn files downloaded in the Transmission OpenvVPN containers configuration directory under the directory openvpn:

pushd ${CONFIG_BASE_DIR}/transmission-openvpn/
  curl -O <https://www.privateinternetaccess.com/openvpn/openvpn.zip>
  unzip openvpn.zip
popd

johnwyles / docker-compose-media-center Goto Github PK