From 9f506e7635ebd9c197410603aff5a59c36c6edda Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Omar=20L=C3=B3pez?= Date: Thu, 10 Feb 2022 19:54:55 -0700 Subject: [PATCH] Unignores .env.example (#1800) --- .env.example | 1 + .gitignore | 2 + apps/web/.env.example | 102 ++++++++++++++++++++++++++++++++++++++++++ apps/web/.gitignore | 1 + 4 files changed, 106 insertions(+) create mode 100644 .env.example create mode 100644 apps/web/.env.example diff --git a/.env.example b/.env.example new file mode 100644 index 0000000000..985d564f90 --- /dev/null +++ b/.env.example @@ -0,0 +1 @@ +# It now lives at `apps/web/.env.example` diff --git a/.gitignore b/.gitignore index 07b1cd2585..44d784ca19 100644 --- a/.gitignore +++ b/.gitignore @@ -37,6 +37,8 @@ yarn-error.log* .env.test.local .env.production.local .env.* +!.env.example + # vercel .vercel diff --git a/apps/web/.env.example b/apps/web/.env.example new file mode 100644 index 0000000000..de63c52020 --- /dev/null +++ b/apps/web/.env.example @@ -0,0 +1,102 @@ +# Set this value to 'agree' to accept our license: +# LICENSE: https://github.com/calendso/calendso/blob/main/LICENSE +# +# Summary of terms: +# - The codebase has to stay open source, whether it was modified or not +# - You can not repackage or sell the codebase +# - Acquire a commercial license to remove these terms by emailing: license@cal.com +NEXT_PUBLIC_LICENSE_CONSENT='' + +# DATABASE_URL='postgresql://:@:/' +DATABASE_URL="postgresql://postgres:@localhost:5450/calendso" + +# Needed to enable Google Calendar integration and Login with Google +# @see https://github.com/calendso/calendso#obtaining-the-google-api-credentials +GOOGLE_API_CREDENTIALS='{}' + +# To enable Login with Google you need to: +# 1. Set `GOOGLE_API_CREDENTIALS` above +# 2. Set `GOOGLE_LOGIN_ENABLED` to `true` +# When self-hosting please ensure you configure the Google integration as an Internal app so no one else can login to your instance +# @see https://support.google.com/cloud/answer/6158849#public-and-internal&zippy=%2Cpublic-and-internal-applications +GOOGLE_LOGIN_ENABLED=false + +BASE_URL='http://localhost:3000' +NEXT_PUBLIC_APP_URL='http://localhost:3000' + +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 +# @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 use Heroku to deploy Postgres (or use self-signed certs for Postgres) then uncomment the follow line. +# @see https://devcenter.heroku.com/articles/connecting-heroku-postgres#connecting-in-node-js +##PGSSLMODE='no-verify' + +# @see: https://github.com/calendso/calendso/issues/263 +# Required for Vercel hosting - set NEXTAUTH_URL to equal your BASE_URL +# NEXTAUTH_URL='http://localhost:3000' + +# Remove this var if you don't want Cal to collect anonymous usage +NEXT_PUBLIC_TELEMETRY_KEY=js.2pvs2bbpqq1zxna97wcml.oi2jzirnbj1ev4tc57c5r + +# Used for the Office 365 / Outlook.com Calendar integration +MS_GRAPH_CLIENT_ID= +MS_GRAPH_CLIENT_SECRET= + +# Used for the Zoom integration +ZOOM_CLIENT_ID= +ZOOM_CLIENT_SECRET= + +#Used for the Daily integration +DAILY_API_KEY= +DAILY_SCALE_PLAN='' + +# Used for the Tandem integration -- contact support@tandem.chat to for API access. +TANDEM_CLIENT_ID="" +TANDEM_CLIENT_SECRET="" +TANDEM_BASE_URL="https://tandem.chat" + +# E-mail settings + +# Cal uses nodemailer (@see https://nodemailer.com/about/) to provide email sending. As such we are trying to +# allow access to the nodemailer transports from the .env file. E-mail templates are accessible within lib/emails/ + +# Configures the global From: header whilst sending emails. +EMAIL_FROM='notifications@yourselfhostedcal.com' + +# Configure SMTP settings (@see https://nodemailer.com/smtp/). +# Note: The below configuration for Office 365 has been verified to work. +EMAIL_SERVER_HOST='smtp.office365.com' +EMAIL_SERVER_PORT=587 +EMAIL_SERVER_USER='' +# Keep in mind that if you have 2FA enabled, you will need to provision an App Password. +EMAIL_SERVER_PASSWORD='' +# The following configuration for Gmail has been verified to work. +# EMAIL_SERVER_HOST='smtp.gmail.com' +# EMAIL_SERVER_PORT=465 +# EMAIL_SERVER_USER='' +## You will need to provision an App Password. +## @see https://support.google.com/accounts/answer/185833 +# EMAIL_SERVER_PASSWORD='' + +# ApiKey for cronjobs +CRON_API_KEY='0cc0e6c35519bba620c9360cfe3e68d0' + +# Stripe Config +NEXT_PUBLIC_STRIPE_PUBLIC_KEY= # pk_test_... +STRIPE_PRIVATE_KEY= # sk_test_... +STRIPE_CLIENT_ID= # ca_... +STRIPE_WEBHOOK_SECRET= # whsec_... +PAYMENT_FEE_PERCENTAGE=0.005 # Take 0.5% commission +PAYMENT_FEE_FIXED=10 # Take 10 additional cents commission + +# Application Key for symmetric encryption and decryption +# must be 32 bytes for AES256 encryption algorithm +CALENDSO_ENCRYPTION_KEY= + +# Intercom Config +NEXT_PUBLIC_INTERCOM_APP_ID= diff --git a/apps/web/.gitignore b/apps/web/.gitignore index f7a1ad8d72..abc84320a8 100644 --- a/apps/web/.gitignore +++ b/apps/web/.gitignore @@ -40,6 +40,7 @@ yarn-error.log* .env.test.local .env.production.local .env.* +!.env.example # vercel .vercel