diff --git a/.env.example b/.env.example index 3504c65..940a0a7 100644 --- a/.env.example +++ b/.env.example @@ -28,8 +28,8 @@ DATABASE_HOST=database:5432 DATABASE_URL=postgresql://${POSTGRES_USER}:${POSTGRES_PASSWORD}@${DATABASE_HOST}/${POSTGRES_DB} GOOGLE_API_CREDENTIALS={} -# Remove this var if you don't want Calendso to collect anonymous usage -NEXT_PUBLIC_TELEMETRY_KEY=js.2pvs2bbpqq1zxna97wcml.oi2jzirnbj1ev4tc57c5r +# Set this to '1' if you don't want Cal to collect anonymous usage +CALCOM_TELEMETRY_DISABLED= # Used for the Office 365 / Outlook.com Calendar integration MS_GRAPH_CLIENT_ID= diff --git a/Dockerfile b/Dockerfile index 8aa1151..e0dbbe1 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,21 +1,21 @@ FROM node:14 as builder WORKDIR /calcom -ARG NEXT_PUBLIC_WEBAPP_URL +ARG NEXT_PUBLIC_WEBAPP_URL=http://localhost:3000 ARG NEXT_PUBLIC_APP_URL ARG NEXT_PUBLIC_LICENSE_CONSENT -ARG NEXT_PUBLIC_TELEMETRY_KEY -ARG NEXTAUTH_SECRET -ARG CALENDSO_ENCRYPTION_KEY +ARG CALCOM_TELEMETRY_DISABLED ARG DATABASE_URL +ARG NEXTAUTH_SECRET=secret +ARG CALENDSO_ENCRYPTION_KEY=secret ENV NEXT_PUBLIC_WEBAPP_URL=$NEXT_PUBLIC_WEBAPP_URL \ NEXT_PUBLIC_APP_URL=$NEXT_PUBLIC_APP_URL \ NEXT_PUBLIC_LICENSE_CONSENT=$NEXT_PUBLIC_LICENSE_CONSENT \ - NEXT_PUBLIC_TELEMETRY_KEY=$NEXT_PUBLIC_TELEMETRY_KEY \ + CALCOM_TELEMETRY_DISABLED=$CALCOM_TELEMETRY_DISABLED \ + DATABASE_URL=$DATABASE_URL \ NEXTAUTH_SECRET=${NEXTAUTH_SECRET} \ - CALENDSO_ENCRYPTION_KEY=${CALENDSO_ENCRYPTION_KEY} \ - DATABASE_URL=$DATABASE_URL + CALENDSO_ENCRYPTION_KEY=${CALENDSO_ENCRYPTION_KEY} COPY calcom/package.json calcom/yarn.lock calcom/turbo.json ./ COPY calcom/apps/web ./apps/web diff --git a/README.md b/README.md index 25eceb6..cd4e7f6 100644 --- a/README.md +++ b/README.md @@ -106,17 +106,29 @@ Note: `docker compose` without the hyphen is now the primary method of using doc ### 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. +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. -* NEXT_PUBLIC_WEBAPP_URL -* NEXT_PUBLIC_LICENSE_CONSENT -* NEXT_PUBLIC_TELEMETRY_KEY -* DATABASE_URL +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) + +| Variable | Description | Required | Default | +| --- | --- | --- | --- | +| NEXT_PUBLIC_WEBAPP_URL | Base URL injected into static files | required | `http://localhost:3000` | +| NEXT_PUBLIC_LICENSE_CONSENT | license consent - true/false | | | +| CALCOM_TELEMETRY_DISABLED | Allow cal.com to collect anonymous usage data (set to `1` to disable) | | | +| DATABASE_URL | database url with credentials | required | `postgresql://unicorn_user:magical_password@database:5432/calendso` | +| NEXTAUTH_SECRET | Cookie encryption key | required | `secret` | +| CALENDSO_ENCRYPTION_KEY | Authentication encryption key | required | `secret` | ### Important Run-time variables -* NEXTAUTH_SECRET -* DATABASE_URL +These variables must also be provided at runtime + +| Variable | Description | Required | Default | +| --- | --- | --- | --- | +| CALCOM_LICENSE_KEY | Enterprise License Key | | | +| NEXTAUTH_SECRET | must match build variable | required | `secret` | +| CALENDSO_ENCRYPTION_KEY | must match build variable | required | `secret` | +| DATABASE_URL | database url with credentials | required | `postgresql://unicorn_user:magical_password@database:5432/calendso` | ## Git Submodules diff --git a/docker-compose.yaml b/docker-compose.yaml index d6d409d..3629b25 100644 --- a/docker-compose.yaml +++ b/docker-compose.yaml @@ -26,7 +26,7 @@ services: args: - NEXT_PUBLIC_WEBAPP_URL=${NEXT_PUBLIC_WEBAPP_URL} - NEXT_PUBLIC_LICENSE_CONSENT=${NEXT_PUBLIC_LICENSE_CONSENT} - - NEXT_PUBLIC_TELEMETRY_KEY=${NEXT_PUBLIC_TELEMETRY_KEY} + - CALCOM_TELEMETRY_DISABLED=${CALCOM_TELEMETRY_DISABLED} - NEXTAUTH_SECRET=${NEXTAUTH_SECRET} - CALENDSO_ENCRYPTION_KEY=${CALENDSO_ENCRYPTION_KEY} - DATABASE_URL=${DATABASE_URL}