Skip to content

Environment Variables

All environment variables are set in the .env file at the root of the project. Copy .env.example to .env to get started.

VariableDescriptionDefault
PORTPort the server listens on3300
DATABASE_URLPath to the SQLite database file./plank.db
DATA_PATHDirectory where downloaded media is saved./data
VariableDescriptionDefault
BETTER_AUTH_SECRETSecret key used for session encryption. Use a random 32+ character string.(none)
BETTER_AUTH_URLBase URL of your Plank instancehttp://localhost:3300
VariableDescriptionDefault
TMDB_API_KEYAPI key for The Movie Database. Get one at themoviedb.org/settings/api.(none)
VariableDescriptionDefault
PROWLARR_URLURL of your Prowlarr instancehttp://localhost:9696
PUBLIC_PROWLARR_URLPublic-facing Prowlarr URL (if behind a reverse proxy)Same as PROWLARR_URL
PROWLARR_API_KEYProwlarr API key. Auto-configured in Docker — leave blank.(none)
VariableDescriptionDefault
OPENSUBTITLES_API_KEYAPI key from opensubtitles.com/consumers(none)
OPENSUBTITLES_USERNAMEYour OpenSubtitles username(none)
OPENSUBTITLES_PASSWORDYour OpenSubtitles password(none)

These are set in docker-compose.yml and generally don’t need to be changed.

VariableDescriptionDefault
HOSTBind address0.0.0.0
ORIGINPublic URL for CSRF protectionhttp://localhost:3300
PROWLARR_CONFIG_PATHPath to Prowlarr config inside the container/prowlarr-config/config.xml
FLARESOLVERR_URLFlareSolverr URLhttp://flaresolverr:8191
MEDIA_PATHHost path for media library mount./media
TZTimezone for containersAmerica/New_York
VariableDescriptionDefault
ENABLE_FILE_STORAGESave downloaded files to disk. Reserved for future use.true