.env.example

# Questarr Environment Configuration Template -- Used for NPM run (not for docker)
# All env variables are optional. Default values will be used if not provided.
# Uncomment a variable if needed and set your desired value.

# --- Authentication ---
# Optional.
# If not provided, a secure random secret will be generated and stored in the database.
# Set this to a long random string to keep sessions valid across server restarts.
# JWT_SECRET=change-this-to-a-secure-random-string

# --- Credentials Encryption ---
# Optional. Encrypts stored indexer/downloader API keys, usernames, and passwords at rest.
# If not provided, a secure random key will be generated and stored in the database.
# Must be a 64-character hex string (32 bytes) if set -- e.g. `openssl rand -hex 32`.
# CREDENTIALS_ENCRYPTION_KEY=

# --- Nexus Mods API Configuration ---
# Optional. Required to check if a game has a section on NexusMods and display trending mods.
# Get your personal API key at https://www.nexusmods.com/users/myaccount?tab=api
# If not set here, the app will ask for it in Settings → Services.
# Rate limits: 500 requests/hour, 20,000 requests/day.
# NEXUSMODS_API_KEY=your_nexusmods_api_key

# --- IGDB API Configuration ---
# Required for game discovery and metadata features.
# If not set here, the app will ask for it.
# Get credentials by registering an app at https://dev.twitch.tv/console
# IGDB_CLIENT_ID=your_igdb_client_id
# IGDB_CLIENT_SECRET=your_igdb_client_secret

# --- Steam Web API Configuration ---
# Optional. Required only for the Steam achievements section in a game's Journal tab
# (wishlist import and app-ID lookup do not need it).
# Get a key at https://steamcommunity.com/dev/apikey
# STEAM_API_KEY=your_steam_web_api_key

# --- Server Configuration ---
# Optional: Port to run the server on (default: 5000)
# PORT=5000
# Optional: Host to bind the server to (default: 0.0.0.0, all interfaces -- same for npm and docker)
# Set to 127.0.0.1 if you only want the app reachable via a local reverse proxy.
# HOST=127.0.0.1
# Optional: Node environment (development, production, test) --> Defaults to production
# NODE_ENV=development
# Dev/test only: set to true to switch off the API rate limiters (used by the e2e harness,
# `npm run dev:test`). Ignored unless NODE_ENV is development or test.
# DISABLE_RATE_LIMITS=true
# Optional: Database path (default: sqlite.db)
# SQLITE_DB_PATH=data/sqlite.db

# --- Database backend -------------------------------------------------------
# Questarr uses SQLite by default and needs no configuration for it.
# Leave the two variables below unset unless you are deliberately running
# Postgres. SQLITE_DB_PATH above is ignored when DB_DIALECT=postgres.
# Switching an existing SQLite install to Postgres does not move your data on
# its own -- see docs/DATABASE.md for the migration script.
# DB_DIALECT=postgres
# DATABASE_URL=postgres://questarr:password@localhost:5432/questarr
# Optional: connection pool size (default: 10)
# DATABASE_POOL_MAX=10
# Optional: Serve the app from a subdirectory behind a reverse proxy
# (e.g. https://xxx.domain.com/Questarr). Leading slash, no trailing slash.
# See docs/REVERSE_PROXY.md for full setup instructions.
# QUESTARR_BASE_PATH=/Questarr