Introduction
This image can be found on DockerHub at https://hub.docker.com/r/calcom/cal.com. Note for ARM Users: Use the -arm suffix for pulling images. Example:docker pull calcom/cal.com:v5.6.19-arm
.
Contributing
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. If you want to contribute to the Docker repository, reply here. The Docker configuration can be found in our docker repository.Requirements
Make sure you havedocker
& docker compose
installed on the server / system.
Note: docker compose
without the hyphen is now the primary method of using docker-compose, per the Docker documentation.
Getting Started
-
Clone calcom-docker
-
Change into the directory
-
Prepare your configuration: Rename .env.example to .env and then update .env
Most configurations can be left as-is, but for configuration options see Important Run-time variables below. Update the appropriate values in your .env file, then proceed.
-
(optional) Pre-Pull the images by running the following command
-
Start Cal.com via docker compose
(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:
To run Cal.com web app and Prisma Studio against a remote database, ensure that DATABASE_URL is configured for an available database and run:To run only the Cal.com web app, ensure that DATABASE_URL is configured for an available database and run:
- Open a browser to 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!
Update Calcom Instance
-
Stop the Cal.com stack
-
Pull the latest changes
- Update environment variables as necessary.
-
Re-start the Cal.com stack
Configuration
Build-time variables
These variables must be provided at the time of the docker build, and can be provided by updating the .env file. Changing these is not required for evaluation, but may be required for running in production. Currently, if you require changes to these variables, you must follow the instructions to build and publish your own image.- NEXT_PUBLIC_WEBAPP_URL
- NEXT_PUBLIC_LICENSE_CONSENT
- NEXT_PUBLIC_TELEMETRY_KEY
Important Run-time variables
- NEXTAUTH_SECRET
Advanced Users - Building and Configuring
Check out the Cal.com Docker repository for more detailed instructions on how to build and configure your own Docker image.Troubleshooting
-
SSL edge termination: If running behind a load balancer which handles SSL certificates, you will need to add the environmental variable
NODE_TLS_REJECT_UNAUTHORIZED=0
to prevent requests from being rejected. Only do this if you know what you are doing and trust the services/load-balancers directing traffic to your service. -
Failed to commit changes: Invalid ‘prisma.user.create()’: Certain versions may have trouble creating a user if the field
metadata
is empty. Using an empty json object{}
as the field value should resolve this issue. Also, theid
field will autoincrement, so you may also try leaving the value ofid
as empty.
CLIENT_FETCH_ERROR
If you experience this error, it may be the way the default Auth callback in the server is using the WEBAPP_URL as a base url. The container does not necessarily have access to the same DNS as your local machine, and therefor needs to be configured to resolve to itself. You may be able to correct this by configuringNEXTAUTH_URL=http://localhost:3000/api/auth
, to help the backend loop back to itself.