From 333bd4912d75f664d91070e0419938bb273221e1 Mon Sep 17 00:00:00 2001 From: Frederic Cabassut Date: Mon, 9 Mar 2026 00:36:40 +0100 Subject: [PATCH] docs: update .env.example with OAuth configuration Add Google, GitHub, and generic OIDC environment variables. Providers are auto-enabled when their env vars are set. Co-Authored-By: Claude Opus 4.6 --- .env.example | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/.env.example b/.env.example index a31023a..5e69214 100644 --- a/.env.example +++ b/.env.example @@ -1,8 +1,24 @@ # Database path (relative to project root or absolute) DATABASE_URL=./data/crumbs.db -# Server origin (required for CSRF protection) +# Server origin (required for CSRF protection and OAuth redirect URLs) ORIGIN=http://localhost:3000 # Node environment NODE_ENV=development + +# --- OAuth Providers (optional, auto-enabled when set) --- + +# Google OAuth 2.0 +# AUTH_GOOGLE_CLIENT_ID= +# AUTH_GOOGLE_CLIENT_SECRET= + +# GitHub OAuth +# AUTH_GITHUB_CLIENT_ID= +# AUTH_GITHUB_CLIENT_SECRET= + +# Generic OIDC (e.g. Authentik, Keycloak, Okta) +# AUTH_OIDC_ISSUER=https://your-idp.example.com +# AUTH_OIDC_CLIENT_ID= +# AUTH_OIDC_CLIENT_SECRET= +# AUTH_OIDC_DISPLAY_NAME=SSO