Skip to content

Version 1.21

All new containers are disabled by default. Enable them in inventory/group_vars/all/container_map.yml.

  • Tinyauth (tinyauth) and Pocket ID (pocketid): a lightweight sign-in page for Traefik, with Pocket ID passkeys as the login. A lighter alternative to Authentik, configured entirely from inventory variables. List the containers to protect in hmsdocker_tinyauth_protected_containers
  • Docker Socket Proxy (socket-proxy): gives each container that uses the Docker socket its own filtered socket that only allows the Docker API requests it needs
  • Audiobookshelf (audiobookshelf): audiobook and podcast server, on port 13378, with a Homepage widget (hmsdocker_homepage_audiobookshelf_key)
  • Tunarr (tunarr): builds live TV channels from Plex, Jellyfin, Emby or local media, on port 8002
  • ErsatzTV (ersatztv): builds live TV channels from local media and Plex, Jellyfin or Emby libraries
  • NeXroll (nexroll): preroll manager for Plex, Jellyfin and Emby

Tunarr and ErsatzTV support Intel and Nvidia hardware transcoding.

Authentik, Tinyauth and Pocket ID settings now live in one defaults file, sso.yml, which replaces authentik.yml. Your existing inventory/group_vars/all/authentik.yml keeps working unchanged. To use Tinyauth or Pocket ID, copy the Tinyauth section from roles/hmsdocker/defaults/main/sso.yml into your inventory.

External hosts in traefik_ext_hosts_list accept a new tinyauth key to put them behind a Tinyauth sign-in.

With socket-proxy enabled, each supported container gets its own socket-proxy-<container> container in place of the raw Docker socket. The proxies run read-only, with all capabilities dropped and no network. Built-in allowlists cover Traefik, Homepage, Uptime Kuma, the Beszel agent, Watchtower and the Authentik worker. Netdata, Portainer and Dockhand keep the raw socket. Change a container’s rules with hmsdocker_socket_proxy_overrides.

If you use Uptime Kuma’s Docker monitors, change each Docker host’s socket path in Uptime Kuma (Settings > Docker Hosts) to /var/run/socket-proxy/docker.sock after enabling the proxy. The playbook reminds you on that run.

FileFlows no longer mounts the Docker socket, which it never used.

New hmsdocker_readonly_media_containers setting in inventory/group_vars/all/container_settings.yml. Each listed container mounts the media share read-only, so it can read the library but not change, delete or encrypt it. Supported: Plex, Emby, Jellyfin, Kavita, Calibre, Audiobookshelf, Tunarr, ErsatzTV, Checkrr and Librariarr. See Container Settings for what stops working in each app (such as saving artwork or deleting media). The default empty list changes nothing.

master now only changes when a release is published, so make update keeps you on the latest release. To test changes before they are released, switch to the develop branch with make switch-develop, and go back with make switch-stable. make branch shows which one you are on. See Updating.

make update now merges new container map entries from the code it just pulled, instead of downloading them from the docs site.

None are required. Every default keeps the previous behaviour.

sso.yml (Tinyauth and Pocket ID):

  • hmsdocker_tinyauth_users (default []): Tinyauth users, as username:bcrypt_hash
  • hmsdocker_tinyauth_protected_containers (default []): containers that require a Tinyauth sign-in
  • hmsdocker_tinyauth_oauth_whitelist (default []): emails allowed to sign in through Pocket ID; empty allows every Pocket ID user
  • hmsdocker_tinyauth_pocketid_enabled (default false): sign in to Tinyauth with Pocket ID
  • hmsdocker_tinyauth_pocketid_url (default ""): URL of a Pocket ID you already run; empty uses the pocketid container
  • hmsdocker_tinyauth_pocketid_api_key (default ""): API key for an external Pocket ID, so the playbook can create the OIDC client
  • hmsdocker_tinyauth_pocketid_auto_redirect (default false): skip the Tinyauth login page and go straight to Pocket ID
  • hmsdocker_tinyauth_pocketid_client_id (default tinyauth) and hmsdocker_tinyauth_pocketid_client_secret (default "", generated when empty): the OIDC client

container_settings.yml:

  • hmsdocker_readonly_media_containers (default []): containers that mount the media share read-only
  • hmsdocker_socket_proxy_log_level (default info): log level of the socket proxies (debug, info, warn or error)
  • hmsdocker_socket_proxy_overrides (default {}): per-container changes to the socket proxy rules

homepage_api_keys.yml:

  • hmsdocker_homepage_audiobookshelf_key: API key for the Audiobookshelf Homepage widget

traefik.yml:

  • tinyauth key (default no) on each traefik_ext_hosts_list entry: puts that external host behind a Tinyauth sign-in

New container map entries: audiobookshelf, ersatztv, nexroll, pocketid, socket-proxy, tinyauth and tunarr. make update adds them to your container_map.yml disabled. No new keys were added to existing entries.

No variables were renamed, deprecated or removed in this release.

The Authentik variables (hmsdocker_authentik_enabled_through_cftunnel, hmsdocker_authentik_version, authentik_pg_user, authentik_pg_db, authentik_key_path, authentik_pgpass_path, authentik_external_host, authentik_geoip_account_id and authentik_geoip_license_key) moved from the authentik.yml defaults file to sso.yml with the same names and defaults. You don’t need to change anything: your inventory/group_vars/all/authentik.yml is still loaded.

  • Plex: the healthcheck uses /identity with a 5 second timeout, so it no longer marks a healthy server as unhealthy
  • Additional CIFS shares: mount paths and credentials files are paired correctly when there is more than one share, and library folders are created on the right share
  • Containers are recreated when a media share is newly mounted or changed, so they see the share without a manual restart
  • On a local media share, new library folders are created owned by the container user
  • Preflight now shows what to set when a secret (Plex claim token, Cloudflare tokens, CIFS or Usenet password, Tailscale auth key) is missing, instead of hiding the message
  • Preflight no longer crashes when a password or user is an unquoted number