Skip to content

Homepage Dashboard

Homepage is able to integrate directly with Docker, allowing it to “auto-discover” the running containers/services.

Homepage can also integrate with a very large number of the containers in this project, so setting up the connection is very easy.

A number of applications already have their API keys retrieved automatically from their config files during a playbook run (such as Sonarr, Radarr, Prowlarr, Bazarr, Plex, Tautulli, and others).

For services that don’t support automatic key retrieval, you will need to manually define their API keys in inventory/group_vars/all/homepage_api_keys.yml. These can be found in each applications settings page.

Service Variable Notes
NZBGet hmsdocker_homepage_nzbget_username + hmsdocker_homepage_nzbget_password Uses NZBGet’s ControlUsername/ControlPassword (defaults to the linuxserver image defaults). Set to empty strings if you disabled NZBGet authentication.
Authentik hmsdocker_homepage_authentik_key See Authentik widget docs
Portainer hmsdocker_homepage_portainer_key
Jellyfin hmsdocker_homepage_jellyfin_key
Emby hmsdocker_homepage_emby_key
Autobrr hmsdocker_homepage_autobrr_key
Backrest hmsdocker_homepage_backrest_user / _pass Username and password
Cloudflare Tunnel hmsdocker_homepage_cftunnel_key, _accountid, _tunnelid API key requires Account.Cloudflare Tunnel:Read permission
Tailscale hmsdocker_homepage_tailscale_api_key, _device_id
NetBird hmsdocker_homepage_netbird_key Personal access token from a user with the Admin role (a service user is recommended)
Speedtest Tracker hmsdocker_homepage_speedtest_api_key
Tube Archivist hmsdocker_homepage_tubearchivist_api_key
Uptime Kuma hmsdocker_homepage_uptimekuma_statuspage_slug The slug from your status page URL
Dockhand hmsdocker_homepage_dockhand_user / _pass Username and password
qBittorrent hmsdocker_homepage_qbittorrent_user / _pass Web UI username (default admin) and password
Deluge hmsdocker_homepage_deluge_pass Web UI password (default deluge, the image default)
Audiobookshelf hmsdocker_homepage_audiobookshelf_key API key created under Settings > API Keys (as an admin)
FileFlows hmsdocker_homepage_fileflows_key FileFlows 26.10+ only serves widget data via the Fenrus endpoint. Enable “Fenrus Dashboard Endpoint” under Settings > General and use its token

Tdarr needs no manual key: the playbook generates one and seeds it into Tdarr (used by the internal node and the widget).

It is highly recommended to ensure the permissions and ownership of this file is locked down. You can do this by running:

Terminal window
chmod 0600 inventory/group_vars/all/homepage_api_keys.yml
Terminal window
chown $(whoami):$(whoami) inventory/group_vars/all/homepage_api_keys.yml