Repository files navigation

The open-source Calendly successor.
Learn more »

Discussions ·Website ·Issues ·Roadmap

The open source Calendly successor. You are in chargeof your own data, workflow, and appearance.

Calendly and other scheduling tools are awesome. It made our lives massively easier. We're using it for business meetings, seminars, yoga classes, and even calls with our families. However, most tools are very limited in terms of control and customization.

That's where Cal.com comes in. Self-hosted or hosted by us. White-label by design. API-driven and ready to be deployed on your own domain. Full control of your events and data.

This project is tested with browserstack

• Next.js
• tRPC
• React.js
• Tailwind CSS
• Prisma.io
• Daily.co

Meet our sales team for any commercial inquiries.

Cal.com officially launched as v.1.0 on the 15th of September 2021 and we've come a long way so far. Watchreleases of this repository to be notified of future updates:

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

Here is what you need to be able to run Cal.com.

• 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 theintegrations section.

1. Clone the repo into a public GitHub repository (or forkhttps://github.com/calcom/cal.com/fork). If you plan to distribute the code, keep the source code public to comply withAGPLv3. To clone in a private repository,acquire a commercial license

   git clone https://github.com/calcom/cal.com.git

   If you are on Windows, run the following command ongitbash with admin privileges:
   >git clone -c core.symlinks=true https://github.com/calcom/cal.com.git
   Seedocs for more details.

2. Go to the project folder

   cd cal.com

3. Install packages with yarn

   yarn

4. Set up your.env file

   • Duplicate.env.example to.env
   • Useopenssl rand -base64 32 to generate a key and add it underNEXTAUTH_SECRET in the.env file.
   • Useopenssl rand -base64 32 to generate a key and add it underCALENDSO_ENCRYPTION_KEY in the.env file.

5. Setup NodeIf 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 fromhere.

• 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

1. Addexport 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.

2. AddNEXT_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 setNEXT_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 setNEXT_PUBLIC_LOGGER_LEVEL=2, it will log from level 2 (debug) upwards, meaning levels 2 (debug), 3 (info), 4 (warn), 5 (error), and (fatal) will be logged. \
   • If you setNEXT_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.

1. Click the button below to open this project in Gitpod.

2. This will open a fully configured workspace in your browser with all the necessary dependencies already installed.

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

   1. Download and install postgres in your local (if you don't have it already).

   2. Create your own local db by executingcreateDB <DB name>

   3. Now open your psql shell with the DB you created:psql -h localhost -U postgres -d <DB name>

   4. Inside the psql shell execute\conninfo. And you will get the following info.

   5. Now extract all the info and add it to your DATABASE_URL. The url would look something like thispostgresql://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.

   • Setup postgres DB with railway.app
   • Setup postgres DB with Northflank
   • Setup postgres DB with render

2. Copy and paste yourDATABASE_URL from.env to.env.appStore.

3. Set up the database using the Prisma schema (found inpackages/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

4. Runmailhog to view emails sent during development

   NOTE: Required whenE2E_TEST_MAILHOG_ENABLED is "1"

   docker pull mailhog/mailhogdocker run -d -p 8025:8025 -p 1025:1025 mailhog/mailhog

5. Run (in development mode)

   yarn dev

1. OpenPrisma Studio to look at or modify the database content:

   yarn db-studio

2. Click on theUser model to add a new user record.

3. Fill out the fieldsemail,username,password, and setmetadata to empty{} (remembering to encrypt your password withBCrypt) and clickSave 1 Record to create your first user.

   New users are set on aTRIAL plan by default. You might want to adjust this behavior to your needs in thepackages/prisma/schema.prisma file.

4. Open a browser tohttp://localhost:3000 and login with your just created, first user.

Seed the local db by running

cd packages/prismayarn db-seed

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

Be sure to set the environment variableNEXTAUTH_URL to the correct value. If you are running locally, as the documentation within.env.example mentions, the value should behttp://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

Runnpx playwright install to download test browsers and resolve the error below when runningyarn test-e2e:

Executable doesn't exist at /Users/alice/Library/Caches/ms-playwright/chromium-1048/chrome-mac/Chromium.app/Contents/MacOS/Chromium

1. Pull the current version:

   git pull

2. Check if dependencies got added/updated/removed

   yarn

3. Apply database migrations by runningone 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

4. Check for.env variables changes

   yarn predev

5. Start the server. In a development environment, just do:

   yarn dev

   For a production build, run for example:

   yarn buildyarn start

6. Enjoy the new version.

Official support: Our team will begin to officially support the Dockerfile and docker-compose resources in thisrepository.

Important: Cal.com willnot be supporting installations that use these Docker resources. While we provide and maintain the Docker configurations, support for Docker-based installations is the responsibility of the user.

This image can be found on DockerHub athttps://hub.docker.com/r/calcom/cal.com.

Note for ARM Users: Use the {version}-arm suffix for pulling images. Example:docker pull calcom/cal.com:v5.6.19-arm.

Make sure you havedocker &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.

If you are evaluating Cal.com or running with minimal to no modifications, this option is for you.

1. Clone calcom/cal.com

   git clone --recursive https://github.com/calcom/cal.com.git

2. Change into the directory

   cd cal.com

3. 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 seeImportant Run-time variables below.

   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 setNEXT_PUBLIC_VAPID_PUBLIC_KEY andVAPID_PRIVATE_KEY.

   Generate them with:

   npx web-push generate-vapid-keys

   Then update your.env file:

   NEXT_PUBLIC_VAPID_PUBLIC_KEY=your_public_key_hereVAPID_PRIVATE_KEY=your_private_key_here

   Donot commit real keys to.env.example — only placeholders.

   Update the appropriate values in your .env file, then proceed.

4. (optional) Pre-Pull the images by running the following command:

   docker compose pull

   This will use the default image locations as specified byimage: in the docker-compose.yaml file.

   Note: To aid with support, by default Scarf.sh is used as registry proxy for download metrics.

5. 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:

   docker compose up -d

   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:

   docker compose up -d calcom studio

   To run only the Cal.com 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.

6. Open a browser tohttp://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!

1. Stop the Cal.com stack

   docker compose down

2. Pull the latest changes

   docker compose pull

3. Update env vars as necessary.

4. Re-start the Cal.com stack

   docker compose up -d

1. Clone calcom/docker.

   git clone https://github.com/calcom/cal.com.git calcom-docker

2. Change into the directory

   cd calcom-docker

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.

   git submodule update --remote --init

   Note: DO NOT use recursive submodule update, otherwise you will receive a git authentication error.

4. Rename.env.example to.env and then update.env

   For configuration options seeBuild-time variables below. Update the appropriate values in your .env file, then proceed.

5. Build the Cal.com docker image:

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

   a) If hosting elsewhere, configure theDATABASE_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

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)

   DOCKER_BUILDKIT=0 docker compose build calcom

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

   docker compose up -d

   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:

   docker compose up -d calcom studio

   To run only the Cal.com 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.

8. Open a browser tohttp://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!

These variables must also be provided at runtime

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.

Updating these variables is not required for evaluation, but is required for running in production. Instructions for generating variables can be found in theCal.com instructions

If running behind a load balancer which handles SSL certificates, you will need to add the environmental variableNODE_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.

Certain versions may have trouble creating a user if the fieldmetadata 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.

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.

docker-calcom-1  | @calcom/web:start: [next-auth][error][CLIENT_FETCH_ERROR]docker-calcom-1  | @calcom/web:start: https://next-auth.js.org/errors#client_fetch_error request to http://testing.localhost:3000/api/auth/session failed, reason: getaddrinfo ENOTFOUND testing.localhost {docker-calcom-1  | @calcom/web:start:   error: {docker-calcom-1  | @calcom/web:start:     message: 'request to http://testing.localhost:3000/api/auth/session failed, reason: getaddrinfo ENOTFOUND testing.localhost',docker-calcom-1  | @calcom/web:start:     stack: 'FetchError: request to http://testing.localhost:3000/api/auth/session failed, reason: getaddrinfo ENOTFOUND testing.localhost\n' +docker-calcom-1  | @calcom/web:start:       '    at ClientRequest.<anonymous> (/calcom/node_modules/next/dist/compiled/node-fetch/index.js:1:65756)\n' +docker-calcom-1  | @calcom/web:start:       '    at ClientRequest.emit (node:events:513:28)\n' +docker-calcom-1  | @calcom/web:start:       '    at ClientRequest.emit (node:domain:489:12)\n' +docker-calcom-1  | @calcom/web:start:       '    at Socket.socketErrorListener (node:_http_client:494:9)\n' +docker-calcom-1  | @calcom/web:start:       '    at Socket.emit (node:events:513:28)\n' +docker-calcom-1  | @calcom/web:start:       '    at Socket.emit (node:domain:489:12)\n' +docker-calcom-1  | @calcom/web:start:       '    at emitErrorNT (node:internal/streams/destroy:157:8)\n' +docker-calcom-1  | @calcom/web:start:       '    at emitErrorCloseNT (node:internal/streams/destroy:122:3)\n' +docker-calcom-1  | @calcom/web:start:       '    at processTicksAndRejections (node:internal/process/task_queues:83:21)',docker-calcom-1  | @calcom/web:start:     name: 'FetchError'docker-calcom-1  | @calcom/web:start:   },docker-calcom-1  | @calcom/web:start:   url: 'http://testing.localhost:3000/api/auth/session',docker-calcom-1  | @calcom/web:start:   message: 'request to http://testing.localhost:3000/api/auth/session failed, reason: getaddrinfo ENOTFOUND testing.localhost'docker-calcom-1  | @calcom/web:start: }

You can deploy Cal.com onRailway using the button above. The team at Railway also have adetailed blog post on deploying Cal.com on their platform.

You can deploy Cal.com onNorthflank using the button above. The team at Northflank also have adetailed blog post on deploying Cal.com on their platform.

Currently Vercel Pro Plan is required to be able to Deploy this application with Vercel, due to limitations on the number of serverless functions on the free plan.

See theroadmap project for a list of proposed features (and known issues). You can change the view to see planned tagged releases.

Cal.com, Inc. is a commercial open source company, which means some parts of this open source repository require a commercial license. The concept is called "Open Core" where the core technology (99%) is fully open source, licensed underAGPLv3 and the last 1% is covered under a commercial license ("/ee" Enterprise Edition) which we believe is entirely relevant for larger organisations that require enterprise features. Enterprise features are built by the core engineering team of Cal.com, Inc. which is hired in full-time. Find their compensation onhttps://cal.com/open.

Please see ourcontributing guide.

We have a list ofhelp wanted that contain small features and bugs which have a relatively limited scope. This is a great place to get started, gain experience, and get familiar with our contribution process.

Don't code but still want to contribute? Join ourDiscussions and join the#Translate channel and let us know what language you want to translate.

• Set CSP_POLICY="non-strict" env variable, which enablesStrict CSP except for unsafe-inline in style-src . If you have some custom changes in your instance, you might have to make some code change to make your instance CSP compatible. Right now it enables strict CSP only on login page and on other SSR pages it is enabled in Report only mode to detect possible issues. On, SSG pages it is still not supported.

Refer to docshere for a detailed documentation with screenshots.

1. OpenGoogle API Console. If you don't have a project in your Google Cloud subscription, you'll need to create one before proceeding further. Under Dashboard pane, select Enable APIS and Services.
2. In the search box, type calendar and select the Google Calendar API search result.
3. Enable the selected API.
4. Next, go to theOAuth consent screen from the side pane. Select the app type (Internal or External) and enter the basic app details on the first page.
5. In the second page on Scopes, select Add or Remove Scopes. Search for Calendar.event and select the scope with scope value.../auth/calendar.events,.../auth/calendar.readonly and select Update.
6. In the third page (Test Users), add the Google account(s) you'll be using. Make sure the details are correct on the last page of the wizard and your consent screen will be configured.
7. Now selectCredentials from the side pane and then select Create Credentials. Select the OAuth Client ID option.
8. Select Web Application as the Application Type.
9. Under Authorized redirect URI's, select Add URI and then add the URI<Cal.com URL>/api/integrations/googlecalendar/callback and<Cal.com URL>/api/auth/callback/google replacing Cal.com URL with the URI at which your application runs.
10. The key will be created and you will be redirected back to the Credentials page. Select the newly generated client ID under OAuth 2.0 Client IDs.
11. Select Download JSON. Copy the contents of this file and paste the entire JSON string in the.env file as the value forGOOGLE_API_CREDENTIALS key.

After adding Google credentials, you can now Google Calendar App to the app store.You can repopulate the App store by running

cd packages/prismayarn seed-app-store

You will need to complete a few more steps to activate Google Calendar App.Make sure to complete section "Obtaining the Google API Credentials". After that do thefollowing

1. Add extra redirect URL<Cal.com URL>/api/auth/callback/google
2. Under 'OAuth consent screen', click "PUBLISH APP"

1. OpenAzure App Registration and select New registration
2. Name your application
3. SetWho can use this application or access this API? toAccounts in any organizational directory (Any Azure AD directory - Multitenant)
4. Set theWeb redirect URI to<Cal.com URL>/api/integrations/office365calendar/callback replacing Cal.com URL with the URI at which your application runs.
5. UseApplication (client) ID as theMS_GRAPH_CLIENT_ID attribute value in .env
6. ClickCertificates & secrets create a new client secret and use the value as theMS_GRAPH_CLIENT_SECRET attribute

1. OpenZoom Marketplace and sign in with your Zoom account.
2. On the upper right, click "Develop" => "Build App".
3. Select "General App" , click "Create".
4. Name your App.
5. Choose "User-managed app" for "Select how the app is managed".
6. De-select the option to publish the app on the Zoom App Marketplace, if asked.
7. Now copy the Client ID and Client Secret to your.env file into theZOOM_CLIENT_ID andZOOM_CLIENT_SECRET fields.
8. Set the "OAuth Redirect URL" under "OAuth Information" as<Cal.com URL>/api/integrations/zoomvideo/callback replacing Cal.com URL with the URI at which your application runs.
9. Also add the redirect URL given above as an allow list URL and enable "Subdomain check". Make sure, it says "saved" below the form.
10. You don't need to provide basic information about your app. Instead click on "Scopes" and then on "+ Add Scopes". On the left,
    1. click the category "Meeting" and check the scopemeeting:write:meeting.
    2. click the category "User" and check the scopeuser:read:settings.
11. Click "Done".
12. You're good to go. Now you can easily add your Zoom integration in the Cal.com settings.

1. Visit ourDaily.co Partnership Form and enter your information
2. From within your dashboard, go to thedevelopers tab.
3. Copy your API key.
4. Now paste the API key to your.env file into theDAILY_API_KEY field in your.env file.
5. If you have theDaily Scale Plan set theDAILY_SCALE_PLAN variable totrue in order to use features like video recording.

1. Visit the37 Signals Integrations Dashboard and sign in.
2. Register a new application by clicking the Register one now link.
3. Fill in your company details.
4. Select Basecamp 4 as the product to integrate with.
5. Set the Redirect URL for OAuth<Cal.com URL>/api/integrations/basecamp3/callback replacing Cal.com URL with the URI at which your application runs.
6. Click on done and copy the Client ID and secret into theBASECAMP3_CLIENT_ID andBASECAMP3_CLIENT_SECRET fields.
7. Set theBASECAMP3_CLIENT_SECRET env variable to{your_domain} ({support_email}).For example,Cal.com (support@cal.com).

1. OpenHubSpot Developer and sign into your account, or create a new one.
2. From within the home of the Developer account page, go to "Manage apps".
3. Click "Create app" button top right.
4. Fill in any information you want in the "App info" tab
5. Go to tab "Auth"
6. Now copy the Client ID and Client Secret to your.env file into theHUBSPOT_CLIENT_ID andHUBSPOT_CLIENT_SECRET fields.
7. Set the Redirect URL for OAuth<Cal.com URL>/api/integrations/hubspot/callback replacing Cal.com URL with the URI at which your application runs.
8. In the "Scopes" section at the bottom of the page, make sure you select "Read" and "Write" for scope calledcrm.objects.contacts
9. Click the "Save" button at the bottom footer.
10. You're good to go. Now you can see any booking in Cal.com created as a meeting in HubSpot for your contacts.

See Webex Readme

1. OpenZoho API Console and sign into your account, or create a new one.
2. From within the API console page, go to "Applications".
3. Click "ADD CLIENT" button top right and select "Server-based Applications".
4. Fill in any information you want in the "Client Details" tab
5. Go to tab "Client Secret" tab.
6. Now copy the Client ID and Client Secret to your.env file into theZOHOCRM_CLIENT_ID andZOHOCRM_CLIENT_SECRET fields.
7. Set the Redirect URL for OAuth<Cal.com URL>/api/integrations/zohocrm/callback replacing Cal.com URL with the URI at which your application runs.
8. In the "Settings" section check the "Multi-DC" option if you wish to use the same OAuth credentials for all data centers.
9. Click the "Save"/ "UPDATE" button at the bottom footer.
10. You're good to go. Now you can easily add your ZohoCRM integration in the Cal.com settings.

Follow these steps

Follow these steps

Follow these steps

1. Create a SendGrid account (https://signup.sendgrid.com/)
2. Go to Settings -> API keys and create an API key
3. Copy API key to your.env file into theSENDGRID_API_KEY field
4. Go to Settings -> Sender Authentication and verify a single sender
5. Copy the verified E-Mail to your.env file into theSENDGRID_EMAIL field
6. Add your custom sender name to the.env file into theNEXT_PUBLIC_SENDGRID_SENDER_NAME field (fallback is Cal.com)

1. Create a Twilio account (https://twilio.com/try-twilio)
2. Click ‘Get a Twilio phone number’
3. Copy Account SID to your.env file into theTWILIO_SID field
4. Copy Auth Token to your.env file into theTWILIO_TOKEN field
5. Copy your Twilio phone number to your.env file into theTWILIO_PHONE_NUMBER field
6. Add your own sender ID to the.env file into theNEXT_PUBLIC_SENDER_ID field (fallback is Cal.com)
7. Create a messaging service (Develop -> Messaging -> Services)
8. Choose any name for the messaging service
9. Click 'Add Senders'
10. Choose phone number as sender type
11. Add the listed phone number
12. Leave all other fields as they are
13. Complete setup and click ‘View my new Messaging Service’
14. Copy Messaging Service SID to your.env file into theTWILIO_MESSAGING_SID field
15. Create a verify service
16. Copy Verify Service SID to your.env file into theTWILIO_VERIFY_SID field

We use changesets to generate changelogs and publish public packages (packages withprivate: true are ignored).

An example of good readme isatoms readme. Every public package must:

1. Follow semantic versioning when using changesets.
2. Mark breaking changes using❗️Breaking change

Distributed under theAGPLv3 License. SeeLICENSE for more information.

Special thanks to these amazing projects which help power Cal.com:

• Vercel
• Next.js
• Day.js
• Tailwind CSS
• Prisma

Cal.com is anopen startup andJitsu (an open-source Segment alternative) helps us to track most of the usage metrics.