docs: add env variable checklist and Windows symlink guidance to README setup#28667
Open
shockzinfinity wants to merge 3 commits intocalcom:mainfrom
Open
docs: add env variable checklist and Windows symlink guidance to README setup#28667shockzinfinity wants to merge 3 commits intocalcom:mainfrom
shockzinfinity wants to merge 3 commits intocalcom:mainfrom
Conversation
…ME setup Expand Step 4 of the installation guide to help users avoid the most common self-hosting misconfiguration issues: - Add a quick-reference table of key environment variables that must be reviewed before starting the app, with notes on when each needs to change (NEXTAUTH_SECRET, CALENDSO_ENCRYPTION_KEY, DATABASE_URL, NEXT_PUBLIC_WEBAPP_URL, NEXTAUTH_URL, EMAIL_FROM) - Add a callout note linking NEXT_PUBLIC_WEBAPP_URL / NEXTAUTH_URL misconfiguration to the common localhost redirect issue - Expand Windows symlink guidance to cover the case where admin privileges were missing at clone time, with the correct git clone command and a link to the Git for Windows symlinks docs Co-Authored-By: Paperclip <noreply@paperclip.ing>
![cubic-dev-ai[bot]](https://avatars.githubusercontent.com/in/1082092?s=60&v=4){kind=small}
|
shockzM1 seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account. You have signed the CLA already but the status is still pending? Let us recheck it. |
Removed reference to Git for Windows symlinks from README.
| | `EMAIL_FROM` | When you want outgoing emails to show a custom sender address | `Cal.com <noreply@yourdomain.com>` | | ||
|
|
||
| > **Note:** Failing to update `NEXT_PUBLIC_WEBAPP_URL` and `NEXTAUTH_URL` is the most common cause of redirect-to-localhost issues after deployment. | ||
|
|
Member
There was a problem hiding this comment.
I think we don't need this part in the docs, can you revert them
sahitya-chandra
requested changes
Apr 1, 2026
Member
sahitya-chandra
left a comment
sahitya-chandra
left a comment
There was a problem hiding this comment.
this PR does not fixes the linked issue so can you unlink it
and then update the title also. thanks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Expands Step 4 of the README installation guide (
.envsetup) to help users avoid the most common misconfiguration issues when self-hosting Cal.com.Changes
Environment variable quick-reference table added after the existing
NEXTAUTH_SECRET/CALENDSO_ENCRYPTION_KEYgeneration commands:NEXTAUTH_SECRETCALENDSO_ENCRYPTION_KEYDATABASE_URLNEXT_PUBLIC_WEBAPP_URLNEXTAUTH_URLEMAIL_FROMA callout note explicitly links
NEXT_PUBLIC_WEBAPP_URL/NEXTAUTH_URLmisconfiguration to the well-known localhost redirect issue.Windows symlink guidance expanded to cover the case where the repository was cloned without admin privileges (the symlink at
packages/prisma/.envwould not have been created), with the correctgit clone -c core.symlinks=truecommand and a reference link.Motivation
These are among the most frequently reported self-hosting issues:
localhost:3000(related: cal.com deployment redirects to localhost:3000 every time #21921)The changes are purely documentation — no code is modified.
Allow edits from maintainers ✅