Sign inSign up

ravensorb/linuxserver-mods-heimdall-init

By ravensorb

Updated about 5 years ago

Image
0

1.2K

ravensorb/linuxserver-mods-heimdall-init repository overview

linuxserver-mods-heimdall-init [v1.0]

Created by: Shawn Anderson

Overview

This linux server mod handles the initial setup and configuration of the image at startup based on the specified environment variables values


Container: heimdall-init-mod

Environment Variables
NameValueComment
TZAmerica/New YorkThe timezone to use
PUID1000The default process uid
PGID1000The default process guid
CONTAINER_DOMAINhome.localCurrent root domain name
HEIMDALL_PORT_INTERNAL_HTTP{{heimdall-port-internal}}
HEIMDALL_EMAIL_FROMADDRESS{{heimdall-email-fromaddress}}
HEIMDALL_OPTIONS_APPS_SABNZBD_ENABLED1
SABNZBD_URL_EXTERNAL{{sabnzbd-url-external}}
SABNZBD_HOST_INTERNAL{{sabnzbd-host-internal}}
SABNZBD_PORT_INTERNAL_HTTP{{sabnzbd-httpport}}
SABNZBD_APIKEYd444ca810cf611eca18b2f3207dd2f56A valid SabNzbd API Key
HEIMDALL_OPTIONS_APPS_QBITTORRENT_ENABLED1
QBITTORRENT_URL_EXTERNAL{{qbittorrent-url-external}}
QBITTORRENT_HOST_INTERNAL{{qbittorrent-host-internal}}
QBITTORRENT_PORT_INTERNAL_HTTP{{qbittorrent-port-internal-http}}
QBITTORRENT_USERNAMEadmin
QBITTORRENT_PASSWORDadminadmin
HEIMDALL_OPTIONS_APPS_SONARR_ENABLED1
SONARR_URL_EXTERNAL{{sonarr-url-external}}
SONARR_HOST{{sonarr-host-internal}}
SONARR_PORT_INTERNAL_HTTP8989
SONARR_APIKEYd444ca850cf611eca18b2f3207dd2f56A valid SONARR API Key
HEIMDALL_OPTIONS_APPS_RADARR_ENABLED1
RADARR_URL_EXTERNAL{{radarr-url-external}}
RADARR_HOST{{radarr-host-internal}}
RADARR_PORT_INTERNAL_HTTP{{radarr-port-internal-http}}
RADARR_APIKEYd444ca860cf611eca18b2f3207dd2f56A valid RADARR API Key
HEIMDALL_OPTIONS_APPS_NZBGET_ENABLED1
NZBGET_URL_EXTERNAL{{nzbget-url-extgernal}}
NZBGET_HOST{{nzbget-host-internal}}
NZBGET_PORT_INTERNAL_HTTP{{nzbget-port-internal}}
NZBGET_USERNAME
NZBGET_PASSWORD{{nzbget--password}}
HEIMDALL_OPTIONS_APPS_LIDARR_ENABLED1
LIDARR_URL_EXTERNAL{{lidarr-url-external}}
LIDARR_HOST{{lidarr-host-internal}}
LIDARR_PORT_INTERNAL_HTTP8686
LIDARR_APIKEYd444ca870cf611eca18b2f3207dd2f56A valid LIDARR API Key
HEIMDALL_OPTIONS_APPS_JACKETT_ENABLED1
JACKETT_URL_EXTERNAL{{jackett-url-external}}
JACKETT_HOST_INTERNAL{{jackett-host-internal}}
JACKETT_PORT_INTERNAL_HTTP9117
JACKETT_APIKEYd444ca820cf611eca18b2f3207dd2f56A valid Jackett API Key
HEIMDALL_OPTIONS_APPS_PLEX_ENABLED0
PLEX_URL_EXTERNAL{{plex-url-external}}
PLEX_URL_INTERNAL{{plex-url-internal}}
PLEX_TOKEN{{plex-token}}A valid Plex Token
HEIMDALL_OPTIONS_APPS_PORTAINER_ENABLED1
PORTAINER_URL_EXTERNAL{{portainer-url-external}}
HEIMDALL_OPTIONS_APPS_TRAEFIK_ENABLED1
TRAEFIK_URL_EXTERNAL{{traefik-url-external}}
HEIMDALL_OPTIONS_APPS_AIRSONIC_ENABLED0
AIRSONIC_URL_EXTERNAL{{airsonic-url-external}}
HEIMDALL_OPTIONS_APPS_BAZARR_ENABLED0
BAZARR_URL_EXTERNAL{{bazarr-url-external}}
HEIMDALL_OPTIONS_APPS_BOOKSTACK_ENABLED0
BOOKSTACK_URL_EXTERNAL{{bookstack-url-external}}
HEIMDALL_OPTIONS_APPS_CALIBREWEB_ENABLED0
CALIBREWEB_URL_EXTERNAL{{calibreweb-url-external}}
HEIMDALL_OPTIONS_APPS_HOMEASSISTANT_ENABLED0
HOMEASSISTANT_URL_EXTERNAL{{homeassistant-url-external}}
HOMEASSISTANT_HOST{{homeassistant-host-internal}}
HOMEASSISTANT_PORT_INTERNAL_HTTP{{homeassistant-port-internal}}
HEIMDALL_OPTIONS_APPS_DOMOTICZ_ENABLED0
DOMOTICZ_URL_EXTERNAL{{domoticz-url-external}}
DOMOTICZ_HOST{{domoticz-host-internal}}
DOMOTICZ_PORT_INTERNAL_HTTP{{domoticz-port-internal}}
DOMOTICZ_IDX{{domoticz-idx}}
HEIMDALL_OPTIONS_APPS_HEADPHONES_ENABLED0
HEADPHONES_URL_EXTERNAL{{headphones-url-external}}

Sample docker-compose.yml

version: "3.7"

services:

  heimdall-init-mod:
    image: linuxservier/heimdall-init-mod
    env:
        - DOCKER_MODS=ravensorb/linuxserver-mods-heimdall-init
        - TZ=America/New York # The timezone to use
        - PUID=1000 # The default process uid
        - PGID=1000 # The default process guid
        - CONTAINER_DOMAIN=home.local # Current root domain name
        # The following variables are used by the MOD
        - HEIMDALL_PORT_INTERNAL_HTTP={{heimdall-port-internal}} # 
        - HEIMDALL_EMAIL_FROMADDRESS={{heimdall-email-fromaddress}} # 
        - HEIMDALL_OPTIONS_APPS_SABNZBD_ENABLED=1 # 
        - SABNZBD_URL_EXTERNAL={{sabnzbd-url-external}} # 
        - SABNZBD_HOST_INTERNAL={{sabnzbd-host-internal}} # 
        - SABNZBD_PORT_INTERNAL_HTTP={{sabnzbd-httpport}} # 
        - SABNZBD_APIKEY=d444ca810cf611eca18b2f3207dd2f56 # A valid SabNzbd API Key
        - HEIMDALL_OPTIONS_APPS_QBITTORRENT_ENABLED=1 # 
        - QBITTORRENT_URL_EXTERNAL={{qbittorrent-url-external}} # 
        - QBITTORRENT_HOST_INTERNAL={{qbittorrent-host-internal}} # 
        - QBITTORRENT_PORT_INTERNAL_HTTP={{qbittorrent-port-internal-http}} # 
        - QBITTORRENT_USERNAME=admin # 
        - QBITTORRENT_PASSWORD=adminadmin # 
        - HEIMDALL_OPTIONS_APPS_SONARR_ENABLED=1 # 
        - SONARR_URL_EXTERNAL={{sonarr-url-external}} # 
        - SONARR_HOST={{sonarr-host-internal}} # 
        - SONARR_PORT_INTERNAL_HTTP=8989 # 
        - SONARR_APIKEY=d444ca850cf611eca18b2f3207dd2f56 # A valid SONARR API Key
        - HEIMDALL_OPTIONS_APPS_RADARR_ENABLED=1 # 
        - RADARR_URL_EXTERNAL={{radarr-url-external}} # 
        - RADARR_HOST={{radarr-host-internal}} # 
        - RADARR_PORT_INTERNAL_HTTP={{radarr-port-internal-http}} # 
        - RADARR_APIKEY=d444ca860cf611eca18b2f3207dd2f56 # A valid RADARR API Key
        - HEIMDALL_OPTIONS_APPS_NZBGET_ENABLED=1 # 
        - NZBGET_URL_EXTERNAL={{nzbget-url-extgernal}} # 
        - NZBGET_HOST={{nzbget-host-internal}} # 
        - NZBGET_PORT_INTERNAL_HTTP={{nzbget-port-internal}} # 
        - NZBGET_USERNAME= # 
        - NZBGET_PASSWORD={{nzbget--password}} # 
        - HEIMDALL_OPTIONS_APPS_LIDARR_ENABLED=1 # 
        - LIDARR_URL_EXTERNAL={{lidarr-url-external}} # 
        - LIDARR_HOST={{lidarr-host-internal}} # 
        - LIDARR_PORT_INTERNAL_HTTP=8686 # 
        - LIDARR_APIKEY=d444ca870cf611eca18b2f3207dd2f56 # A valid LIDARR API Key
        - HEIMDALL_OPTIONS_APPS_JACKETT_ENABLED=1 # 
        - JACKETT_URL_EXTERNAL={{jackett-url-external}} # 
        - JACKETT_HOST_INTERNAL={{jackett-host-internal}} # 
        - JACKETT_PORT_INTERNAL_HTTP=9117 # 
        - JACKETT_APIKEY=d444ca820cf611eca18b2f3207dd2f56 # A valid Jackett API Key
        - HEIMDALL_OPTIONS_APPS_PLEX_ENABLED=0 # 
        - PLEX_URL_EXTERNAL={{plex-url-external}} # 
        - PLEX_URL_INTERNAL={{plex-url-internal}} # 
        - PLEX_TOKEN={{plex-token}} # A valid Plex Token
        - HEIMDALL_OPTIONS_APPS_PORTAINER_ENABLED=1 # 
        - PORTAINER_URL_EXTERNAL={{portainer-url-external}} # 
        - HEIMDALL_OPTIONS_APPS_TRAEFIK_ENABLED=1 # 
        - TRAEFIK_URL_EXTERNAL={{traefik-url-external}} # 
        - HEIMDALL_OPTIONS_APPS_AIRSONIC_ENABLED=0 # 
        - AIRSONIC_URL_EXTERNAL={{airsonic-url-external}} # 
        - HEIMDALL_OPTIONS_APPS_BAZARR_ENABLED=0 # 
        - BAZARR_URL_EXTERNAL={{bazarr-url-external}} # 
        - HEIMDALL_OPTIONS_APPS_BOOKSTACK_ENABLED=0 # 
        - BOOKSTACK_URL_EXTERNAL={{bookstack-url-external}} # 
        - HEIMDALL_OPTIONS_APPS_CALIBREWEB_ENABLED=0 # 
        - CALIBREWEB_URL_EXTERNAL={{calibreweb-url-external}} # 
        - HEIMDALL_OPTIONS_APPS_HOMEASSISTANT_ENABLED=0 # 
        - HOMEASSISTANT_URL_EXTERNAL={{homeassistant-url-external}} # 
        - HOMEASSISTANT_HOST={{homeassistant-host-internal}} # 
        - HOMEASSISTANT_PORT_INTERNAL_HTTP={{homeassistant-port-internal}} # 
        - HEIMDALL_OPTIONS_APPS_DOMOTICZ_ENABLED=0 # 
        - DOMOTICZ_URL_EXTERNAL={{domoticz-url-external}} # 
        - DOMOTICZ_HOST={{domoticz-host-internal}} # 
        - DOMOTICZ_PORT_INTERNAL_HTTP={{domoticz-port-internal}} # 
        - DOMOTICZ_IDX={{domoticz-idx}} # 
        - HEIMDALL_OPTIONS_APPS_HEADPHONES_ENABLED=0 # 
        - HEADPHONES_URL_EXTERNAL={{headphones-url-external}} # 
    logging:
      driver: json-file
      options:
        max-size: "100m"
        max-file: "10"
    security_opt:
      - no-new-privileges:true
    restart: always

Tag summary

Content type

Image

Digest

Size

46.6 kB

Last updated

about 5 years ago

docker pull ravensorb/linuxserver-mods-heimdall-init