Skip to content

docs: add REDIS_URL and API v2 variables to root .env.example#28648

Closed
shockzinfinity wants to merge 1 commit intocalcom:mainfrom
shockzinfinity:docs/env-example-api-v2-redis-url
Closed

docs: add REDIS_URL and API v2 variables to root .env.example#28648
shockzinfinity wants to merge 1 commit intocalcom:mainfrom
shockzinfinity:docs/env-example-api-v2-redis-url

Conversation

@shockzinfinity
Copy link
Copy Markdown
Contributor

What does this PR do?

Adds missing API v2 environment variables to the root .env.example that are required for Docker Compose self-hosting.

Problem

When self-hosting with Docker Compose, docker-compose.yml configures the calcom-api service using env_file: .env (root env) and explicitly passes variables like REDIS_URL, JWT_SECRET, and WEB_APP_URL to the container. However, none of these were documented in the root .env.example, causing the API v2 server to fail silently on startup with a missing REDIS_URL validation error.

Changes

Improved the # api v2 section in root .env.example:

  • Added REDIS_URL (required — primary fix for the silent startup failure)
  • Added JWT_SECRET (required for API v2 authentication)
  • Added WEB_APP_URL (required for API v2)
  • Added optional variables: REDIS_PORT, LOG_LEVEL, API_KEY_PREFIX, REWRITE_API_V2_PREFIX
  • Improved comments explaining Docker Compose vs local dev setup
  • Added cross-reference to apps/api/v2/.env.example for local development

Note

apps/api/v2/.env.example already contains REDIS_URL (added in #27290). This PR addresses the root .env.example for Docker Compose self-hosters who use that file as their configuration reference.

Fixes #25195
Related to #24987

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Chore (formatting, documentation, refactoring)

How has this been tested?

This is a documentation-only change (.env.example). No code behavior is affected.

  • Verified against docker-compose.yml that the added variables match what the calcom-api service reads from root .env
  • Verified against apps/api/v2/src/env.ts that the variables are required by the API v2 runtime

Checklist

  • My changes are < 500 lines and affect < 10 files
  • I have added "Allow edits from maintainers"
  • .env.example changes do not affect application code

Add missing API v2 environment variables to root .env.example for Docker
Compose self-hosting. The calcom-api container reads from root .env, but
REDIS_URL, JWT_SECRET, and other required variables were absent.

Fixes #25195
Related to #24987
@CLAassistant
Copy link
Copy Markdown

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

@github-actions github-actions bot added ❗️ .env changes contains changes to env variables 🐛 bug Something isn't working labels Mar 29, 2026
Copy link
Copy Markdown
Contributor

@cubic-dev-ai cubic-dev-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues found across 1 file

Copy link
Copy Markdown
Member

@romitg2 romitg2 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i don't think we're publishing api/v2 docker image for self-hosters.

@romitg2 romitg2 closed this Mar 29, 2026
@hthetiot
Copy link
Copy Markdown
Contributor

i don't think we're publishing api/v2 docker image for self-hosters.

Why not? If I may ask ?
That supper useful for any environment including working on source for development. If that a commercial/licence issue ?

Best regards,

Harold

Comment thread .env.example
# api v2
# API v2 is a separate NestJS service required for platform and scheduling API features.
# When self-hosting with Docker Compose, all API v2 variables must be set in the root .env file.
# For local development without Docker, see apps/api/v2/.env.example for the full variable list.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Super useful 👌

@romitg2
Copy link
Copy Markdown
Member

romitg2 commented Apr 17, 2026

i don't think we're publishing api/v2 docker image for self-hosters.

Why not? If I may ask ? That supper useful for any environment including working on source for development. If that a commercial/licence issue ?

Best regards,

Harold

i might be wrong here wrong here, checking!

@romitg2
Copy link
Copy Markdown
Member

romitg2 commented Apr 17, 2026

.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

🐛 bug Something isn't working ❗️ .env changes contains changes to env variables size/S

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: update .env.example for API v2 to include REDIS_URL

4 participants