Skip to content

Commit 3b4eef1

Browse files
shockzinfinityshockzM1Paperclip-Paperclip
authored
docs: update Docker self-hosting documentation (calcom#28647)
- Fix Advanced users section: update "Clone calcom/docker" reference to "calcom/cal.com" and remove outdated submodule update step - Add required secret key generation instructions for NEXTAUTH_SECRET and CALENDSO_ENCRYPTION_KEY in the Docker setup steps - Add Calendar integration skip guidance for first-time users who get stuck on the "Connect your Calendar" setup wizard step - Update runtime variables table with generation commands for secrets Fixes calcom#24833 Co-authored-by: shockzM1 <shockz@dsn.so> Co-authored-by: Paperclip <noreply@paperclip.ing>
1 parent 31f4076 commit 3b4eef1

1 file changed

Lines changed: 35 additions & 18 deletions

File tree

README.md

Lines changed: 35 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -480,6 +480,29 @@ If you are evaluating Cal.com or running with minimal to no modifications, this
480480

481481
Most configurations can be left as-is, but for configuration options see [Important Run-time variables](#important-run-time-variables) below.
482482

483+
**Required Secret Keys**
484+
485+
Before starting, you must generate secure values for `NEXTAUTH_SECRET` and `CALENDSO_ENCRYPTION_KEY`. Using the default `secret` placeholder in production is a security risk.
486+
487+
Generate `NEXTAUTH_SECRET` (cookie encryption key):
488+
489+
```bash
490+
openssl rand -base64 32
491+
```
492+
493+
Generate `CALENDSO_ENCRYPTION_KEY` (must be 32 bytes for AES256):
494+
495+
```bash
496+
openssl rand -base64 24
497+
```
498+
499+
Update your `.env` file with these values:
500+
501+
```env
502+
NEXTAUTH_SECRET=<your_generated_secret>
503+
CALENDSO_ENCRYPTION_KEY=<your_generated_key>
504+
```
505+
483506
**Push Notifications (VAPID Keys)**
484507
If you see an error like:
485508

@@ -541,6 +564,8 @@ If you are evaluating Cal.com or running with minimal to no modifications, this
541564

542565
6. Open a browser to [http://localhost:3000](http://localhost:3000), or your defined NEXT_PUBLIC_WEBAPP_URL. The first time you run Cal.com, a setup wizard will initialize. Define your first user, and you're ready to go!
543566

567+
**Note for first-time setup (Calendar integration)**: During the setup wizard, you may encounter a "Connect your Calendar" step that appears to be required. If you do not wish to connect a calendar at this time, you can skip this step by navigating directly to the dashboard at `<NEXT_PUBLIC_WEBAPP_URL>/event-types`. Calendar integrations can be added later from the Settings > Integrations page.
568+
544569
#### Updating Cal.com
545570

546571
1. Stop the Cal.com stack
@@ -564,31 +589,23 @@ If you are evaluating Cal.com or running with minimal to no modifications, this
564589

565590
#### (Advanced users) Build and Run Cal.com
566591

567-
1. Clone calcom/docker.
592+
1. Clone calcom/cal.com.
568593

569594
```bash
570-
git clone https://github.com/calcom/cal.com.git calcom-docker
595+
git clone https://github.com/calcom/cal.com.git
571596
```
572597

573598
2. Change into the directory
574599

575600
```bash
576-
cd calcom-docker
577-
```
578-
579-
3. Update the calcom submodule. This project depends on the Cal.com source code, which is included here as a Git submodule. To make sure you get everything you need, update the submodule with the command below.
580-
581-
```bash
582-
git submodule update --remote --init
601+
cd cal.com
583602
```
584603

585-
Note: DO NOT use recursive submodule update, otherwise you will receive a git authentication error.
586-
587-
4. Rename `.env.example` to `.env` and then update `.env`
604+
3. Rename `.env.example` to `.env` and then update `.env`
588605

589606
For configuration options see [Build-time variables](#build-time-variables) below. Update the appropriate values in your .env file, then proceed.
590607

591-
5. Build the Cal.com docker image:
608+
4. Build the Cal.com docker image:
592609

593610
Note: Due to application configuration requirements, an available database is currently required during the build process.
594611

@@ -600,13 +617,13 @@ If you are evaluating Cal.com or running with minimal to no modifications, this
600617
docker compose up -d database
601618
```
602619

603-
6. Build Cal.com via docker compose (DOCKER_BUILDKIT=0 must be provided to allow a network bridge to be used at build time. This requirement will be removed in the future)
620+
5. Build Cal.com via docker compose (DOCKER_BUILDKIT=0 must be provided to allow a network bridge to be used at build time. This requirement will be removed in the future)
604621

605622
```bash
606623
DOCKER_BUILDKIT=0 docker compose build calcom
607624
```
608625

609-
7. Start Cal.com via docker compose
626+
6. Start Cal.com via docker compose
610627

611628
(Most basic users, and for First Run) To run the complete stack, which includes a local Postgres database, Cal.com web app, and Prisma Studio:
612629

@@ -628,7 +645,7 @@ If you are evaluating Cal.com or running with minimal to no modifications, this
628645

629646
**Note: to run in attached mode for debugging, remove `-d` from your desired run command.**
630647

631-
8. Open a browser to [http://localhost:3000](http://localhost:3000), or your defined NEXT_PUBLIC_WEBAPP_URL. The first time you run Cal.com, a setup wizard will initialize. Define your first user, and you're ready to go!
648+
7. Open a browser to [http://localhost:3000](http://localhost:3000), or your defined NEXT_PUBLIC_WEBAPP_URL. The first time you run Cal.com, a setup wizard will initialize. Define your first user, and you're ready to go!
632649

633650
#### Configuration
634651

@@ -642,8 +659,8 @@ These variables must also be provided at runtime
642659
| CALCOM_LICENSE_KEY | Enterprise License Key | optional | |
643660
| NEXT_PUBLIC_WEBAPP_URL | Base URL of the site. NOTE: if this value differs from the value used at build-time, there will be a slight delay during container start (to update the statically built files). | optional | `http://localhost:3000` |
644661
| NEXTAUTH_URL | Location of the auth server. By default, this is the Cal.com docker instance itself. | optional | `{NEXT_PUBLIC_WEBAPP_URL}/api/auth` |
645-
| NEXTAUTH_SECRET | must match build variable | required | `secret` |
646-
| CALENDSO_ENCRYPTION_KEY | must match build variable | required | `secret` |
662+
| NEXTAUTH_SECRET | Cookie encryption key. Must match build variable. Generate with: `openssl rand -base64 32` | required | `secret` |
663+
| CALENDSO_ENCRYPTION_KEY | Authentication encryption key (32 bytes for AES256). Must match build variable. Generate with: `openssl rand -base64 24` | required | `secret` |
647664

648665
##### Build-time variables
649666

0 commit comments

Comments
 (0)