Skip to content
/ docker-compose-homelab Public

Refurbished ALL IN ONE media center and homelab server based on servarr and all the goodies that we love.

License

MIT license
3 stars 0 forks Branches Tags Activity
Star
Notifications You must be signed in to change notification settings

RawSmokeTerribilus/docker-compose-homelab

BranchesTags

Repository files navigation

🎩 Attribution & Gratitude

John Wyles
Original Repository

"We stand on the shoulders of giants" - Isaac Newton
This project exists thanks to John Wyles' groundbreaking work in home server automation.
Massive respect to the original docker-compose-media-center repository that inspired this evolution.

🌟 Special Thanks

 
 Visit John's GitHub Profile 
   Profile

docker-compose-media-center

This repository contains the Docker compose files for standing up an entire Servarr stack along with other supporting tools and services best suited for an at-home NAS or media center, of course based on Linux and using Cloudflare tunnels to expose your services (if you were wondering why there isn't a reverse proxy in the stack).

Table of contents:

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.

Service Categories and Applications

Below is a list of all the services available in the consolidated docker-compose.yml file. These services setup a complete Servarr stack with associated tools, media players, and miscellaneous self-hosted utilities. You can enable or disable specific services by editing the docker-compose.yml file. This section provides links to Docker image sources, GitHub repositories, and descriptions of each service.

Portainer

  • Portainer: Portainer for managing Docker containers and monitoring resource usage.

Crypto Tools [OPTIONAL]

NOTE: These services are disabled by default in the compose file as they can be CPU intensive and may not be necessary for most users. Contact the project maintainer if you would like more information.

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

Operations

  • cAdvisor: A tool for monitoring Docker containers, images, system resources, etc.
  • Grafana: A tool for visualizing metrics and logs.

Download Clients

  • Deluge: Lightweight BitTorrent client.
  • DelugeVPN: Deluge with built-in VPN support.
  • FlareSolverr: Proxy server to bypass Cloudflare protection.
  • NZBGet: Efficient Usenet downloader.
  • NZBGetVPN: NZBGet with built-in VPN support.
  • qBittorrent: Feature-rich BitTorrent client. (avoid firefox for first login)
  • Unpackerr: Extracts and processes media files after download.
  • Pinchflat: Web archive and download manager with collection capabilities.

Media Players

  • Jellyfin: A free software media system to organize, manage, and stream media.
  • Jellyseerr: Request management and media discovery tool for Jellyfin.
  • Overseerr: Request management and media discovery tool for Plex.
  • Plex: A client-server media player system and software suite.
  • Tautulli: A Python-based monitoring and tracking tool for Plex Media Server.

Media Management

  • Tdarr: Audio/Video library analytics and transcode automation.
  • Kometa: Media management and organization tool.

Home Automation

  • Home Assistant: Open-source home automation platform running on Python.

Ebook Services

  • Calibre: A powerful and easy to use e-book manager (no authentication by default)
  • Calibre-web: Web interface for browsing and reading e-books from a Calibre database (default login: admin/admin123)
  • Readarr: E-book management tool, part of the *arr family

Other Tools & Utilities

Installation and Setup

The setup process has been simplified with a consolidated docker-compose.yml file. Follow these steps to deploy your homelab services:

  1. Install Docker and Docker Compose on your system.

  2. 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

  3. Copy the environment_variables.env.example file to environment_variables.env and update the variables according to your configuration:

    cp environment_variables.env.example environment_variables.env
nano environment_variables.env  # Or use your preferred text editor

    IMPORTANT NOTE: You don't need to complete all values at once. Fill in the essential ones to start and update others as you set up services. See the Environment Variables section for details.

  4. Create the necessary directories for service configuration as described in the Directory Structure section.

4.b First thing we do is make sure the portainer Docker compose file is in the portainer/ directory. This is because Portainer is weird and launches with a stack named after the parent directory to the image it is launched from. This way in our case it will be portainer now: shell cd portainer/ docker compose --file docker-compose-portainer.yaml --env-file ../environment_variables.env up --detach Remember to go back to the root project's folder with: shell cd ../

  1. Deploy all services at once with:

    docker-compose --env-file environment_variables.env up -d

    Or deploy specific service groups by using labels:

    # Example: Deploy only download clients
docker-compose up -d --scale "group=downloaders"

# Example: Deploy only the Servarr stack
docker-compose up -d --scale "group=servarr"

  2. Access Portainer at http://your-server-ip:9000 to manage your containers through a web interface.

  3. For Kometa scheduling, add the following to the jobs.ini file in the ofelia config directory:

    [job-exec "kometa daily"]
  schedule = 45 11 * * *
  container = kometa
  command = photoprism index --cleanup
  no-overlap = true

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 create every directory below and its 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 (highlighted 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:

# Media Center Core
mkdir -p ${CONFIG_BASE_DIR}/bazarr
mkdir -p ${CONFIG_BASE_DIR}/calibre-web
mkdir -p ${CONFIG_BASE_DIR}/deluge
mkdir -p ${CONFIG_BASE_DIR}/emby
mkdir -p ${CONFIG_BASE_DIR}/grafana/{database,storage,snmp}
mkdir -p ${CONFIG_BASE_DIR}/homarr/{configs,icons,data}
mkdir -p ${CONFIG_BASE_DIR}/jackett
mkdir -p ${CONFIG_BASE_DIR}/jellyfin
mkdir -p ${CONFIG_BASE_DIR}/jellyseerr
mkdir -p ${CONFIG_BASE_DIR}/lidarr
mkdir -p ${CONFIG_BASE_DIR}/nextcloud-aio
mkdir -p ${CONFIG_BASE_DIR}/notifiarr
mkdir -p ${CONFIG_BASE_DIR}/ofelia
mkdir -p ${CONFIG_BASE_DIR}/photoprism/{database,storage}
mkdir -p ${CONFIG_BASE_DIR}/portainer
mkdir -p ${CONFIG_BASE_DIR}/prometheus/{config,data}
mkdir -p ${CONFIG_BASE_DIR}/prowlarr
mkdir -p ${CONFIG_BASE_DIR}/qbittorrent
mkdir -p ${CONFIG_BASE_DIR}/radarr
mkdir -p ${CONFIG_BASE_DIR}/readarr
mkdir -p ${CONFIG_BASE_DIR}/redis
mkdir -p ${CONFIG_BASE_DIR}/sonarr
mkdir -p ${CONFIG_BASE_DIR}/syncthing
mkdir -p ${CONFIG_BASE_DIR}/tdarr/{server,configs,logs,transcode_cache}
mkdir -p ${CONFIG_BASE_DIR}/unpackerr

# Monitoring Stack 
mkdir -p ${CONFIG_BASE_DIR}/cadvisor
mkdir -p ${CONFIG_BASE_DIR}/node_exporter
mkdir -p ${CONFIG_BASE_DIR}/snmp_exporter
mkdir -p ${CONFIG_BASE_DIR}/speedtest_exporter

# Ebook Services
mkdir -p ${CONFIG_BASE_DIR}/calibre/{config,books}
mkdir -p ${CONFIG_BASE_DIR}/calibre-web

# New Tools & Utilities  
mkdir -p ${CONFIG_BASE_DIR}/nextcloud-aio
mkdir -p ${CONFIG_BASE_DIR}/flaresolverr
mkdir -p ${CONFIG_BASE_DIR}/pinchflat/{config,downloads}

# Optional/Inactive Services (commented out)
# mkdir -p ${CONFIG_BASE_DIR}/caddy
# mkdir -p ${CONFIG_BASE_DIR}/delugevpn
# mkdir -p ${CONFIG_BASE_DIR}/gluetun
# mkdir -p ${CONFIG_BASE_DIR}/immich/{cache,database}
# mkdir -p ${CONFIG_BASE_DIR}/kometa
# mkdir -p ${CONFIG_BASE_DIR}/mylar3
# mkdir -p ${CONFIG_BASE_DIR}/nzbget
# mkdir -p ${CONFIG_BASE_DIR}/overseerr
# mkdir -p ${CONFIG_BASE_DIR}/paperless-ngx
# mkdir -p ${CONFIG_BASE_DIR}/plex
# mkdir -p ${CONFIG_BASE_DIR}/sabnzbd
# mkdir -p ${CONFIG_BASE_DIR}/sabnzbdvpn
# mkdir -p ${CONFIG_BASE_DIR}/searxng
# mkdir -p ${CONFIG_BASE_DIR}/tailscale
# mkdir -p ${CONFIG_BASE_DIR}/tautulli
# mkdir -p ${CONFIG_BASE_DIR}/transmission
# mkdir -p ${CONFIG_BASE_DIR}/transmission-openvpn
# mkdir -p ${CONFIG_BASE_DIR}/wallabag/{database,images}

Copy the resources for Ofelia and Prometheus to their respective directories:

cp 'project-folder'/resources/ofelia/jobs.ini ${CONFIG_BASE_DIR}/ofelia/jobs.ini
cp 'project-folder'/resources/prometheus/config/prometheus.yaml ${CONFIG_BASE_DIR}/prometheus/config/prometheus.yaml

For Grafana you will want to import the dashboard from resources/grafana/servarr_dashboard.json into the utility through the UI after the service has been started.

Environment Variables

Environment variables are organized into clear sections in both .env and environment_variables.env.example:

Variable Organization

  • Base Configuration

  • Media Players & Services

  • Download Clients

  • Monitoring Tools

  • Photo Management

  • System Resources

  • Authentication & API Keys

  • Service-specific Configurations

    Some examples:

    • BAZARR_API_KEY: The API key for Bazarr

  • 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.)

  • DOCUMENTS_DIR_LOCAL: The directory of locally stored Document files

  • DOWNLOADS_DIR_COMPLETE_LOCAL: The directory to keep completely downloaded files locally on disk (i.e. /volume1/Downloads/complete)

  • DOWNLOADS_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 => ${DOWNLOADS_DIR_COMPLETE_LOCAL} e.g. /complete => /volume1/Downloads/complete)

  • DOWNLOADS_DIR_INCOMPLETE_LOCAL: The directory to keep incompletely downloaded files locally on disk (i.e. /volume1/Downloads/incomplete)

  • DOWNLOADS_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 => ${DOWNLOADS_DIR_INCOMPLETE_LOCAL} e.g. /incomplete => /volume1/Downloads/watch)

  • DOWNLOADS_DIR_WATCH_LOCAL: The directory to keep files to be watched locally on disk (i.e. /volume1/Downloads/watch)

  • DOWNLOADS_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 => ${DOWNLOADS_DIR_WATCH_LOCAL} e.g. /watch => /volume1/Downloads/watch)

  • GATEWAY_IP: Gateway IP for the Docker Compose subnet (e.g. 172.16.0.1)

  • GRAFANA_DATABASE_NAME: The name for the Grafana database

  • GRAFANA_DATABASE_USER: THe user for the Grafana database

  • GRAFANA_DATABASE_PASSWORD: THe password for the Grafana database

  • HEALTH_CHECK_HOST: Hostname to use for VPN health checks (e.g.: google.com)

  • HOMEASSISTANT_PGID: The group ID for the running process in the container environment (e.g. 1000)

  • HOMEASSISTANT_PUID: The user ID for the running process in the container environment (e.g. 1000)

  • HOMEASSISTANT_CONFIG_BASE_DIR: The base directory where each of the containers for and support Home Assistant will have their configurations persistently stored between reboots, restarts, etc. (e.g. /volume1/homeassistant-docker)... and will serve the container the directory (e.g. NodeRED => /volume1/homeassistant-docker/nodered, ZigBee => /volume1/homeassistant-docker/zigbee, Home Assistant => /volume1/homeassistant-docker/homeassistant, etc.) => (e.g. NodeRED => nodered, ZigBee => zigbee, Home Assistant => homeassistant, etc.). So, in this example, it is simply the home where each of these containers configurations will live: /volume1/homeassistant-docker

  • HOMEASSISTANT_DATA_DIR_1_LOCAL: The directory to of data files we would like exposed to Home Assistant locally on disk (i.e. /tmp)

  • HOMEASSISTANT_DATA_DIR_2_LOCAL: The directory to of data files we would like exposed to Home Assistant locally on disk (i.e. /etc)

  • HOMEASSISTANT_DATA_DIR_3_LOCAL: The directory to of data files we would like exposed to Home Assistant locally on disk (i.e. /mnt)

  • HOMEASSISTANT_DATA_DIR_1_RELATIVE: The directory to we house data files relative to the container (i.e. not the actual location of the files on disk e.g. /foo_tmp => ${HOMEASSISTANT_DATA_DIR_1_LOCAL} e.g. /foo_tmp => /tmp)

  • HOMEASSISTANT_DATA_DIR_2_RELATIVE: The directory to we house data files relative to the container (i.e. not the actual location of the files on disk e.g. /etc_tmp => ${HOMEASSISTANT_DATA_DIR_2_LOCAL} e.g. /etc_tmp => /etc)

  • HOMEASSISTANT_DATA_DIR_3_RELATIVE: The directory to we house data files relative to the container (i.e. not the actual location of the files on disk e.g. /mnt_tmp => ${HOMEASSISTANT_DATA_DIR_3_LOCAL} e.g. /mnt_tmp => /mnt)

  • IMMICH_DB_DATABASE_NAME: The name for the Immich database

  • IMMICH_DB_PASSWORD: A password for the Immich database

  • IMMICH_DB_USERNAME: A username for the Immich database

  • IMMICH_VERSION: The version of Immich to use (default: release)

  • 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.)

  • LIDARR_API_KEY: The API key for Lidarr

  • 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)

  • PGID: The group ID for the running process in the container environment (e.g. 1000)

  • PHOTOPRISM_USERNAME: The username for the PhotoPrism service

  • PHOTOPRISM_PASSWORD: The passowrd for the PhotoPrism service

  • PHOTOPRISM_DATABASE_NAME: The name for the PhotoPrism database

  • PHOTOPRISM_DATABASE_USER: The database user for the PhotoPrism database

  • PHOTOPRISM_DATABASE_PASSWORD: The database password for the PhotoPrism database (e.g. password)

  • PHOTOPRISM_DATABASE_ROOT_PASSWORD: The database root password for the PhotoPrism database

  • PHOTOS_DIR_LOCAL: The directory to photo file originals are stored for use by the photo services herein (e.g. PhotoPrism, Immich, etc.)

  • PLEX_CLAIM: The Plex claim ID received from https://plex.tv/claim when first starting the Plex service

  • PORTAINER_PASSWORD: An http password encoded string (see this tool: HTPasswd Generator) to use for the Portainer docker instance we create

  • PRIVATE_INTERNET_ACCESS_VPN_PORT_FORWARDING: Gluetun VPN killswitch setting for port forward with Private Internet Access (i.e. on or off)

  • PROWLARR_API_KEY: The API key for Prowlarr

  • PUID: The user ID for the running process in the container environment (e.g. 1000)- RANA_ARGUMENTS: Arguments to pass in rana on execution to find a prefixed sub-string(s) (e.g. "-n=j0hnwyles,j0hnwyl3s -c 4")

  • READARR_API_KEY: The API key for Readarr

  • RADARR_API_KEY: The API key for Radarr

  • SABNZBD_API_KEY: The API key for Sabnzbd

  • SERVER_COUNTRIES: Gluetun VPN killswitch setting for the regions to use

  • SEARXNG_HOSTNAME: Hostname to reference for SearXNG internally

  • SONARR_API_KEY: The API key for Sonarr (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.)

  • WATCHTOWER_HTTP_API_TOKEN: A passphrase to use when pulling metrics for a tool like Promethus

  • WATCHTOWER_NOTIFICATION_URL: A webhook URL to hit for Watchtower notifications

  • WATCHTOWER_POLL_INTERVAL: Poll interval for Watchtower to check for images

  • VPN_USER: VPN username for your VPN provider

  • WALLABAG_DATABASE_NAME: The name for the Wallabag database

  • WALLABAG_DATABASE_PASSWORD: The password for the Wallabag database

  • WALLABAG_DATABASE_ROOT_PASSWORD: The root password for the Wallabag database

  • WALLABAG_DATABASE_USER: The user for the Wallabag database

  • WALLABAG_DOMAIN_NAME: The domain name for the Wallabag service

  • WALLABAG_FROM_EMAIL: The email address to use for the "from" field in emails

  • WALLABAG_SERVER_NAME: The server name for the Wallabag service

  • 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

Port Variables Convention

All service ports follow a standardized naming convention:

# External port (host machine)
SERVICE_LOCAL_PORT=xxxx

# Internal port (container)
SERVICE_RELATIVE_PORT=xxxx

# Example:
DELUGE_LOCAL_PORT_GUI=8112    # Port on your host
DELUGE_RELATIVE_PORT_GUI=8112  # Port inside container

Important Notes

  1. Active vs. Commented Services:

    • Variables for active services in docker-compose.yml should be uncommented in .env
    • Variables for commented services should remain commented in .env
    • The example file contains all possible variables with generic placeholders

  2. Internal Communication:

    • For container-to-container communication, services use hardcoded internal ports
    • Example: http://sonarr:8989 in service URLs
    • These internal URLs are independent of the exposed port variables

  3. Resource Limits: Services can have optional resource limit variables:

    SERVICE_MEM_LIMIT=128m
SERVICE_CPU_SHARES=128

  4. Environment Files:

    • .env: Your active configuration with real values
    • environment_variables.env.example: Template with generic placeholders
    • Both files maintain the same structure and organization

TODO

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

  • P0: Fix prometheus
  • P1: Consider adding Lemmy
  • P1: Add instructions for wiring everything together (with pictures?)
  • P1: Add instructions for Gluetun containers
  • P3: See if SearXNG needs more tuning and add it?
  • P3: Add documentation or maybe breakout Home Assistant

TODO List

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

About

Refurbished ALL IN ONE media center and homelab server based on servarr and all the goodies that we love.

Topics

docker-compose selfhosted entertainment mediaserver nextcloud-docker homelab-setup servarr

Resources

Readme

License

MIT license
Activity

Stars

3 stars

Watchers

2 watching

Forks

0 forks
Report repository

Releases

1 tags

Packages

No packages published

Languages