Skip to content

Environment Variables

Required

VariableDescription
SECRET_KEYRequired. JWT signing secret. Generate with openssl rand -hex 32.

Core

VariableDefaultDescription
WORKERS2Number of uvicorn worker processes. 2–4 is typical; more workers = more memory.
LIBRARY_PATH/app/libraryPath to the library directory inside the container.
DATA_PATH/app/dataPath for the database, thumbnails, and search cache inside the container.
BASE_URLhttp://localhost:9481Public base URL of this instance. Set to your external URL when running behind a reverse proxy — used for OPDS feed links and OIDC redirect URIs.
LOG_LEVELinfoConsole log verbosity: debug, info, warning, error, critical. The in-app Logs tab always captures debug-level entries regardless of this setting.

Optional features

VariableDefaultDescription
VALKEY_URLRedis-compatible cache URL for rendered page images (e.g. redis://valkey:6379/0). Falls back to disk cache when unset.
OPDS_ENABLEDfalseSet to true to enable the OPDS catalog.

Authentication

VariableDescription
ALLOW_PASSWORD_AUTHENTICATIONtrue or false. Pins password authentication on or off, overriding the in-app toggle (which is shown read-only). First-run admin setup always requires a password regardless of this value.

OIDC

Each OIDC setting can be pinned via environment variable. Pinned values are shown read-only in Settings → Authentication.

VariableDescription
OIDC_ENABLEDMaster toggle for OIDC sign-in.
OIDC_ISSUER_URLBase URL of the IdP.
OIDC_TOKEN_ISSUERExact iss value in tokens. Leave blank to auto-detect.
OIDC_AUTHORIZATION_ENDPOINTAuthorization endpoint URL.
OIDC_TOKEN_ENDPOINTToken endpoint URL.
OIDC_USERINFO_ENDPOINTUserinfo endpoint URL.
OIDC_JWKS_URIJWKS URL for ID token signature validation.
OIDC_END_SESSION_ENDPOINTOptional RP-initiated logout endpoint.
OIDC_CLIENT_IDClient ID issued by the IdP.
OIDC_CLIENT_SECRETClient secret issued by the IdP.
OIDC_SIGNING_ALGOne of RS256/RS384/RS512/ES256/ES384/ES512/PS256/PS384/PS512/HS256. Default RS256.
OIDC_BUTTON_TEXTLabel for the SSO button on the login page.
OIDC_GROUPS_CLAIMName of the claim containing group memberships.
OIDC_PERMISSIONS_CLAIMName of the claim containing a permissions object.
OIDC_MATCH_BYnone, email, or username — how to link existing accounts on first OIDC login.
OIDC_AUTO_LAUNCHAutomatically redirect to the IdP when visiting /login.
OIDC_AUTO_REGISTERAutomatically create local accounts on first OIDC login.

Released under the GNU GPL v3.0 License.