[!WARNING]
Use at your own risk. Cal.diy is the open source community edition of Cal.com and it is intended for users who want to self-host their own Cal.diy instance. It is strictly recommended for personal, non-production use. Please review all installation and configuration steps carefully. Self-hosting requires advanced knowledge of server administration, database management, and securing sensitive data. Proceed only if you are comfortable with these responsibilities.
[!TIP]
For any commercial and enterprise-ready scheduling infrastructure, use Cal.com, not Cal.diy; hosted by us or get invited to on-prem enterprise access here: https://cal.com/sales
Cal.diy
The community-driven, open-source scheduling platform.
GitHub
Issues
·
Contributing
About Cal.diy
Cal.diy is the community-driven, fully open-source scheduling platform — a fork of Cal.com with all enterprise/commercial code removed.
Cal.diy is 100% MIT-licensed with no proprietary "Enterprise Edition" features. It's designed for individuals and self-hosters who want full control over their scheduling infrastructure without any commercial dependencies.
What's different from Cal.com?
- No enterprise features — Teams, Organizations, Insights, Workflows, SSO/SAML, and other EE-only features have been removed
- No license key required — Everything works out of the box, no Cal.com account or license needed
- 100% open source — The entire codebase is licensed under MIT, no "Open Core" split
- Community-maintained — Contributions are welcome and go directly into this project (see CONTRIBUTING.md)
Note: Cal.diy is a self-hosted project. There is no hosted/managed version. You run it on your own infrastructure.
Built With
Getting Started
To get a local copy up and running, please follow these simple steps.
Prerequisites
Here’s what you need to run Cal.diy.
- Node.js (Version: >=18.x)
- PostgreSQL (Version: >=13.x)
- Yarn (recommended)
If you want to enable any of the available integrations, you may want to obtain additional credentials for each one. More details on this can be found below under the integrations section.
Development
Setup
Clone the repo (or fork https://github.com/calcom/cal.diy/fork)
git clone https://github.com/calcom/cal.diy.git
If you are on Windows, run the following command in Git Bash with admin privileges:
git clone -c core.symlinks=true https://github.com/calcom/cal.diy.git
Go to the project folder
cd cal.diy
Install packages with yarn
yarn
Set up your .env file
- Duplicate
.env.example to .env
- Use
openssl rand -base64 32 to generate a key and add it under NEXTAUTH_SECRET in the .env file.
- Use
openssl rand -base64 24 to generate a key and add it under CALENDSO_ENCRYPTION_KEY in the .env file.
Windows users: Replace the packages/prisma/.env symlink with a real copy to avoid a Prisma error (unexpected character / in variable name):
# Git Bash / WSL
rm packages/prisma/.env && cp .env packages/prisma/.env
Set up Node
If your Node version does not meet the project's requirements as instructed by the docs, "nvm" (Node Version Manager) allows using Node at the version required by the project:
nvm use
You first might need to install the specific version and then use it:
nvm install && nvm use
You can install nvm from here.
Quick start with yarn dx
- Requires Docker and Docker Compose to be installed
- Will start a local Postgres instance with a few test users - the credentials will be logged in the console
yarn dx
Default credentials created:
You can use any of these credentials to sign in at http://localhost:3000
Tip: To view the full list of seeded users and their details, run yarn db-studio and visit http://localhost:5555
Development tip
Add export NODE_OPTIONS="--max-old-space-size=16384" to your shell script to increase the memory limit for the node process. Alternatively, you can run this in your terminal before running the app. Replace 16384 with the amount of RAM you want to allocate to the node process.
Add NEXT_PUBLIC_LOGGER_LEVEL={level} to your .env file to control the logging verbosity for all tRPC queries and mutations.
Where {level} can be one of the following:
0 for silly
1 for trace
2 for debug
3 for info
4 for warn
5 for error
6 for fatal
When you set NEXT_PUBLIC_LOGGER_LEVEL={level} in your .env file, it enables logging at that level and higher. Here's how it works:
The logger will include all logs that are at the specified level or higher. For example: \
- If you set
NEXT_PUBLIC_LOGGER_LEVEL=2, it will log from level 2 (debug) upwards, meaning levels 2 (debug), 3 (info), 4 (warn), 5 (error), and 6 (fatal) will be logged. \
- If you set
NEXT_PUBLIC_LOGGER_LEVEL=3, it will log from level 3 (info) upwards, meaning levels 3 (info), 4 (warn), 5 (error), and 6 (fatal) will be logged, but level 2 (debug) and level 1 (trace) will be ignored. \
echo 'NEXT_PUBLIC_LOGGER_LEVEL=3' >> .env
for Logger level to be set at info, for example.
Gitpod Setup
Click the button below to open this project in Gitpod.
This will open a fully configured workspace in your browser with all the necessary dependencies already installed.
Manual setup
Configure environment variables in the .env file. Replace <user>, <pass>, <db-host>, and <db-port> with their applicable values
DATABASE_URL='postgresql://<user>:<pass>@<db-host>:<db-port>'
If you don't know how to configure the DATABASE_URL, then follow the steps here to create a quick local DB
Download and install PostgreSQL locally (if you don't have it already).
Create your own local db by executing createDB <DB name>
Now open your psql shell with the DB you created: psql -h localhost -U postgres -d <DB name>
Inside the psql shell execute \conninfo. And you will get the following info.
Now extract all the info and add it to your DATABASE_URL. The url would look something like this
postgresql://postgres:postgres@localhost:5432/Your-DB-Name. The port is configurable and does not have to be 5432.
If you don't want to create a local DB. Then you can also consider using services like railway.app, Northflank or render.
Copy and paste your DATABASE_URL from .env to .env.appStore.
Set up the database using the Prisma schema (found in packages/prisma/schema.prisma)
In a development environment, run:
yarn workspace @calcom/prisma db-migrate
In a production environment, run:
yarn workspace @calcom/prisma db-deploy
Note for Windows/PowerShell users: If running the database deployment scripts fails with an error stating Environment variable not found: DATABASE_DIRECT_URL, Turbo might be failing to inject the root .env variables. You can bypass this by executing the commands directly from the prisma package directory in PowerShell:
cd packages/prisma
$env:DATABASE_URL="postgresql://postgres:YOUR_PASSWORD@localhost:5432/postgres"; $env:DATABASE_DIRECT_URL="postgresql://postgres:YOUR_PASSWORD@localhost:5432/postgres"
npx prisma db push
cd ../..
Run mailhog to view emails sent during development
NOTE: Required when E2E_TEST_MAILHOG_ENABLED is "1"
docker pull mailhog/mailhog
docker run -d -p 8025:8025 -p 1025:1025 mailhog/mailhog
Run (in development mode)
yarn dev
Setting up your first user
Approach 1
Open Prisma Studio to look at or modify the database content:
yarn db-studio
Click on the User model to add a new user record.
Fill out the fields email, username, password, and set metadata to empty {} (remembering to encrypt your password with BCrypt) and click Save 1 Record to create your first user.
New users are set on a TRIAL plan by default. You might want to adjust this behavior to your needs in the packages/prisma/schema.prisma file.
Open a browser to http://localhost:3000 and login with your just created, first user.
Approach 2
Seed the local db by running
cd packages/prisma
yarn db-seed
The above command will populate the local db with dummy users.
E2E-Testing
Be sure to set the environment variable NEXTAUTH_URL to the correct value. If you are running locally, as the documentation within .env.example mentions, the value should be http://localhost:3000.
# In a terminal just run:
yarn test-e2e
# To open the last HTML report run:
yarn playwright show-report test-results/reports/playwright-html-report
Resolving issues
E2E test browsers not installed
Run npx playwright install to download test browsers and resolve the error below when running yarn test-e2e:
Executable doesn't exist at /Users/alice/Library/Caches/ms-playwright/chromium-1048/chrome-mac/Chromium.app/Contents/MacOS/Chromium
Upgrading from earlier versions
Pull the current version:
git pull
Check if dependencies got added/updated/removed
yarn
Apply database migrations by running one of the following commands:
In a development environment, run:
yarn workspace @calcom/prisma db-migrate
(This can clear your development database in some cases)
In a production environment, run:
yarn workspace @calcom/prisma db-deploy
Check for .env variables changes
yarn predev
Start the server. In a development environment, just do:
yarn dev
For a production build, run for example:
yarn build
yarn start
Enjoy the new version.
Deployment
Docker
The Docker image can be found on DockerHub at https://hub.docker.com/r/calcom/cal.diy.
Note for ARM Users: Use the {version}-arm suffix for pulling images. Example: docker pull calcom/cal.diy:v5.6.19-arm.
Requirements
Make sure you have docker & docker compose installed on the server / system. Both are installed by most docker utilities, including Docker Desktop and Rancher Desktop.
Note: docker compose without the hyphen is now the primary method of using docker-compose, per the Docker documentation.
Running Cal.diy with Docker Compose
Clone the repository
git clone --recursive https://github.com/calcom/cal.diy.git
Change into the directory
cd cal.diy
Prepare your configuration: Rename .env.example to .env and then update .env
cp .env.example .env
Most configurations can be left as-is, but for configuration options see Important Run-time variables below.
Required Secret Keys
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.
Generate NEXTAUTH_SECRET (cookie encryption key):
openssl rand -base64 32
Generate CALENDSO_ENCRYPTION_KEY (must be 32 bytes for AES256):
openssl rand -base64 24
Update your .env file with these values:
NEXTAUTH_SECRET=<your_generated_secret>
CALENDSO_ENCRYPTION_KEY=<your_generated_key>
Push Notifications (VAPID Keys)
If you see an error like:
Error: No key set vapidDetails.publicKey
This means your environment variables for Web Push are missing.
You must generate and set NEXT_PUBLIC_VAPID_PUBLIC_KEY and VAPID_PRIVATE_KEY.
Generate them with:
npx web-push generate-vapid-keys
Then update your .env file:
NEXT_PUBLIC_VAPID_PUBLIC_KEY=your_public_key_here
VAPID_PRIVATE_KEY=your_private_key_here
Do not commit real keys to .env.example — only placeholders.
Update the appropriate values in your .env file, then proceed.
(optional) Pre-Pull the images by running the following command:
docker compose pull
Start Cal.diy via docker compose
To run the complete stack, which includes a local Postgres database, Cal.diy web app, and Prisma Studio:
docker compose up -d
To run Cal.diy web app and Prisma Studio against a remote database, ensure that DATABASE_URL is configured for an available database and run:
docker compose up -d calcom studio
To run only the Cal.diy web app, ensure that DATABASE_URL is configured for an available database and run:
docker compose up -d calcom
Note: to run in attached mode for debugging, remove -d from your desired run command.
Open a browser to http://localhost:3000, or your defined NEXT_PUBLIC_WEBAPP_URL. The first time you run Cal.diy, a setup wizard will initialize. Define your first user, and you're ready to go!
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.
Updating Cal.diy
Stop the Cal.diy stack
docker compose down
Pull the latest changes
docker compose pull
Update env vars as necessary.
Re-start the Cal.diy stack
docker compose up -d
Building from source with Docker
Clone the repository
git clone https://github.com/calcom/cal.diy.git
Change into the directory
cd cal.diy
Rename .env.example to .env and then update .env
For configuration options see Build-time variables below. Update the appropriate values in your .env file, then proceed.
Build the Cal.diy docker image:
Note: Due to application configuration requirements, an available database is currently required during the build process.
a) If hosting elsewhere, configure the DATABASE_URL in the .env file, and skip the next step
b) If a local or temporary database is required, start a local database via docker compose.
docker compose up -d database
Build Cal.diy 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)
DOCKER_BUILDKIT=0 docker compose build calcom
Start Cal.diy via docker compose
To run the complete stack, which includes a local Postgres database, Cal.diy web app, and Prisma Studio:
docker compose up -d
To run Cal.diy web app and Prisma Studio against a remote database, ensure that DATABASE_URL is configured for an available database and run:
docker compose up -d calcom studio
To run only the Cal.diy web app, ensure that DATABASE_URL is configured for an available database and run:
docker compose up -d calcom
Note: to run in attached mode for debugging, remove -d from your desired run command.
Open a browser to http://localhost:3000, or your defined NEXT_PUBLIC_WEBAPP_URL. The first time you run Cal.diy, a setup wizard will initialize. Define your first user, and you're ready to go!
Configuration
Important Run-time variables
These variables must also be provided at runtime
| Variable |
Description |
Required |
Default |
| 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 |
| NEXTAUTH_URL |
Location of the auth server. By default, this is the Cal.diy docker instance itself. |
optional |
{NEXT_PUBLIC_WEBAPP_URL}/api/auth |
| NEXTAUTH_SECRET |
Cookie encryption key. Must match build variable. Generate with: openssl rand -base64 32 |
required |
secret |
| CALEN |
|
|
|
Cal.diy 是 Cal.com 的开源社区版，一个可自行托管的预约调度平台，用于预约和管理日历。