Cal.diy: open-source community edition of cal.com

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

The community-driven, open-source scheduling platform.

GitHub

Discussions · Issues · Contributing

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.

No enterprise features— Teams, Organizations, Insights, Workflows, SSO/SAML, and other EE-only features have been removedNo license key required— Everything works out of the box, no Cal.com account or license needed100% open source— The entire codebase is licensed under MIT, no "Open Core" splitCommunity-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.

To get a local copy up and running, please follow these simple steps.

Here is what you need to be able 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.

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 on

gitbash

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 underNEXTAUTH_SECRET

in the.env

file. - Use openssl rand -base64 24

to generate a key and add it underCALENDSO_ENCRYPTION_KEY

in the.env

file.

• Duplicate

Windows users:Replace thepackages/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

Setup 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.

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:

| Password | Role | | |---|---|---| [email protected] | free | Free user | [email protected] | pro | Pro user | [email protected] | trial | Trial user | [email protected] | ADMINadmin2022! | Admin user | [email protected] | onboarding | Onboarding incomplete |

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, runyarn db-studio

and visit http://localhost:5555

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 fatalWhen 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. \

• If you set

echo 'NEXT_PUBLIC_LOGGER_LEVEL=3' >> .env

for Logger level to be set at info, for example.

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.

Configure environment variables in the

.env

file. Replace<user>

,<pass>

,<db-host>

, and<db-port>

with their applicable valuesDATABASE_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 postgres in your local (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

Run mailhog to view emails sent during development

Required whenNOTE: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

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 setmetadata

to empty{}

(remembering to encrypt your password with BCrypt) and clickSave 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 thepackages/prisma/schema.prisma

file. - Open a browser to http://localhost:3000 and login with your just created, first user.

Seed the local db by running

cd packages/prisma
yarn db-seed

The above command will populate the local db with dummy users.

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/rep