example.env

# -----------------------------------------------------------------------------
# Poutine environment configuration
# -----------------------------------------------------------------------------
# Copy this file to .env and fill in values before running `docker compose up`.
# TLS / public exposure is the operator's responsibility (Cloudflare Tunnel,
# Caddy, Traefik, nginx, Tailscale Funnel, etc.). Poutine itself serves plain
# HTTP inside its container.

# --- Bundled Navidrome -------------------------------------------------------

# Credentials for the hub's service account on the bundled Navidrome.
# Navidrome auto-creates an "admin" user on first boot from NAVIDROME_PASSWORD
# (via ND_DEVAUTOCREATEADMINPASSWORD in docker-compose.yml), so NAVIDROME_USERNAME
# should stay "admin" unless you've manually renamed that account.
NAVIDROME_USERNAME=admin
NAVIDROME_PASSWORD=foobarbaz

# Host path to your music library. Mounted read-only into the Navidrome
# container at /music. Defaults to ./music if unset.
NAVIDROME_MUSIC_PATH=/Users/nic/Music/

# --- Poutine instance identity -----------------------------------------------

# Stable identifier for this Poutine instance. Used in peer.yaml references
# and in signed federation requests. Pick something memorable and unique, e.g.
# "poutine-alice" or "music.alice.example".
POUTINE_INSTANCE_ID=blacktop

# --- Initial owner account ---------------------------------------------------

# On first boot, if the users table is empty, Poutine seeds a single admin
# account with these credentials. After seeding, these env vars are ignored;
# change the password through the admin UI, not here.
POUTINE_OWNER_USERNAME=nic
POUTINE_OWNER_PASSWORD=local

# --- Artist & album image sources --------------------------------------------

# fanart.tv is the primary source for artist images (when the artist has an
# MBID) and a fallback for album covers (album with a release-group MBID and
# no Navidrome cover). A bundled Poutine project key is used by default, so
# leave these unset unless you want to override.
#
# FANARTTV_API_KEY=                       # override bundled project key
# FANARTTV_CLIENT_KEY=                    # personal key — 2-day vs 7-day delay
# FANARTTV_API_URL=https://webservice.fanart.tv/v3.2

# Last.fm is the fallback for artists WITHOUT an MBID. Optional.
# LASTFM_API_KEY=

# --- Monitoring (New Relic APM, issue #3) ------------------------------------

# Optional. When NEW_RELIC_LICENSE_KEY is set, the hub boots under the New
# Relic Node agent (APM transactions, distributed tracing, event-loop/GC
# metrics, pino logs-in-context). Leave unset to run without any agent.
# The key is a secret — it lives only in .env, never in the repo.
#
# NEW_RELIC_LICENSE_KEY=
# NEW_RELIC_APP_NAME=                     # default: poutine-hub-<POUTINE_INSTANCE_ID>

# --- Sonos casting (issue #108, runtime-toggle #184) ------------------------
# Off by default. Enable/disable from the Admin page at runtime — no env var,
# no restart. Persisted in the `settings` table (`sonos_enabled`,
# `sonos_volume_cap`).
#
# Infrastructure-side prerequisites:
#   1. Start with the Sonos compose override so the hub gets host networking
#      (required for SSDP multicast):
#        docker compose -f docker-compose.yml -f docker-compose.sonos.yml up -d
#   2. In Admin → Sonos, set the LAN URL to the hub's LAN-reachable base URL
#      (e.g. http://192.168.1.10:3000). Devices fetch streams from this URL.
#      Shared with DLNA. Persisted in the `settings` table under `lan_url`
#      (#209). No env var, no restart.

# --- DLNA MediaServer (issue #175) ------------------------------------------
# Off by default. Advertises Poutine as a UPnP MediaServer:1 on the LAN so
# Windows Media Player, Xbox, Kodi, VLC, BubbleUPnP, etc. can browse + stream
# the merged library.
#
# Requires the same host-networking compose override as Sonos
# (SSDP runs on UDP multicast) and the same `lan_url` setting from
# Admin → Sonos.
#
# Auth: DLNA has no concept of users. When enabled, every route under
# /dlna/* is open to anyone on the LAN. Treat this as all-or-nothing
# exposure of the merged library on the local network.
#
# Tunnel hardening: requests arriving via a public tunnel
# (Cloudflare/Caddy/nginx/Tailscale Funnel, …) carry proxy-forwarding
# headers (x-forwarded-for, cf-connecting-ip, forwarded, etc.); the hub
# rejects DLNA requests that carry any of them with 403. Real LAN
# clients (Sonos / WMP / Kodi / VLC) don't set those headers.
#
# DLNA_ENABLED=true
# DLNA_FRIENDLY_NAME=Poutine                  # name clients see in their browsers
# DLNA_PSEUDO_USER=                           # stream attribution; defaults to owner