Skip to content
HMS-Docker

Service-Specific Settings

These settings are configured in inventory/group_vars/all/service_misc.yml unless otherwise noted.

Media Transcoding

Section titled “Media Transcoding”

Transcoding Temp Path

Section titled “Transcoding Temp Path”
hmsdocker_transcode_temp_path: "/tmp/hmsd_transcode"

The temporary directory on the host used by transcoding containers (Tdarr, FileFlows, Unmanic). Each container gets its own subdirectory within this path (e.g., /tmp/hmsd_transcode/tdarr).

Tdarr Node Mode

Section titled “Tdarr Node Mode”
tdarr_enable_node_server: no

When enabled, Tdarr runs as both a server and a node on the same host, enabling distributed transcoding capabilities.

Download Management

Section titled “Download Management”

Unpackerr

Section titled “Unpackerr”
hmsdocker_unpackerr_additional_env_vars:
  {
    "UN_DEBUG": "false",
    "UN_INTERVAL": "2m",
    "UN_START_DELAY": "1m",
    "UN_RETRY_DELAY": "5m",
    "UN_MAX_RETRIES": "3",
    "UN_PARALLEL": "1",
    ...
  }

Additional environment variables passed to the Unpackerr container. The code block above shows a subset of the defaults — the full list can be found in roles/hmsdocker/defaults/main/service_misc.yml. See the Unpackerr configuration docs for all available options.

Media Health

Section titled “Media Health”

Checkrr

Section titled “Checkrr”
hmsdocker_checkrr_enable_arr_processing: false

When enabled, Checkrr will automatically request replacement copies through Sonarr, Radarr, and Lidarr if it detects a corrupt or problematic media file.

Backup

Section titled “Backup”

Backrest

Section titled “Backrest”
hmsdocker_backrest_allow_write: false
hmsdocker_backrest_enable_restore_path: false
hmsdocker_backrest_restore_path: "{{ hms_docker_data_path }}-restore"
  • hmsdocker_backrest_allow_write — Grants the Backrest container write access to the data directory (default: /opt/hms-docker). Required for restore operations.
  • hmsdocker_backrest_enable_restore_path — Enables a dedicated restore path for Backrest to write restored data to.
  • hmsdocker_backrest_restore_path — The path where Backrest will restore data to (default: /opt/hms-docker-restore).

Media Applications

Section titled “Media Applications”

Tube Archivist

Section titled “Tube Archivist”
hmsdocker_tubearchivist_username: tubearchivist
hmsdocker_tubearchivist_password: verysecret

Default credentials for the Tube Archivist web interface.

TinyMediaManager

Section titled “TinyMediaManager”
hmsdocker_tinymediamanager_vnc_password:

The VNC password used to access the TinyMediaManager web interface. Set this to a secure value if you enable TinyMediaManager.

Monitoring

Section titled “Monitoring”

Speedtest Tracker

Section titled “Speedtest Tracker”
hmsdocker_speedtest_api_key:
hmsdocker_speedtest_schedule: 0 0 * * *
  • hmsdocker_speedtest_api_key — API key for the Speedtest Tracker instance.
  • hmsdocker_speedtest_schedule — Cron schedule for running speed tests (default: daily at midnight).

Notifiarr

Section titled “Notifiarr”
hmsdocker_notifiarr_api_key:

API key from Notifiarr for unified notification management.

Tautulli

Section titled “Tautulli”
tautulli_include_jbops: false

When enabled, downloads and mounts the JBOPS scripts into the Tautulli container for additional Plex automation capabilities.