# Where DVinyl keeps its data: one SQLite file. The default suits Docker, where data/ is # the folder docker-compose mounts; set this only to keep the file somewhere else. # SQLITE_PATH=/app/data/dvinyl.sqlite # In a container, DVinyl refuses to start while that folder is not mounted from the host, # since everything in it would be lost the next time the container is recreated. Set this # only for an instance whose data is meant to be thrown away, such as a demo. # EPHEMERAL_DATA=true # Where automatic backups go is chosen on the Instance admin page (Backup tab). Set this # only to fix the folder from the server: it takes priority and locks that field. # BACKUP_DIR=/backups # Below this much free disk space, in MB, copying item images from the web stops rather # than fill the disk. Default 500. # IMAGE_DOWNLOAD_MIN_FREE_MB=500 # Push notifications. The push services ask each sender for a way to reach its admin: a # mailto: or https: address. Without PUSH_CONTACT, the instance's public HTTPS address is # used, from PUBLIC_URL when set. # PUSH_CONTACT=mailto:admin@example.com # PUBLIC_URL=https://dvinyl.example.com # Upgrading from DVinyl 3.x? Keep this line as it was: DVinyl keeps running on that MongoDB # until its data folder is mounted, then copies everything into SQLite once by itself. Once # the app looks right, remove this line and the MongoDB container. Guide: docs/docker.md, # "Moving to SQLite". # MONGODB_URL=mongodb://mongodb:27017/dvinyl # Copies that MongoDB into SQLite again, on an empty data folder, even though it was moved # before. Whatever changed since that move is lost. Set it for one start only. # MONGODB_REIMPORT=true # The store is chosen on its own: SQLite, or MongoDB for an upgraded 3.x install whose data # folder is not mounted yet. Set this only to force one of them; sqlite then refuses to # start in a container whose data folder is not mounted. # DB_DRIVER=sqlite # Two different random secrets, required. DVinyl refuses to start while either one is # empty or still set to a value published in this file, because that is a secret anyone # can read. Generate each of them with: openssl rand -hex 32 PASSJWT= SESSION_SECRET= # Optional. Until the first account exists, the setup page creates an administrator for # whoever reaches it first, and so does restoring a backup there. Set this when the # instance is reachable by others before you finish installing it: both will then ask # for this value. Generate one with: openssl rand -hex 16 # SETUP_TOKEN= # HTTPS Configuration PROD=false # Change to true ONLY if you use HTTPS. If not, leave as false. # DVinyl VINYL_PORT=3099 # Port for the DVinyl service # Base URL for serving on a sub-path, leave empty to serve from root (default) BASE_URL= # OIDC / SSO login (optional). Leave unset to disable the feature entirely. # OIDC_ISSUER_URL is your provider's issuer URL (Authentik, Keycloak, Authelia, # pocketID...); endpoints are resolved automatically through OIDC discovery. # OIDC_REDIRECT_URI must be the exact callback URL registered on your provider, # always ending with /login/oidc/callback. # By default SSO never creates accounts: users sign in with their password # first, then link their identity from the Settings page. See the auto-signup # block below to provision accounts automatically from your IdP instead. # OIDC_ISSUER_URL=https://idp.example.com/application/o/dvinyl/ # OIDC_CLIENT_ID=YourOIDCClientID # OIDC_CLIENT_SECRET=YourOIDCClientSecret # OIDC_REDIRECT_URI=https://dvinyl.example.com/login/oidc/callback # OIDC_BUTTON_LABEL=Sign in with Authentik # OIDC auto-provisioning (optional). When OIDC_ALLOW_SIGNUP=true, a successful # SSO login for an unknown identity creates a DVinyl account on the fly (SSO # only, no local password) instead of being rejected. The IdP must supply an # email claim. A *verified* email (email_verified=true) is required only to # attach the SSO identity to an existing local account with the same address # (avoids account takeover); creating a brand-new account does not require it. # OIDC_ALLOWED_GROUP restricts both signup AND every subsequent login to members # of that IdP group; membership is re-checked on each login, so removing a user # from the group in your IdP revokes their access. Leave empty to allow any user # the IdP authenticates. Your IdP must expose group memberships in a claim (the # default claim name is "groups"; override with OIDC_GROUPS_CLAIM if it differs). # OIDC_ADMIN_GROUP grants instance admin rights to members of that group. # OIDC_ALLOW_SIGNUP=true # OIDC_ALLOWED_GROUP=allow_dvinyl_access # OIDC_GROUPS_CLAIM=groups # OIDC_ADMIN_GROUP=dvinyl_admins # SSO only (optional). With OIDC_DISABLE_LOCAL_LOGIN=true the password form is # removed: /login goes straight to your provider and a local sign-in is refused, # so nobody wastes time on credentials this instance will never accept. It is # ignored unless the four OIDC_* variables above are set, so a typo there cannot # leave you with no way in. If your provider ever becomes unreachable, unset this # variable and restart to get the password form back. # OIDC_DISABLE_LOCAL_LOGIN=true # Dev only: allow a plain-HTTP (http://) issuer. openid-client requires HTTPS by # default; set this to true ONLY for local testing against an http:// IdP. Never # enable it in production. Use an HTTPS issuer instead. # OIDC_ALLOW_INSECURE=true # Music DISCOGS_TOKEN=YourDiscogsAPITokenHere # Books HARDCOVER_API_KEY=YourHardcoverAPIKeyHere # DVDs TMDB_API_KEY=YourTMDBAPIKeyHere # Games TWITCH_CLIENT_ID=YourTwitchClientIDHere TWITCH_CLIENT_SECRET=YourTwitchClientSecretHere # Games, second source: ScreenScraper (retro, arcade, MS-DOS). The official Docker image # already carries DVinyl's developer pair, so only a build from source or a fork needs one # here (a pair set here always wins). The member account is your own free screenscraper.fr # login and raises the daily quota. See docs/api-keys.md. # SCREENSCRAPER_DEV_ID= # SCREENSCRAPER_DEV_PASSWORD= # SCREENSCRAPER_USER= # SCREENSCRAPER_PASSWORD= # LEGO REBRICKABLE_API_KEY=YourRebrickableAPIKeyHere # Board games. Left commented out: BoardGameGeek approves each token by hand, and a # placeholder here would count as a key and send every search to a refusal. See # docs/api-keys.md. # BGG_API_KEY= # AI assist (optional). Configure it from the admin panel instead, or set these to pin it # from the environment - they override whatever the admin panel holds. Any OpenAI-compatible # endpoint works: OpenRouter, OpenAI, Anthropic, Gemini, Ollama, LM Studio... # AI_PROVIDER=openrouter # AI_API_KEY=YourAIProviderKeyHere # AI_BASE_URL=https://openrouter.ai/api/v1 # AI_MODEL=openai/gpt-4o-mini