cal.com/.env.example at ce87de4fc711bd0a79f90bd591413c45206979b8 · calcom/cal.com

History

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

# ********** INDEX **********

# - LICENSE (DEPRECATED)

# - DATABASE

# - SHARED

# - NEXTAUTH

# - E-MAIL SETTINGS

# - ORGANIZATIONS

# - LICENSE (DEPRECATED) ************************************************************************************

# https://github.com/calcom/cal.com/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 visiting: cal.com/sales

# To enable enterprise-only features please add your environment variable to the .env file then make your way to /auth/setup to select your license and follow instructions.

CALCOM_LICENSE_KEY=

# Signature token for the Cal.com License API (used for self-hosted integrations)

# We will give you a token when we provide you with a license key this ensure you and only you can communicate with the Cal.com License API for your license key

CAL_SIGNATURE_TOKEN=

# The route to the Cal.com License API

CALCOM_PRIVATE_API_ROUTE="https://goblin.cal.com"

# ***********************************************************************************************************

# - DATABASE ************************************************************************************************

DATABASE_URL="postgresql://postgres:@localhost:5450/calendso"

# Needed to run migrations while using a connection pooler like PgBouncer

# Use the same one as DATABASE_URL if you're not using a connection pooler

DATABASE_DIRECT_URL="postgresql://postgres:@localhost:5450/calendso"

INSIGHTS_DATABASE_URL=

# Uncomment to enable a dedicated connection pool for Prisma using Prisma Data Proxy

# Cold boots will be faster and you'll be able to scale your DB independently of your app.

# @see https://www.prisma.io/docs/data-platform/data-proxy/use-data-proxy

# PRISMA_GENERATE_DATAPROXY=true

PRISMA_GENERATE_DATAPROXY=

# ***********************************************************************************************************

# - SHARED **************************************************************************************************

# Set this to http://app.cal.local:3000 if you want to enable organizations, and

# check variable ORGANIZATIONS_ENABLED at the bottom of this file

NEXT_PUBLIC_WEBAPP_URL='http://localhost:3000'

# Change to 'http://localhost:3001' if running the website simultaneously

NEXT_PUBLIC_WEBSITE_URL='http://localhost:3000'

NEXT_PUBLIC_CONSOLE_URL='http://localhost:3004'

NEXT_PUBLIC_EMBED_LIB_URL='http://localhost:3000/embed/embed.js'

# To enable SAML login, set both these variables

# @see https://github.com/calcom/cal.com/tree/main/packages/features/ee#setting-up-saml-login

# SAML_DATABASE_URL="postgresql://postgres:@localhost:5450/cal-saml"

SAML_DATABASE_URL=

# SAML_ADMINS='pro@example.com'

SAML_ADMINS=

# NEXT_PUBLIC_HOSTED_CAL_FEATURES=1

NEXT_PUBLIC_HOSTED_CAL_FEATURES=

# For additional security set to a random secret and use that value as the client_secret during the OAuth 2.0 flow.

SAML_CLIENT_SECRET_VERIFIER=

# 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'

PGSSLMODE=

# Define which hostnames are expected for the app to work on

ALLOWED_HOSTNAMES='"cal.com","cal.dev","cal-staging.com","cal.community","cal.local:3000","localhost:3000"'

# Reserved orgs subdomains for our own usage

RESERVED_SUBDOMAINS='"app","auth","docs","design","console","go","status","api","saml","www","matrix","developer","cal","my","team","support","security","blog","learn","admin"'

# - NEXTAUTH

# @see: https://github.com/calendso/calendso/issues/263

# @see: https://next-auth.js.org/configuration/options#nextauth_url

# Required for Vercel hosting - set NEXTAUTH_URL to equal your NEXT_PUBLIC_WEBAPP_URL

NEXTAUTH_URL='http://localhost:3000'

# @see: https://next-auth.js.org/configuration/options#nextauth_secret

# You can use: `openssl rand -base64 32` to generate one

NEXTAUTH_SECRET=

# Used for cross-domain cookie authentication

NEXTAUTH_COOKIE_DOMAIN=

# Set this to '1' if you don't want Cal to collect anonymous usage

CALCOM_TELEMETRY_DISABLED=

# ApiKey for cronjobs

CRON_API_KEY='0cc0e6c35519bba620c9360cfe3e68d0'

# Whether to automatically keep app metadata in the database in sync with the metadata/config files. When disabled, the

# sync runs in a reporting-only dry-run mode.

CRON_ENABLE_APP_SYNC=false

# Application Key for symmetric encryption and decryption

# must be 32 bytes for AES256 encryption algorithm

# You can use: `openssl rand -base64 32` to generate one

CALENDSO_ENCRYPTION_KEY=

# Intercom Config

NEXT_PUBLIC_INTERCOM_APP_ID=

# Secret to enable Intercom Identity Verification

INTERCOM_SECRET=

# Posthog Config

NEXT_PUBLIC_POSTHOG_KEY=

NEXT_PUBLIC_POSTHOG_HOST=

# plain.com config

PLAIN_API_KEY=

PLAIN_API_URL=https://api.plain.com/v1

PLAIN_HMAC_SECRET_KEY=

PLAIN_CHAT_ID=

PLAIN_CHAT_HMAC_SECRET_KEY=

NEXT_PUBLIC_PLAIN_CHAT_EXCLUDED_PATHS=

# Zendesk Config

NEXT_PUBLIC_ZENDESK_KEY=

# Help Scout Config

NEXT_PUBLIC_HELPSCOUT_KEY=

# Fresh Chat Config

NEXT_PUBLIC_FRESHCHAT_TOKEN=

NEXT_PUBLIC_FRESHCHAT_HOST=

# Google OAuth credentials

# To enable Login with Google you need to:

# 1. Set `GOOGLE_API_CREDENTIALS` below

# 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

# - GOOGLE CALENDAR/MEET/LOGIN

# Needed to enable Google Calendar integration and Login with Google

# @see https://github.com/calcom/cal.com#obtaining-the-google-api-credentials

GOOGLE_API_CREDENTIALS=

# Token to verify incoming webhooks from Google Calendar

GOOGLE_WEBHOOK_TOKEN=

# Optional URL to override for tunelling webhooks. Defaults to NEXT_PUBLIC_WEBAPP_URL.

GOOGLE_WEBHOOK_URL=

# Inbox to send user feedback

SEND_FEEDBACK_EMAIL=

# Sendgrid

# Used for email reminders in workflows and internal sync services

SENDGRID_API_KEY=

SENDGRID_EMAIL=

NEXT_PUBLIC_SENDGRID_SENDER_NAME=

# Sentry

# Used for capturing exceptions and logging messages

NEXT_PUBLIC_SENTRY_DSN=

SENTRY_DEBUG=

SENTRY_DISABLE_CLIENT_SOURCE_MAPS=

SENTRY_DISABLE_SERVER_SOURCE_MAPS=

SENTRY_MAX_SPANS=

SENTRY_TRACES_SAMPLE_RATE=

# Formbricks Experience Management Integration

NEXT_PUBLIC_FORMBRICKS_HOST_URL=https://app.formbricks.com

NEXT_PUBLIC_FORMBRICKS_ENVIRONMENT_ID=

FORMBRICKS_FEEDBACK_SURVEY_ID=

# AvatarAPI

# Used to pre-fill avatar during signup

AVATARAPI_USERNAME=

AVATARAPI_PASSWORD=

# Twilio

# Used to send SMS reminders in workflows

TWILIO_SID=

TWILIO_TOKEN=

TWILIO_MESSAGING_SID=

TWILIO_PHONE_NUMBER=

TWILIO_WHATSAPP_PHONE_NUMBER=

# For NEXT_PUBLIC_SENDER_ID only letters, numbers and spaces are allowed (max. 11 characters)

NEXT_PUBLIC_SENDER_ID=

TWILIO_VERIFY_SID=

# Set it to "1" if you need to run E2E tests locally.

NEXT_PUBLIC_IS_E2E=

# Used for internal billing system

NEXT_PUBLIC_STRIPE_PRO_PLAN_PRICE=

NEXT_PUBLIC_STRIPE_PREMIUM_PLAN_PRICE=

NEXT_PUBLIC_IS_PREMIUM_NEW_PLAN=0

NEXT_PUBLIC_STRIPE_PREMIUM_NEW_PLAN_PRICE=

STRIPE_TEAM_MONTHLY_PRICE_ID=

STRIPE_TEAM_PRODUCT_ID=

STRIPE_ORG_MONTHLY_PRICE_ID=

STRIPE_WEBHOOK_SECRET=

STRIPE_WEBHOOK_SECRET_APPS=

STRIPE_PRIVATE_KEY=

STRIPE_CLIENT_ID=

# Use for internal Public API Keys and optional

API_KEY_PREFIX=cal_

# ***********************************************************************************************************

# - 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'

EMAIL_FROM_NAME='Cal.com'

# Configure SMTP settings (@see https://nodemailer.com/smtp/).

# Configuration to receive emails locally (mailhog)

EMAIL_SERVER_HOST='localhost'

EMAIL_SERVER_PORT=1025

# 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='<office365_emailAddress>'

# Keep in mind that if you have 2FA enabled, you will need to provision an App Password.

# EMAIL_SERVER_PASSWORD='<office365_password>'

# The following configuration for Gmail has been verified to work.

# EMAIL_SERVER_HOST='smtp.gmail.com'

# EMAIL_SERVER_PORT=465

# EMAIL_SERVER_USER='<gmail_emailAddress>'

## You will need to provision an App Password.

## @see https://support.google.com/accounts/answer/185833

# EMAIL_SERVER_PASSWORD='<gmail_app_password>'

# Used for E2E for email testing

# Set it to "1" if you need to email checks in E2E tests locally

# Make sure to run mailhog container manually or with `yarn dx`

E2E_TEST_MAILHOG_ENABLED=

# Resend

# Send transactional email using resend

# RESEND_API_KEY=

# **********************************************************************************************************

# Cloudflare Turnstile

NEXT_PUBLIC_CLOUDFLARE_SITEKEY=

CLOUDFLARE_TURNSTILE_SECRET=

# Set the following value to true if you wish to enable Team Impersonation

NEXT_PUBLIC_TEAM_IMPERSONATION=false

# Close.com internal CRM

CLOSECOM_CLIENT_ID=

CLOSECOM_CLIENT_SECRET=

# Sendgrid internal sync service

SENDGRID_SYNC_API_KEY=

# Change your Brand

NEXT_PUBLIC_APP_NAME="Cal.com"

NEXT_PUBLIC_SUPPORT_MAIL_ADDRESS="help@cal.com"

NEXT_PUBLIC_COMPANY_NAME="Cal.com, Inc."

# Set this to true in to disable new signups

# NEXT_PUBLIC_DISABLE_SIGNUP=true

NEXT_PUBLIC_DISABLE_SIGNUP=

# Set this to 'non-strict' to enable CSP for support pages. 'strict' isn't supported yet. Also, check the README for details.

# Content Security Policy

CSP_POLICY=

# Vercel Edge Config

EDGE_CONFIG=

NEXT_PUBLIC_MINUTES_TO_BOOK=5 # Minutes

NEXT_PUBLIC_BOOKER_NUMBER_OF_DAYS_TO_LOAD=0 # Override the booker to only load X number of days worth of data

# Control time intervals on a user's Schedule availability

NEXT_PUBLIC_AVAILABILITY_SCHEDULE_INTERVAL=

# - ORGANIZATIONS *******************************************************************************************

# Enable Organizations non-prod domain setup, works in combination with organizations feature flag

# This is mainly needed locally, because for orgs to work a full domain name needs to point

# to the app, i.e. app.cal.local instead of using localhost, which is very disruptive

# This variable should only be set to 1 or true if you are in a non-prod environment and you want to

# use organizations

ORGANIZATIONS_ENABLED=

NEXT_PUBLIC_ORGANIZATIONS_MIN_SELF_SERVE_SEATS=30

NEXT_PUBLIC_ORGANIZATIONS_SELF_SERVE_PRICE=3700 # $37.00 per seat

# This variable should only be set to 1 or true if you want to autolink external provider sign-ups with

# existing organizations based on email domain address

ORGANIZATIONS_AUTOLINK=

# Vercel Config to create subdomains for organizations

# Get it from https://vercel.com/<TEAM_OR_USER_NAME>/<PROJECT_SLUG>/settings

PROJECT_ID_VERCEL=

# Get it from: https://vercel.com/teams/<TEAM_SLUG>/settings

TEAM_ID_VERCEL=

# Get it from: https://vercel.com/account/tokens

AUTH_BEARER_TOKEN_VERCEL=

# Add the main domain that you want to use for testing vercel domain management for organizations. This is necessary because WEBAPP_URL of local isn't a valid public domain

# Would create org1.example.com for an org with slug org1

# LOCAL_TESTING_DOMAIN_VERCEL="example.com"

## Set it to 1 if you use cloudflare to manage your DNS and would like us to manage the DNS for you for organizations

# CLOUDFLARE_DNS=1

## Get it from: https://dash.cloudflare.com/profile/api-tokens. Select Edit Zone template and choose a zone(your domain)

# AUTH_BEARER_TOKEN_CLOUDFLARE=

## Zone ID can be found in the Overview tab of your domain in Cloudflare

# CLOUDFLARE_ZONE_ID=

## It should usually work with the default value. This is the DNS CNAME record content to point to Vercel domain

# CLOUDFLARE_VERCEL_CNAME=cname.vercel-dns.com

# - APPLE CALENDAR

# Used for E2E tests on Apple Calendar

E2E_TEST_APPLE_CALENDAR_EMAIL=""

E2E_TEST_APPLE_CALENDAR_PASSWORD=""

# - CALCOM QA ACCOUNT

# Used for E2E tests on Cal.com that require 3rd party integrations

E2E_TEST_CALCOM_QA_EMAIL="qa@example.com"

# Replace with your own password

E2E_TEST_CALCOM_QA_PASSWORD="password"

E2E_TEST_CALCOM_QA_GCAL_CREDENTIALS=

E2E_TEST_CALCOM_GCAL_KEYS=

# - APP CREDENTIAL SYNC ***********************************************************************************

# Used for self-hosters that are implementing Cal.com into their applications that already have certain integrations

# Under settings/admin/apps ensure that all app secrets are set the same as the parent application

# You can use: `openssl rand -base64 32` to generate one

CALCOM_CREDENTIAL_SYNC_SECRET=""

# This is the header name that will be used to verify the webhook secret. Should be in lowercase

CALCOM_CREDENTIAL_SYNC_HEADER_NAME="calcom-credential-sync-secret"

# This the endpoint from which the token is fetched

CALCOM_CREDENTIAL_SYNC_ENDPOINT=""

# Key should match on Cal.com and your application

# must be 24 bytes for AES256 encryption algorithm

# You can use: `openssl rand -base64 24` to generate one

CALCOM_APP_CREDENTIAL_ENCRYPTION_KEY=""

# - OIDC E2E TEST *******************************************************************************************

# Ensure this ADMIN EMAIL is present in the SAML_ADMINS list

E2E_TEST_SAML_ADMIN_EMAIL=

E2E_TEST_SAML_ADMIN_PASSWORD=

E2E_TEST_OIDC_CLIENT_ID=

E2E_TEST_OIDC_CLIENT_SECRET=

E2E_TEST_OIDC_PROVIDER_DOMAIN=

E2E_TEST_OIDC_USER_EMAIL=

E2E_TEST_OIDC_USER_PASSWORD=

# ***********************************************************************************************************

# provide a value between 0 and 100 to ensure the percentage of traffic

# redirected from the legacy to the future pages

AB_TEST_BUCKET_PROBABILITY=50

APP_ROUTER_APPS_INSTALLED_CATEGORY_ENABLED=0

APP_ROUTER_APPS_SLUG_ENABLED=0

APP_ROUTER_APPS_SLUG_SETUP_ENABLED=0

# whether we redirect to the future/apps/categories from /apps/categories or not

APP_ROUTER_APPS_CATEGORIES_ENABLED=0

# whether we redirect to the future/apps/categories/[category] from /apps/categories/[category] or not

APP_ROUTER_APPS_CATEGORIES_CATEGORY_ENABLED=0

APP_ROUTER_APPS_ENABLED=0

APP_ROUTER_TEAM_ENABLED=0

APP_ROUTER_AUTH_FORGOT_PASSWORD_ENABLED=0

APP_ROUTER_AUTH_LOGIN_ENABLED=0

APP_ROUTER_AUTH_LOGOUT_ENABLED=0

APP_ROUTER_AUTH_NEW_ENABLED=0

APP_ROUTER_AUTH_SAML_ENABLED=0

APP_ROUTER_AUTH_ERROR_ENABLED=0

APP_ROUTER_AUTH_PLATFORM_ENABLED=0

APP_ROUTER_AUTH_OAUTH2_ENABLED=0

# disable setry server source maps

SENTRY_DISABLE_SERVER_WEBPACK_PLUGIN=1

# api v2

NEXT_PUBLIC_API_V2_URL="http://localhost:5555/api/v2"

# Tasker features

TASKER_ENABLE_WEBHOOKS=0

TASKER_ENABLE_EMAILS=0

# Ratelimiting via unkey

UNKEY_ROOT_KEY=

# Used for Cal.ai Enterprise Voice AI Agents

# https://retellai.com

RETELL_AI_KEY=

# Used for the huddle01 integration

HUDDLE01_API_TOKEN=

# Used to disallow emails as being added as guests on bookings

BLACKLISTED_GUEST_EMAILS=

# Used to allow browser push notifications

# You can use: 'npx web-push generate-vapid-keys' to generate these keys

NEXT_PUBLIC_VAPID_PUBLIC_KEY=

VAPID_PRIVATE_KEY=

# Custom privacy policy / terms URLs (for self-hosters: change to your privacy policy / terms URLs)

NEXT_PUBLIC_WEBSITE_PRIVACY_POLICY_URL=

NEXT_PUBLIC_WEBSITE_TERMS_URL=

# NEXT_PUBLIC_LOGGER_LEVEL=3 sets to log info, warn, error and fatal logs.

# [0: silly & upwards, 1: trace & upwards, 2: debug & upwards, 3: info & upwards, 4: warn & upwards, 5: error & fatal, 6: fatal]

NEXT_PUBLIC_LOGGER_LEVEL=

# Used to use Replexica SDK, a tool for real-time AI-powered localization

REPLEXICA_API_KEY=

# Comma-separated list of DSyncData.directoryId to log SCIM API requests for. It can be enabled temporarily for debugging the requests being sent to SCIM server.

DIRECTORY_IDS_TO_LOG=

# Set this when Cal.com is used to serve only one organization's booking pages

# Read more about it in the README.md

NEXT_PUBLIC_SINGLE_ORG_SLUG=

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

.env.example

.env.example

Files

.env.example

Latest commit

History

.env.example

File metadata and controls