Skip to content
This repository was archived by the owner on Oct 29, 2025. It is now read-only.

Commit 4d6a0c4

Browse files
keithwillcodedevin-ai-integration[bot]
keithwillcode
and
devin-ai-integration[bot]
authored
docs: add archive notice to README (#478)
* docs: add archive notice to README This repository has been archived. Docker resources have been moved to the main cal.com monorepo at calcom/cal.com. The team will officially support the Dockerfile and docker-compose resources in the main repository, but Cal.com will not be supporting installations that use these Docker resources. Co-Authored-By: keith@cal.com <keithwillcode@gmail.com> * docs: replace README content with archive notice only Keep only the header/logo section and archive notice. Remove all previous documentation content as the repository has been archived and Docker resources have moved to the main cal.com monorepo. Co-Authored-By: keith@cal.com <keithwillcode@gmail.com> * Update README.md --------- Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
1 parent d0a0299 commit 4d6a0c4

File tree

1 file changed

+8
-271
lines changed

1 file changed

+8
-271
lines changed

‎README.md‎

Lines changed: 8 additions & 271 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
</a>
77

8-
<h3 align="center">Cal.com (formerly Calendso)</h3>
8+
<h3 align="center">Cal.com</h3>
99

1010
<p align="center">
1111
The open-source Calendly alternative. (Docker Edition)
@@ -19,282 +19,19 @@
1919
·
2020
<a href="https://github.com/calcom/cal.com/issues">Core Cal.com related Issues</a>
2121
·
22-
<a href="https://github.com/calcom/docker/issues">Docker specific Issues</a>
23-
·
2422
<a href="https://cal.com/roadmap">Roadmap</a>
2523
</p>
2624
</p>
2725

28-
# Important Notes
29-
30-
Support for this image can be found via the repository, located at [https://github.com/calcom/docker](https://github.com/calcom/docker)
31-
32-
# Docker
33-
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).
35-
36-
**Note for ARM Users**: Use the {version}-arm suffix for pulling images. Example: `docker pull calcom/cal.com:v5.6.19-arm`.
37-
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.
39-
40-
## Requirements
41-
42-
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.
43-
44-
Note: `docker compose` without the hyphen is now the primary method of using docker-compose, per the Docker documentation.
45-
46-
## (Most users) Running Cal.com with Docker Compose
47-
48-
If you are evaluating Cal.com or running with minimal to no modifications, this option is for you.
49-
50-
1. Clone calcom/docker.
51-
52-
```bash
53-
git clone --recursive https://github.com/calcom/docker.git
54-
```
55-
56-
2. Change into the directory
57-
58-
```bash
59-
cd docker
60-
```
61-
62-
3. Prepare your configuration: Rename `.env.example` to `.env` and then update `.env`
63-
64-
```bash
65-
cp .env.example .env
66-
```
67-
68-
Most configurations can be left as-is, but for configuration options see [Important Run-time variables](#important-run-time-variables) below.
69-
70-
**Push Notifications (VAPID Keys)**
71-
If you see an error like:
72-
73-
```
74-
Error: No key set vapidDetails.publicKey
75-
```
76-
77-
This means your environment variables for Web Push are missing.
78-
You must generate and set `NEXT_PUBLIC_VAPID_PUBLIC_KEY` and `VAPID_PRIVATE_KEY`.
79-
80-
Generate them with:
81-
```bash
82-
npx web-push generate-vapid-keys
83-
```
84-
85-
Then update your `.env` file:
86-
```env
87-
NEXT_PUBLIC_VAPID_PUBLIC_KEY=your_public_key_here
88-
VAPID_PRIVATE_KEY=your_private_key_here
89-
```
90-
91-
Do **not** commit real keys to `.env.example` — only placeholders.
92-
93-
Update the appropriate values in your .env file, then proceed.
94-
95-
4. (optional) Pre-Pull the images by running the following command:
96-
97-
```bash
98-
docker compose pull
99-
```
100-
101-
This will use the default image locations as specified by `image:` in the docker-compose.yaml file.
102-
103-
Note: To aid with support, by default Scarf.sh is used as registry proxy for download metrics.
104-
105-
5. Start Cal.com via docker compose
106-
107-
(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:
108-
109-
```bash
110-
docker compose up -d
111-
```
112-
113-
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:
114-
115-
```bash
116-
docker compose up -d calcom studio
117-
```
118-
119-
To run only the Cal.com web app, ensure that DATABASE_URL is configured for an available database and run:
120-
121-
```bash
122-
docker compose up -d calcom
123-
```
124-
125-
**Note: to run in attached mode for debugging, remove `-d` from your desired run command.**
126-
127-
6. Open a browser to [http://localhost:3000](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!
128-
129-
## Updating Cal.com
130-
131-
1. Stop the Cal.com stack
132-
133-
```bash
134-
docker compose down
135-
```
136-
137-
2. Pull the latest changes
138-
139-
```bash
140-
docker compose pull
141-
```
142-
3. Update env vars as necessary.
143-
4. Re-start the Cal.com stack
144-
145-
```bash
146-
docker compose up -d
147-
```
148-
149-
## (Advanced users) Build and Run Cal.com
150-
151-
1. Clone calcom/docker.
152-
153-
```bash
154-
git clone https://github.com/calcom/docker.git calcom-docker
155-
```
156-
157-
2. Change into the directory
158-
159-
```bash
160-
cd calcom-docker
161-
```
162-
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.
164-
165-
```bash
166-
git submodule update --remote --init
167-
```
168-
169-
Note: DO NOT use recursive submodule update, otherwise you will receive a git authentication error.
170-
171-
4. Rename `.env.example` to `.env` and then update `.env`
172-
173-
For configuration options see [Build-time variables](#build-time-variables) below. Update the appropriate values in your .env file, then proceed.
174-
175-
5. Build the Cal.com docker image:
176-
177-
Note: Due to application configuration requirements, an available database is currently required during the build process.
178-
179-
a) If hosting elsewhere, configure the `DATABASE_URL` in the .env file, and skip the next step
180-
181-
b) If a local or temporary database is required, start a local database via docker compose.
182-
183-
```bash
184-
docker compose up -d database
185-
```
186-
187-
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)
188-
189-
```bash
190-
DOCKER_BUILDKIT=0 docker compose build calcom
191-
```
192-
193-
7. Start Cal.com via docker compose
194-
195-
(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:
196-
197-
```bash
198-
docker compose up -d
199-
```
200-
201-
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:
202-
203-
```bash
204-
docker compose up -d calcom studio
205-
```
206-
207-
To run only the Cal.com web app, ensure that DATABASE_URL is configured for an available database and run:
208-
209-
```bash
210-
docker compose up -d calcom
211-
```
212-
213-
**Note: to run in attached mode for debugging, remove `-d` from your desired run command.**
214-
215-
8. Open a browser to [http://localhost:3000](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!
216-
217-
## Configuration
218-
219-
### Important Run-time variables
220-
221-
These variables must also be provided at runtime
222-
223-
| Variable | Description | Required | Default |
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` |
226-
| CALCOM_LICENSE_KEY | Enterprise License Key | optional | |
227-
| 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` |
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` |
229-
| NEXTAUTH_SECRET | must match build variable | required | `secret` |
230-
| CALENDSO_ENCRYPTION_KEY | must match build variable | required | `secret` |
231-
232-
### Build-time variables
233-
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.
235-
236-
Updating these variables is not required for evaluation, but is required for running in production. Instructions for generating variables can be found in the [Cal.com instructions](https://github.com/calcom/cal.com)
237-
238-
| Variable | Description | Required | Default |
239-
| --- | --- | --- | --- |
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` |
241-
| MAX_OLD_SPACE_SIZE | Needed for Nodejs/NPM build options | required | 4096 |
242-
| NEXT_PUBLIC_LICENSE_CONSENT | license consent - true/false | required | |
243-
| NEXTAUTH_SECRET | Cookie encryption key | required | `secret` |
244-
| CALENDSO_ENCRYPTION_KEY | Authentication encryption key | required | `secret` |
245-
| NEXT_PUBLIC_WEBAPP_URL | Base URL injected into static files | optional | `http://localhost:3000` |
246-
| NEXT_PUBLIC_WEBSITE_TERMS_URL | custom URL for terms and conditions website | optional | `https://cal.com/terms` |
247-
| NEXT_PUBLIC_WEBSITE_PRIVACY_POLICY_URL | custom URL for privacy policy website | optional | `https://cal.com/privacy` |
248-
| 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 | |
252-
253-
## Git Submodules
254-
255-
This repository uses a git submodule.
256-
257-
For users building their own images, to update the calcom submodule, use the following command:
258-
259-
```bash
260-
git submodule update --remote --init
261-
```
262-
263-
For more advanced usage, please refer to the git documentation: [https://git-scm.com/book/en/v2/Git-Tools-Submodules](https://git-scm.com/book/en/v2/Git-Tools-Submodules)
264-
265-
## Troubleshooting
266-
267-
### SSL edge termination
268-
269-
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.
26+
---
27027

271-
### Failed to commit changes: Invalid 'prisma.user.create()'
28+
# 🚨 REPOSITORY ARCHIVED
27229

273-
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, the `id` field will autoincrement, so you may also try leaving the value of `id` as empty.
30+
**This repository has been archived.** Docker resources for Cal.com have been moved into the main monorepo at [calcom/cal.com](https://github.com/calcom/cal.com).
27431

275-
### CLIENT_FETCH_ERROR
32+
## What This Means
27633

277-
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 configuring `NEXTAUTH_URL=http://localhost:3000/api/auth`, to help the backend loop back to itself.
278-
```
279-
docker-calcom-1 | @calcom/web:start: [next-auth][error][CLIENT_FETCH_ERROR]
280-
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 {
281-
docker-calcom-1 | @calcom/web:start: error: {
282-
docker-calcom-1 | @calcom/web:start: message: 'request to http://testing.localhost:3000/api/auth/session failed, reason: getaddrinfo ENOTFOUND testing.localhost',
283-
docker-calcom-1 | @calcom/web:start: stack: 'FetchError: request to http://testing.localhost:3000/api/auth/session failed, reason: getaddrinfo ENOTFOUND testing.localhost\n' +
284-
docker-calcom-1 | @calcom/web:start: ' at ClientRequest.<anonymous> (/calcom/node_modules/next/dist/compiled/node-fetch/index.js:1:65756)\n' +
285-
docker-calcom-1 | @calcom/web:start: ' at ClientRequest.emit (node:events:513:28)\n' +
286-
docker-calcom-1 | @calcom/web:start: ' at ClientRequest.emit (node:domain:489:12)\n' +
287-
docker-calcom-1 | @calcom/web:start: ' at Socket.socketErrorListener (node:_http_client:494:9)\n' +
288-
docker-calcom-1 | @calcom/web:start: ' at Socket.emit (node:events:513:28)\n' +
289-
docker-calcom-1 | @calcom/web:start: ' at Socket.emit (node:domain:489:12)\n' +
290-
docker-calcom-1 | @calcom/web:start: ' at emitErrorNT (node:internal/streams/destroy:157:8)\n' +
291-
docker-calcom-1 | @calcom/web:start: ' at emitErrorCloseNT (node:internal/streams/destroy:122:3)\n' +
292-
docker-calcom-1 | @calcom/web:start: ' at processTicksAndRejections (node:internal/process/task_queues:83:21)',
293-
docker-calcom-1 | @calcom/web:start: name: 'FetchError'
294-
docker-calcom-1 | @calcom/web:start: },
295-
docker-calcom-1 | @calcom/web:start: url: 'http://testing.localhost:3000/api/auth/session',
296-
docker-calcom-1 | @calcom/web:start: message: 'request to http://testing.localhost:3000/api/auth/session failed, reason: getaddrinfo ENOTFOUND testing.localhost'
297-
docker-calcom-1 | @calcom/web:start: }
298-
```
34+
- **Docker resources are now maintained in the main Cal.com repository**: All Dockerfile and docker-compose configurations are now part of the [calcom/cal.com](https://github.com/calcom/cal.com) monorepo.
35+
- **Official support**: Our team will begin to officially support the Dockerfile and docker-compose resources in the main repository.
36+
- **Important**: Cal.com will **not** 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.
29937

300-
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=81cda9f7-a102-453b-ac01-51c35650bd70" />

0 commit comments

Comments
 (0)