Skip to content

Environment variables

Use the web UI for most settings. Use these variables for Docker deployment settings.

VariablePurpose
PUID / PGIDRun the container as the user that owns mounted folders.
AURRAL_DATA_DIROverride app data directory. Default /config.
DOWNLOAD_FOLDERInitial Downloads Folder path. Prefer Settings > Download Clients > Downloads Folder > Path. Use an absolute path under your media mount.
VariablePurpose
PATH_MAPPINGSTranslate paths for mixed Windows and Docker setups. Use the format remote|local. Separate multiple mappings with ;. To limit a mapping to one source, use source|remote|local. Aurral applies these mappings at runtime. Edit them under Settings > Download Clients > Remote Path Mappings.
M3U_PATH_MODElocal (default, Aurral paths in .m3u files) or remote (paths Navidrome can open).
M3U_PATH_MAPPINGSTranslate Navidrome playlist paths. Use the format Aurral path|Navidrome path. Separate multiple mappings with ;. Aurral applies these mappings at runtime. The UI does not show them.
VariablePurpose
TRUST_PROXYSet when Aurral is behind a reverse proxy.
AUTH_PROXY_ENABLEDEnable reverse-proxy authentication. Default header x-forwarded-user.
AUTH_PROXY_HEADERCustom header that contains the authenticated username.
AUTH_PROXY_DOMAINOrigin of your forwardAuth login page (for example, https://auth.example.com). Authelia-style setups need this value. It lets CSP permit the login redirect and complete session reauthentication.
AUTH_PROXY_TRUSTED_IPSComma-separated proxy IP allowlist for authentication headers. You must set it when you enable proxy authentication. Without it, a direct client can use the identity header to impersonate users.
AUTH_PROXY_LOGOUT_URLYour proxy or IdP logout endpoint. For Authentik single-application forward auth, use https://aurral.example.com/outpost.goauthentik.io/sign_out. This value ends the proxy session when you log out of Aurral.
AUTH_PROXY_DEFAULT_ROLERole for proxy-auth users who do not otherwise have the admin role: user or admin. Aurral evaluates the role on every request.
AUTH_PROXY_ADMIN_USERSComma-separated usernames that get the admin role. Aurral checks the list on each request. If you remove a username, Aurral changes that user on the next request.
AUTH_PROXY_ROLE_HEADEROptional header that contains the user’s group membership (for example, Authelia’s Remote-Groups). Usually, this is a comma-separated list. Aurral compares it with AUTH_PROXY_ADMIN_GROUPS on every request.
AUTH_PROXY_ADMIN_GROUPSComma-separated group names that give the admin role. Aurral compares these names with AUTH_PROXY_ROLE_HEADER. A group named admin has no special function unless you list it here.
SESSION_EXPIRY_HOURSPassword-login session lifetime in hours. Default 720 (30 days).
VariablePurpose
AURRAL_VERBOSE_LOGSDetailed server logs for problem analysis.
VariablePurpose
AURRAL_IMAGE_PROXY_MAX_BYTESMaximum image-proxy disk-cache size in bytes. The default is 268435456 (256MB). Aurral removes the oldest entries first. When Aurral serves an image, it updates the age of that image.
VariablePurpose
AURRAL_LASTFM_TIMEOUT_MSLast.fm API timeout in milliseconds. Default 15000. Increase this value if focus playlists have no tracks and logs show ECONNABORTED.

These variables change the shared Lidarr Spotify OAuth proxy. The default values are correct for most installations.

VariablePurpose
SPOTIFY_CLIENT_IDOAuth client ID.
SPOTIFY_OAUTH_REDIRECT_URIAuthorization redirect. Default https://spotify.lidarr.audio/auth.
SPOTIFY_OAUTH_RENEW_URIToken refresh endpoint. Default https://spotify.lidarr.audio/renew.
environment:
- PUID=1000
- PGID=1000
- TRUST_PROXY=true

For mounts and path mappings, see Match Lidarr.