Skip to content

Commit

Permalink
update variable descriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
krumware committed Jun 15, 2022
1 parent 9229e0d commit 323bff9
Showing 1 changed file with 16 additions and 6 deletions.
22 changes: 16 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,16 +106,26 @@ 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
Changing these 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 | true | `http://localhost:3000` |
| NEXT_PUBLIC_LICENSE_CONSENT | license consent - true/false | false | |
| NEXT_PUBLIC_TELEMETRY_KEY | NEXT telemetry key | true | `js.2pvs2bbpqq1zxna97wcml.oi2jzirnbj1ev4tc57c5r` |
| DATABASE_URL | database url with credentials | true | |
| NEXTAUTH_SECRET | Cookie encryption key | true | `secret` |
| CALENDSO_ENCRYPTION_KEY | Authentication encryption key | true | `secret` |

### Important Run-time variables

* NEXTAUTH_SECRET
These variables must also be provided at runtime

* CALCOM_LICENSE_KEY
* NEXTAUTH_SECRET (must match value used in build)
* CALENDSO_ENCRYPTION_KEY (must match value used in build)
* DATABASE_URL

## Git Submodules
Expand Down

0 comments on commit 323bff9

Please sign in to comment.