Skip to content
Pocket Homelab
Get the app

Environment keys

The complete list of configuration keys Pocket Homelab reads, with the field titles, whether they are secret, and where to find each value.

iPhoneMac
On this page

Download all keys as a blank env template, then follow the setup and import instructions. Fill only the services you use; every value in the download is empty.

How keys work

Every key is UPPER_SNAKE_CASE and belongs to a service group, one row in Settings → Services, and one slot on the free plan. The app maps each key to a field with a title, a placeholder, a hint about where to find the value, and a secret flag that decides whether the field is masked.

  • A group counts as configured once its URL is set, or, for key-only groups, once any key is set. An empty URL hides that service everywhere: no Home card, no tab, no search entry, no browser link, no quick action.
  • Keys ending in _URL are normalised: trailing slashes are removed, and the value must have an http/https scheme and a host.
  • Keys the app does not recognise are preserved on import and export, so your file round-trips.
  • Secret fields (marked below) are masked in the form until you press the eye button beside them to reveal the value. Like every key, they are stored in the Keychain.
  • This table does not mark individual keys Required, that depends on the combination you choose (a status page slug or an API key for Kuma, for example). Each service’s own page spells out the minimum.

The env file format

Settings accepts the same format as the Homelab Raycast extension, plain KEY=value lines:

# Lines starting with # are ignored, as are blank lines.
KUMA_URL=https://kuma.example.com
KUMA_API_KEY=uk1234…            # trailing comments after " # " are stripped from unquoted values
export NEXTCLOUD_URL="https://cloud.example.com"
NEXTCLOUD_APP_PASSWORD="ABCDE-FGHIJ-KLMNO-PQRST"
  • A leading export is dropped, and matching single or double quotes around a value are stripped, quoting is optional except where a value itself contains spaces, # or a tab.
  • Trailing slashes are removed from every …_URL value.
  • Leaving a service’s URL empty (or removing its line) hides that service everywhere, the same as switching it off in Settings.

See Connect your services for the full import flow (paste vs. Files picker, merge vs. replace).

Server

See the Server page for what this unlocks.

Environment keys
KeyFieldRequiredSecretWhere to get it
GLANCES_URLGlances URLOptional—Base URL of your Glances instance. Leave empty to hide Glances features.
STORAGE_MOUNTExtra Mount PointOptional—A second filesystem from Glances to show next to / (e.g. a data SSD). Leave empty to show only the root filesystem.
TEMPS_URLTemperatures JSON URLOptional—Optional URL of a temps.json published by the companion temps-publish script (server CPU/disk + NAS disk temps).

See the Links page for what this unlocks.

Environment keys
KeyFieldRequiredSecretWhere to get it
HOMEPAGE_URLDashboard URLOptional—Optional link to your dashboard (Homepage, Dashy…), shown with the other browser links on Home and in the Mac Server page's Open in browser menu.

TrueNAS

See the TrueNAS page for what this unlocks.

Environment keys
KeyFieldRequiredSecretWhere to get it
TRUENAS_URLTrueNAS URLOptional—Base URL of your TrueNAS instance. Leave empty to hide TrueNAS features.
TRUENAS_API_KEYTrueNAS API KeyOptionalSecretRead-only key is enough (pool capacity + health). Leave empty to hide the NAS row.

qBittorrent

See the qBittorrent page for what this unlocks.

Environment keys
KeyFieldRequiredSecretWhere to get it
QBIT_URLqBittorrent URLOptional—Base URL of your qBittorrent instance. Leave empty to hide qBittorrent features.
QBIT_USERNAMEqBittorrent UsernameOptional—Web UI username.
QBIT_PASSWORDqBittorrent PasswordOptionalSecretWeb UI password. Never attempted while empty (qBittorrent IP-bans after 5 failures).

SABnzbd

See the SABnzbd page for what this unlocks.

Environment keys
KeyFieldRequiredSecretWhere to get it
SABNZBD_URLSABnzbd URLOptional—Base URL of your SABnzbd instance. Leave empty to hide SABnzbd features.
SABNZBD_API_KEYSABnzbd API KeyOptionalSecretConfig → General → API Key.

Nzbget

See the Nzbget page for what this unlocks.

Environment keys
KeyFieldRequiredSecretWhere to get it
NZBGET_URLNZBget URLOptional—Base URL of your NZBget instance. Leave empty to hide NZBget features.
NZBGET_USERNAMENZBget UsernameOptional—Settings → Security → ControlUsername.
NZBGET_PASSWORDNZBget PasswordOptionalSecretSettings → Security → ControlPassword.

slskd

See the slskd page for what this unlocks.

Environment keys
KeyFieldRequiredSecretWhere to get it
SLSKD_URLslskd URLOptional—Base URL of your slskd instance. Leave empty to hide slskd features.
SLSKD_API_KEYslskd API KeyOptionalSecretOptions → Web → Authentication → API keys.

Jellyfin

See the Jellyfin page for what this unlocks.

Environment keys
KeyFieldRequiredSecretWhere to get it
JELLYFIN_URLJellyfin URLOptional—Base URL of your Jellyfin instance. Leave empty to hide Jellyfin features.
JELLYFIN_API_KEYJellyfin API KeyOptionalSecretDashboard → API Keys.
JELLYFIN_USER_IDJellyfin User IDOptional—Optional. Whose Continue Watching / Next Up to show; defaults to the first administrator.

Jellyseerr

See the Jellyseerr page for what this unlocks.

Environment keys
KeyFieldRequiredSecretWhere to get it
JELLYSEERR_URLJellyseerr URLOptional—Base URL of your Jellyseerr instance. Leave empty to hide Jellyseerr features.
JELLYSEERR_API_KEYJellyseerr API KeyOptionalSecretSettings → General → API Key (admin).

Radarr

See the Radarr page for what this unlocks.

Environment keys
KeyFieldRequiredSecretWhere to get it
RADARR_URLRadarr URLOptional—Base URL of your Radarr instance. Leave empty to hide Radarr features.
RADARR_API_KEYRadarr API KeyOptionalSecretSettings → General.

Sonarr

See the Sonarr page for what this unlocks.

Environment keys
KeyFieldRequiredSecretWhere to get it
SONARR_URLSonarr URLOptional—Base URL of your Sonarr instance. Leave empty to hide Sonarr features.
SONARR_API_KEYSonarr API KeyOptionalSecretSettings → General.

Lidarr

See the Lidarr page for what this unlocks.

Environment keys
KeyFieldRequiredSecretWhere to get it
LIDARR_URLLidarr URLOptional—Base URL of your Lidarr instance. Leave empty to hide Lidarr features.
LIDARR_API_KEYLidarr API KeyOptionalSecretSettings → General.

Chaptarr / Readarr

See the Chaptarr / Readarr page for what this unlocks.

Environment keys
KeyFieldRequiredSecretWhere to get it
CHAPTARR_URLChaptarr / Readarr URLOptional—Base URL of your Chaptarr / Readarr instance. Leave empty to hide Chaptarr / Readarr features.
CHAPTARR_API_KEYChaptarr / Readarr API KeyOptionalSecretSettings → General (any Readarr-compatible fork).

Prowlarr

See the Prowlarr page for what this unlocks.

Environment keys
KeyFieldRequiredSecretWhere to get it
PROWLARR_URLProwlarr URLOptional—Base URL of your Prowlarr instance. Leave empty to hide Prowlarr features.
PROWLARR_API_KEYProwlarr API KeyOptionalSecretSettings → General.

Subtitles

Covers Bazarr and the Subtitle Sync Server. See the Bazarr and Subtitle Sync Server pages for what this unlocks.

Environment keys
KeyFieldRequiredSecretWhere to get it
BAZARR_URLBazarr URLOptional—Base URL of your Bazarr instance. Leave empty to hide Bazarr features.
BAZARR_API_KEYBazarr API KeyOptionalSecretSettings → General.
SUBSYNC_URLSubtitle Sync Server URLOptional—Base URL of your Subtitle Sync Server instance. Leave empty to hide Subtitle Sync Server features.

Audiobookshelf

See the Audiobookshelf page for what this unlocks.

Environment keys
KeyFieldRequiredSecretWhere to get it
ABS_URLAudiobookshelf URLOptional—Base URL of your Audiobookshelf instance. Leave empty to hide Audiobookshelf features.
ABS_TOKENAudiobookshelf API TokenOptionalSecretSettings → Users → your user → API token.

See the Navidrome page for what this unlocks.

Environment keys
KeyFieldRequiredSecretWhere to get it
NAVIDROME_URLNavidrome URLOptional—Base URL of your Navidrome instance. Leave empty to hide Navidrome features.
NAVIDROME_USERNavidrome UsernameOptional—Any user; Subsonic token auth is used.
NAVIDROME_PASSWORDNavidrome PasswordOptionalSecretPassword of that user.

Immich

See the Immich page for what this unlocks.

Environment keys
KeyFieldRequiredSecretWhere to get it
IMMICH_URLImmich URLOptional—Base URL of your Immich instance. Leave empty to hide Immich features.
IMMICH_API_KEYImmich API KeyOptionalSecretAccount Settings → API Keys.

Calibre-Web

See the Calibre-Web page for what this unlocks.

Environment keys
KeyFieldRequiredSecretWhere to get it
CALIBRE_URLCalibre-Web URLOptional—Base URL of your Calibre-Web instance. Leave empty to hide Calibre-Web features.
CALIBRE_USERCalibre-Web UsernameOptional—Used for OPDS + Send-to-Kindle.
CALIBRE_PASSWORDCalibre-Web PasswordOptionalSecretPassword of that user.

Paperless

See the Paperless page for what this unlocks.

Environment keys
KeyFieldRequiredSecretWhere to get it
PAPERLESS_URLPaperless URLOptional—Base URL of your Paperless-ngx instance. Leave empty to hide Paperless features.
PAPERLESS_TOKENPaperless API TokenOptionalSecretYour Paperless profile → API Auth Token. Documents must be visible to this user.

MeTube

See the MeTube page for what this unlocks.

Environment keys
KeyFieldRequiredSecretWhere to get it
METUBE_URLMeTube URLOptional—Base URL of your MeTube instance. Leave empty to hide MeTube features.
METUBE_FOLDERSMeTube DestinationsOptional—Comma-separated extra folders as folder|Label[|video]. Add |video to download video instead of opus audio. Example: music|Music,clips|Clips|video

Uptime Kuma

See the Uptime Kuma page for what this unlocks.

Environment keys
KeyFieldRequiredSecretWhere to get it
KUMA_URLUptime Kuma URLOptional—Base URL of your Uptime Kuma instance. Leave empty to hide Uptime Kuma features.
KUMA_STATUS_SLUGUptime Kuma Status Page SlugOptional—Slug of a public status page (used when no API key is set).
KUMA_API_KEYUptime Kuma API KeyOptionalSecretSettings → API Keys. With a key every monitor is read from /metrics, not just the status page.

ntfy

See the ntfy page for what this unlocks.

Environment keys
KeyFieldRequiredSecretWhere to get it
NTFY_URLntfy URLOptional—Base URL of your ntfy instance. Leave empty to hide ntfy features.
NTFY_TOPICSntfy TopicsOptional—Comma-separated topics to read.

AdGuard Home

See the AdGuard Home page for what this unlocks.

Environment keys
KeyFieldRequiredSecretWhere to get it
ADGUARD_URLAdGuard Home URLOptional—Base URL of your AdGuard Home instance. Leave empty to hide AdGuard Home features.
ADGUARD_USERNAMEAdGuard Home UsernameOptional—Web UI username.
ADGUARD_PASSWORDAdGuard Home PasswordOptionalSecretWeb UI password.

Komodo

See the Komodo page for what this unlocks.

Environment keys
KeyFieldRequiredSecretWhere to get it
KOMODO_URLKomodo URLOptional—Base URL of your Komodo instance. Leave empty to hide Komodo features.
KOMODO_API_KEYKomodo API KeyOptionalSecretSettings → Profile → API keys.
KOMODO_API_SECRETKomodo API SecretOptionalSecretShown once when the key is created.

Services & Jobs (SSH)

Mac only, not shown in the iPhone Services list. See the Services & Jobs over SSH page for what this unlocks.

Environment keys
KeyFieldRequiredSecretWhere to get it
SERVICES_SSH_HOSTServices SSH HostOptional—SSH destination for Services & Jobs: user@host or an alias from ~/.ssh/config. Uses noninteractive key or agent authentication and a previously trusted host key. Leave empty to disable.
SERVICES_SSH_PORTServices SSH PortOptional—Optional SSH port (1–65535). Leave empty to use your SSH configuration or port 22.
SERVICES_SSH_IDENTITY_FILEServices SSH Identity FileOptional—Optional path to your local SSH private key; ~/ is supported. Leave empty to use your SSH configuration or agent. Enter a file path, never the key itself.

Backrest

See the Backrest page for what this unlocks.

Environment keys
KeyFieldRequiredSecretWhere to get it
BACKREST_URLBackrest URLOptional—Base URL of your Backrest instance. Leave empty to hide Backrest features.
BACKREST_USERNAMEBackrest UsernameOptional—Web UI username.
BACKREST_PASSWORDBackrest PasswordOptionalSecretWeb UI password.
BACKREST_GRACE_HOURSBackup Freshness Grace (Hours)Optional—Extra time beyond each backup/check schedule before it is overdue. Defaults to 2 hours. Manual plans have no deadline.

Scrutiny

See the Scrutiny page for what this unlocks.

Environment keys
KeyFieldRequiredSecretWhere to get it
SCRUTINY_URLScrutiny URLOptional—Base URL of your Scrutiny instance. Leave empty to hide Scrutiny features.

Speedtest Tracker

See the Speedtest Tracker page for what this unlocks.

Environment keys
KeyFieldRequiredSecretWhere to get it
SPEEDTEST_URLSpeedtest Tracker URLOptional—Base URL of your Speedtest Tracker instance. Leave empty to hide Speedtest Tracker features.

Money

Covers Firefly III, Firefly Pico and the subscriptions summary. See the Firefly III and Firefly Pico pages for what this unlocks.

Environment keys
KeyFieldRequiredSecretWhere to get it
FIREFLY_URLFirefly III URLOptional—Base URL of your Firefly III instance. Leave empty to hide Firefly III features.
FIREFLY_TOKENFirefly III Personal Access TokenOptionalSecretOptions → Profile → OAuth → Personal Access Tokens.
PICO_URLFirefly Pico URLOptional—Base URL of your Firefly Pico instance. Leave empty to hide Firefly Pico features.
SUBSCRIPTIONS_URLSubscriptions JSON URLOptional—Optional URL of a subscriptions.json published by the companion firefly-sub-publish script (upcoming bills summary).

Forgejo

See the Forgejo page for what this unlocks.

Environment keys
KeyFieldRequiredSecretWhere to get it
FORGEJO_URLForgejo / Gitea URLOptional—Base URL of your Forgejo / Gitea instance. Leave empty to hide Forgejo / Gitea features.
FORGEJO_TOKENForgejo / Gitea Access TokenOptionalSecretSettings → Applications → Generate token, with read/write on repository, issue and notification. Unlocks the Code screen (repos, pull requests, reviews, Actions).

Nextcloud

See the Nextcloud page for what this unlocks.

Environment keys
KeyFieldRequiredSecretWhere to get it
NEXTCLOUD_URLNextcloud URLOptional—Base URL of Nextcloud, including its subpath if any.
NEXTCLOUD_USERNAMENextcloud UsernameOptional—Your Nextcloud user ID (not display name).
NEXTCLOUD_APP_PASSWORDNextcloud App PasswordOptionalSecretCreate an app password in Nextcloud → Personal settings → Security.

LubeLogger

See the LubeLogger page for what this unlocks.

Environment keys
KeyFieldRequiredSecretWhere to get it
LUBELOGGER_URLLubeLogger URLOptional—Base URL of your LubeLogger instance, e.g. https://lubelogger.example.org
LUBELOGGER_USERNAMELubeLogger UsernameOptional—Only needed if your LubeLogger requires a login (basic auth)
LUBELOGGER_PASSWORDLubeLogger PasswordOptionalSecretOnly needed if your LubeLogger requires a login (basic auth)
LUBELOGGER_CURRENCYVehicle CurrencyOptional—Currency used for vehicle costs and linked payments. Defaults to BAM. Changing it does not convert existing amounts.
LUBELOGGER_DISTANCE_UNITDistance Unit LabelOptional—Defaults to km
LUBELOGGER_VOLUME_UNITFuel Volume Unit LabelOptional—Defaults to L
LUBELOGGER_VEHICLE_IDDefault Vehicle IDOptional—Which vehicle the Home row summarises when you have several
LUBELOGGER_DECIMALLubeLogger Decimal SeparatorOptional—How LubeLogger's server locale parses numbers. Auto-detects from its own data.

SearXNG

See the SearXNG page for what this unlocks.

Environment keys
KeyFieldRequiredSecretWhere to get it
SEARXNG_URLSearXNG URLOptional—Base URL of your SearXNG instance (JSON API enabled). Leave empty to hide web search.

Jellystat

See the Jellystat page for what this unlocks.

Environment keys
KeyFieldRequiredSecretWhere to get it
JELLYSTAT_URLJellystat URLOptional—Base URL of your Jellystat instance. Leave empty to hide watch statistics.
JELLYSTAT_API_KEYJellystat API KeyOptionalSecretJellystat → Settings → API Keys.

PinePods

See the PinePods page for what this unlocks.

Environment keys
KeyFieldRequiredSecretWhere to get it
PINEPODS_URLPinePods URLOptional—Base address of your PinePods server.
PINEPODS_API_KEYPinePods API keyOptionalSecretYour user API key from PinePods settings. Stored in the Keychain.

Exporting

The app never writes a plain env file. Its only export is Move to another device (iPhone: Settings → Move & restore; Mac: Settings → Move & Restore), which seals every key above in the same KEY=value format behind a passphrase you choose. Import configuration on the other device opens it with that passphrase. See Move to another device.