docs: add REDIS_URL and API v2 variables to root .env.example#28648
docs: add REDIS_URL and API v2 variables to root .env.example#28648shockzinfinity wants to merge 1 commit intocalcom:mainfrom
Conversation
|
|
Why not? If I may ask ? Best regards, Harold |
| # 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. |
i might be wrong here wrong here, checking! |
|
. |
What does this PR do?
Adds missing API v2 environment variables to the root
.env.examplethat are required for Docker Compose self-hosting.Problem
When self-hosting with Docker Compose,
docker-compose.ymlconfigures thecalcom-apiservice usingenv_file: .env(root env) and explicitly passes variables likeREDIS_URL,JWT_SECRET, andWEB_APP_URLto 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 missingREDIS_URLvalidation error.Changes
Improved the
# api v2section in root.env.example:REDIS_URL(required — primary fix for the silent startup failure)JWT_SECRET(required for API v2 authentication)WEB_APP_URL(required for API v2)REDIS_PORT,LOG_LEVEL,API_KEY_PREFIX,REWRITE_API_V2_PREFIXapps/api/v2/.env.examplefor local developmentNote
apps/api/v2/.env.examplealready containsREDIS_URL(added in #27290). This PR addresses the root.env.examplefor Docker Compose self-hosters who use that file as their configuration reference.Fixes #25195
Related to #24987
Type of change
How has this been tested?
This is a documentation-only change (
.env.example). No code behavior is affected.docker-compose.ymlthat the added variables match what thecalcom-apiservice reads from root.envapps/api/v2/src/env.tsthat the variables are required by the API v2 runtimeChecklist
.env.examplechanges do not affect application code