You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Oct 29, 2025. It is now read-only.
Copy file name to clipboardExpand all lines: README.md
+20-21Lines changed: 20 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -25,19 +25,17 @@
25
25
</p>
26
26
</p>
27
27
28
-
# Docker
29
-
30
-
This image can be found on DockerHub at [https://hub.docker.com/r/calcom/cal.com](https://hub.docker.com/r/calcom/cal.com)
28
+
# Important Notes
31
29
32
-
The Docker configuration for Cal.com is an effort powered by people within the community. Cal.com, Inc. does not yet provide official support for Docker, but we will accept fixes and documentation at this time. Use at your own risk.
30
+
Support for this image can be found via the repository, located at [https://github.com/calcom/docker](https://github.com/calcom/docker)
33
31
34
-
## Important Notes
32
+
#Docker
35
33
36
-
This Docker Image is managed by the Cal.com Community. Join the team [here](https://github.com/calcom/docker/discussions/32). Support for this image can be found via the repository, located at [https://github.com/calcom/docker](https://github.com/calcom/docker)
34
+
This image can be found on DockerHub at [https://hub.docker.com/r/calcom/cal.com](https://hub.docker.com/r/calcom/cal.com).
37
35
38
-
**Currently, this image is intended for local development/evaluation use only, as there are specific requirements for providing environmental variables at build-time in order to specify a non-localhost BASE_URL. (this is due to the nature of the static site compilation, which embeds the variable values). The ability to update these variables at runtime is in-progress and will be available in the future.**
36
+
**Note for ARM Users**: Use the {version}-arm suffix for pulling images. Example: `docker pull calcom/cal.com:v5.6.19-arm`.
39
37
40
-
For Production, for the time being, please checkout the repository and build/push your own image privately.
38
+
The Docker configuration for Cal.com is an effort powered by people within the community. Cal.com, Inc. does not yet provide official support for Docker, but we will accept fixes and documentation at this time. Use at your own risk.
41
39
42
40
## Requirements
43
41
@@ -49,7 +47,7 @@ Note: `docker compose` without the hyphen is now the primary method of using doc
49
47
50
48
If you are evaluating Cal.com or running with minimal to no modifications, this option is for you.
@@ -162,7 +160,7 @@ If you are evaluating Cal.com or running with minimal to no modifications, this
162
160
cd calcom-docker
163
161
```
164
162
165
-
3. Update the calcom submodule.
163
+
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.
166
164
167
165
```bash
168
166
git submodule update --remote --init
@@ -224,31 +222,33 @@ These variables must also be provided at runtime
224
222
225
223
| Variable | Description | Required | Default |
226
224
| --- | --- | --- | --- |
225
+
| DATABASE_URL | database url with credentials - if using a connection pooler, this setting should point there | required |`postgresql://unicorn_user:magical_password@database:5432/calendso`|
| 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`|
229
228
| NEXTAUTH_URL | Location of the auth server. By default, this is the Cal.com docker instance itself. | optional |`{NEXT_PUBLIC_WEBAPP_URL}/api/auth`|
230
229
| NEXTAUTH_SECRET | must match build variable | required |`secret`|
231
230
| CALENDSO_ENCRYPTION_KEY | must match build variable | required |`secret`|
232
-
| DATABASE_URL | database url with credentials - if using a connection pooler, this setting should point there | required |`postgresql://unicorn_user:magical_password@database:5432/calendso`|
233
-
| DATABASE_DIRECT_URL | direct database url with credentials if using a connection pooler (e.g. PgBouncer, Prisma Accelerate, etc.) | optional ||
234
231
235
232
### Build-time variables
236
233
237
234
If building the image yourself, these variables must be provided at the time of the docker build, and can be provided by updating the .env file. Currently, if you require changes to these variables, you must follow the instructions to build and publish your own image.
238
235
239
-
Updating these variables is not required forevaluation, but is required for runningin production. Instructions forgenerating variables can be foundin the [cal.com instructions](https://github.com/calcom/cal.com)
236
+
Updating these variables is not required forevaluation, but is required for runningin production. Instructions forgenerating variables can be foundin the [Cal.com instructions](https://github.com/calcom/cal.com)
240
237
241
238
| Variable | Description | Required | Default |
242
239
| --- | --- | --- | --- |
243
-
| NEXT_PUBLIC_WEBAPP_URL | Base URL injected into static files | optional |`http://localhost:3000`|
| CALCOM_TELEMETRY_DISABLED | Allow cal.com to collect anonymous usage data (set to `1` to disable) |||
248
240
| DATABASE_URL | database url with credentials - if using a connection pooler, this setting should point there | required |`postgresql://unicorn_user:magical_password@database:5432/calendso`|
249
-
| DATABASE_DIRECT_URL | direct database url with credentials if using a connection pooler (e.g. PgBouncer, Prisma Accelerate, etc.) | optional ||
| NEXT_PUBLIC_API_V2_URL | URL for the v2 API, only required for custom integrations or custom booking experiences using [Cal.com Platform](https://cal.com/platform) | optional ||
249
+
| CALCOM_TELEMETRY_DISABLED | Allow Cal.com to collect anonymous usage data (set to `1` to disable) | optional ||
250
+
| NEXT_PUBLIC_SINGLE_ORG_SLUG | Required if ORGANIZATIONS_ENABLED is true| optional ||
251
+
| ORGANIZATIONS_ENABLED | Used for Enterprise or Organizations plan | optional ||
0 commit comments