From 0aff8dfca64d08cc9824d3ed1459a0e7cc734a48 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Omar=20Lo=CC=81pez?= Date: Wed, 12 Jan 2022 21:37:51 -0700 Subject: [PATCH] Env explainers --- .env.example | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/.env.example b/.env.example index d8a9eb6f18..7ee71a33c5 100644 --- a/.env.example +++ b/.env.example @@ -15,9 +15,8 @@ DATABASE_URL="postgresql://postgres:@localhost:5450/calendso" GOOGLE_API_CREDENTIALS='{}' # To enable Login with Google you need to: -# 1. Set `GOOGLE_API_CREDENTIALS` +# 1. Set `GOOGLE_API_CREDENTIALS` above # 2. Set `GOOGLE_LOGIN_ENABLED` to `true` -# 3. Setup `SAML_DATABASE_URL` and `SAML_ADMINS` down below. GOOGLE_LOGIN_ENABLED=false BASE_URL='http://localhost:3000' @@ -27,10 +26,10 @@ JWT_SECRET='secret' # This is used so we can bypass emails in auth flows for E2E testing PLAYWRIGHT_SECRET= -# To enable SAML login, set both these variables +# To enable SAML login, set both these variables +# @see https://github.com/calendso/calendso/tree/main/ee#setting-up-saml-login # SAML_DATABASE_URL="postgresql://postgres:@localhost:5450/cal-saml" # SAML_ADMINS='pro@example.com' -# If you want to Login with Google as well, you need to setup `GOOGLE_API_CREDENTIALS` and `GOOGLE_LOGIN_ENABLE` above. # @see: https://github.com/calendso/calendso/issues/263 # Required for Vercel hosting - set NEXTAUTH_URL to equal your BASE_URL