# Configuration keys

Every key in `config/config.conf.template`. Copy the template to `config/config.conf` on the dev Mac and set the values before you run `prep-airdrop.sh`.

## Server identity

| Key | Default | Description |
| --- | --- | --- |
| `SERVER_NAME` | `MACMINI` | Server hostname; lowercased for .local names and file names<br>No spaces. It is also the system volume name, unless HOSTNAME\_OVERRIDE is set<br>The package folder and keychain services always use it (\~/macmini-setup, pia-account-macmini) |
| `OPERATOR_USERNAME` | `operator` | Service account that runs the media apps and auto-logs in<br>Full name "\<SERVER\_NAME\> Operator" and admin group membership; first-boot.sh sets both |

## 1Password configuration

| Key | Default | Description |
| --- | --- | --- |
| `OP_VAULT_ID` | `your-vault-id` | Required. 1Password vault, by ID so a rename cannot break it (op vault list) |
| `ONEPASSWORD_VAULT` | `${OP_VAULT_ID}` | Required. Vault that prep-airdrop.sh reads the items below from<br>There is no default: prep-airdrop.sh stops if it is empty |
| `ONEPASSWORD_OPERATOR_ITEM` | `Mac Mini operator` | Login item: operator password (created if missing) |
| `ONEPASSWORD_TIMEMACHINE_ITEM` | `TimeMachine NAS` | Login item: Time Machine share credentials (URL in the item) |
| `ONEPASSWORD_PLEX_NAS_ITEM` | `Plex NAS` | Login item: media NAS credentials |
| `ONEPASSWORD_APPLEID_ITEM` | `Apple` | Favorite Login item: Apple Account for the server |
| `ONEPASSWORD_OPENSUBTITLES_ITEM` | `Opensubtitles` | Login item: OpenSubtitles account for FileBot |

## Monitoring

| Key | Default | Description |
| --- | --- | --- |
| `MONITORING_EMAIL` | `your-email@example.com` | Where alert email goes<br>If it is empty or still this example, msmtp-setup.sh and plex-watchdog-setup.sh ask for it and write it to the server's copy of config.conf |

## Media NAS configuration

| Key | Default | Description |
| --- | --- | --- |
| `NAS_HOSTNAME` | `nas.local` | Media NAS hostname |
| `NAS_USERNAME` | `plex` | NAS account that owns the media share |
| `NAS_SHARE_NAME` | `Media` | NFS share name on the NAS |
| `NAS_VOLUME` | `volume2` | Synology volume name for NFS export path (use showmount -e to verify) |

## Plex migration configuration (optional)

| Key | Default | Description |
| --- | --- | --- |
| `PLEX_MIGRATE_FROM` | (empty) | Not read by any script yet<br>To migrate from an earlier Plex server, run plex-setup.sh --migrate-from HOST |

## Dropbox configuration (optional)

If you want to sync a specific Dropbox folder to the server

| Key | Default | Description |
| --- | --- | --- |
| `DROPBOX_SYNC_FOLDER` | (empty) | Dropbox folder to sync (e.g., "Private/ServerSync")<br>When set, prep-airdrop.sh runs the Dropbox sign-in (rclone-airdrop-prep.sh) |
| `DROPBOX_LOCAL_PATH` | (empty) | Local path where to sync (default: \~/.local/sync/dropbox) |
| `DROPBOX_SYNC_INTERVAL` | `30` | Sync interval in minutes (default: 30) |

## FileBot license file (optional)

| Key | Default | Description |
| --- | --- | --- |
| `FILEBOT_LICENSE_FILE` | (empty) | Absolute path on the source machine (where you are running prep-airdrop) to your FileBot license file |

## Catch feeds URL (optional)

| Key | Default | Description |
| --- | --- | --- |
| `CATCH_FEEDS_URL` | (empty) | from ShowRSS or your preferred RSS provider |

## Catch history cutoff (optional)

| Key | Default | Description |
| --- | --- | --- |
| `CATCH_HISTORY_CUTOFF_DAYS` | `7` | Number of days back to prevent re-downloading old torrents<br>Set to 0 to disable history cutoff (will download all available) |

## Terminal configuration (optional)

These settings improve terminal accessibility with better colors and fonts

| Key | Default | Description |
| --- | --- | --- |
| `TERMINAL_PROFILE_FILE` | (empty) | Terminal.app profile file (.terminal format)<br>File name only; put the file in config/ next to config.conf |
| `USE_ITERM2` | `false` | Set to "true" to copy complete iTerm2 preferences from development machine<br>When USE\_ITERM2 is "true", your entire iTerm2 configuration (profiles, settings, etc.) will be copied to the server during prep-airdrop and imported during first-boot<br>Set TERMINAL\_PROFILE\_FILE for Terminal.app profile, or leave empty to skip |

## VPN and Transmission configuration (optional)

Used by podman-transmission-setup.sh to configure the containerized Transmission stack

| Key | Default | Description |
| --- | --- | --- |
| `ONEPASSWORD_PIA_ITEM` | (empty) | 1Password item name holding PIA account credentials |
| `PIA_VPN_REGION` | `ca_vancouver` | PIA region for haugene (must match /etc/openvpn/pia/ stem, NOT the API region id)<br>Must support port forwarding — panama advertises it but serves none (issue \#159)<br>Measured 2026-08-23: vancouver 14.6ms/17.2MB/s vs toronto 63.2ms/2.4MB/s |
| `LAN_SUBNET` | `192.168.1.0/24` | Local network CIDR for Transmission web UI access |
| `TRANSMISSION_HOST_PORT` | `9091` | Host port for Transmission web UI |

## Catch magnet handling (optional)

| Key | Default | Description |
| --- | --- | --- |
| `CATCH_USE_MAGNETS` | `true` | Not read by any script yet. Magnet links reach the container through TransmissionMagnetHandler.app; set Catch's own preference in the app. |

## External access (Cloudflare DDNS)

| Key | Default | Description |
| --- | --- | --- |
| `EXTERNAL_HOSTNAME` | (empty) | Public hostname (e.g. example.com) |
| `CLOUDFLARE_ZONE_ID` | (empty) | Cloudflare zone ID for external hostname |
| `CLOUDFLARE_RECORD_ID` | (empty) | ID of the A record DDNS updates (vpn.example.com since the tunnel cutover) |
| `DDNS_RECORD_NAME` | (empty) | Name of that record, for log lines (default: EXTERNAL\_HOSTNAME) |

## Cloudflare Tunnel + Access (docs/components/cloudflare-tunnel.md)

The ids are not secrets. Copy them from the Zero Trust dashboard or the API.

| Key | Default | Description |
| --- | --- | --- |
| `TUNNEL_METRICS_PORT` | `20241` | cloudflared /ready and /metrics, on 127.0.0.1 only |
| `CLOUDFLARE_ACCOUNT_ID` | (empty) | Account that holds the Access application |
| `CLOUDFLARE_ACCESS_APP_ID` | (empty) | Access application for EXTERNAL\_HOSTNAME |
| `CLOUDFLARE_ACCESS_POLICY_ID` | (empty) | The one reusable Allow policy attached to it |
| `CLOUDFLARE_ACCESS_IDP_ID` | (empty) | The only identity provider the application allows |
| `ACCESS_ALLOWED_EMAIL` | (empty) | The only email the policy allows; Caddy tunnel site checks it too |
| `CLOUDFLARE_TUNNEL_ID` | (empty) | Remotely managed tunnel; the watchdog checks its ingress |
| `CLOUDFLARE_ACCESS_TEAM_NAME` | (empty) | Zero Trust team name (\<team\>.cloudflareaccess.com) |
| `CLOUDFLARE_ACCESS_AUD_TAG` | (empty) | The Access application AUD tag (64 hex characters) |

## Plex → TVmaze watched sync (docs/components/tvmaze-scrobble.md)

The API key is not here: it is read from the admin keychain (service tvmaze-\<host\>, account TVMAZE\_USERNAME) by tvmaze-scrobble-setup.sh.

| Key | Default | Description |
| --- | --- | --- |
| `TVMAZE_USERNAME` | (empty) | TVmaze username (NOT the email; TVmaze rejects the email) |
| `PLEX_ACCOUNT_TITLE` | (empty) | Plex account name whose plays sync (webhook Account.title) |
| `PLEX_ACCOUNT_ID` | `1` | Same account's server-local id in Plex watch history (owner is 1) |
| `TVMAZE_SCROBBLE_PORT` | `32599` | Webhook listener, on 127.0.0.1 only |

## Caddy reverse proxy configuration

| Key | Default | Description |
| --- | --- | --- |
| `SERVER_LAN_IP` | (empty) | Server's static LAN IP (e.g. 192.168.21.10) |
| `BASICAUTH_USERNAME` | (empty) | Basic auth username for external access |
| `BASICAUTH_HASH` | (empty) | bcrypt hash of password (generate with: caddy hash-password) |

## Optional dashboard links, such as your NAS admin pages

Each link is a redirect from /PATH on this server to its URL, and a link on the dashboard.  
A link with an empty URL is left out. caddy-setup.sh stops on a bad value.

| Key | Default | Description |
| --- | --- | --- |
| `HOME_LINKS_TITLE` | `Links` | Dashboard heading over the links |
| `HOME_LINK1_NAME` | (empty) | Link 1 label: letters, digits, spaces, '.', '\_' and '-' |
| `HOME_LINK1_PATH` | (empty) | Link 1 path on the server: letters, digits and '-' (e.g. nas) |
| `HOME_LINK1_URL` | (empty) | Link 1 target, https only (e.g. `https://nas.example.com:5001`) |
| `HOME_LINK2_NAME` | (empty) | Link 2 label |
| `HOME_LINK2_PATH` | (empty) | Link 2 path; not the same as link 1, not transmission or media |
| `HOME_LINK2_URL` | (empty) | Link 2 target, https only |

## Optional Home Assistant through the tunnel (docs/components/cloudflare-tunnel.md)

Its own hostname behind the same Access application. Set both keys, or leave both empty (off). caddy-setup.sh and access-policy-watchdog-setup.sh stop on a bad value.

| Key | Default | Description |
| --- | --- | --- |
| `HOME_ASSISTANT_HOSTNAME` | (empty) | A subdomain of EXTERNAL\_HOSTNAME, lower case (e.g. ha.example.com) |
| `HOME_ASSISTANT_UPSTREAM` | (empty) | Home Assistant as host:port; an IP is fastest (e.g. 192.168.21.20:8123) |

## Optional overrides (leave empty to use defaults)

| Key | Default | Description |
| --- | --- | --- |
| `HOSTNAME_OVERRIDE` | (empty) | If different from SERVER\_NAME<br>Sets the hostname, .local name and volume name, for example when SERVER\_NAME clashes on your LAN<br>The package folder, keychain services and operator full name still use SERVER\_NAME |
