Homepage
Using Homepage
Section titled “Using Homepage”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.
Available Manual API Key Settings
Section titled “Available Manual API Key Settings”| Service | Variable | Notes |
|---|---|---|
| NZBGet | homepage_nzbget_username + homepage_nzbget_password |
Uses NZBGet’s ControlUsername/ControlPassword (defaults to the linuxserver image defaults). Set to empty strings if you disabled NZBGet authentication. |
| Authentik | homepage_authentik_key |
See Authentik widget docs |
| Portainer | homepage_portainer_key |
|
| Jellyfin | homepage_jellyfin_key |
|
| Emby | homepage_emby_key |
|
| Autobrr | 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 |
|
| 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 |
File Security
Section titled “File Security”It is highly recommended to ensure the permissions and ownership of this file is locked down. You can do this by running:
chmod 0600 inventory/group_vars/all/homepage_api_keys.ymlchown $(whoami):$(whoami) inventory/group_vars/all/homepage_api_keys.yml