Skip to content

Commit 86875bc

Browse files
authored
docs: add Unkey rate limiting setup documentation (calcom#27163)
- Update .env.example with clarified Unkey configuration comments - Update README.md with explainer of Unkey and how it's optional.
1 parent 0e900a7 commit 86875bc

2 files changed

Lines changed: 17 additions & 1 deletion

File tree

.env.example

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -398,7 +398,10 @@ NEXT_PUBLIC_API_V2_URL="http://localhost:5555/api/v2"
398398
TASKER_ENABLE_WEBHOOKS=0
399399
TASKER_ENABLE_EMAILS=0
400400

401-
# Ratelimiting via unkey
401+
# Ratelimiting via Unkey (https://unkey.com)
402+
# Optional: Only required if you want to enable rate limiting
403+
# Not needed for testing or self-hosting unless you specifically want rate limiting features
404+
# Sign up at https://unkey.com to get your Root key
402405
UNKEY_ROOT_KEY=
403406

404407
# Used for Cal.ai Voice AI Agents

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -888,6 +888,19 @@ following
888888

889889
[Follow these steps](./packages/app-store/pipedrive-crm/)
890890

891+
### Rate Limiting with Unkey
892+
893+
Cal.com uses [Unkey](https://unkey.com) for rate limiting. This is an optional feature and is not required for testing or self-hosting.
894+
895+
If you want to enable rate limiting:
896+
897+
1. Sign up for an account at [unkey.com](https://unkey.com)
898+
2. Create a Root key with permissions for
899+
`ratelimit.create_namespace` and `ratelimit.limit`
900+
3. Copy the root key to your `.env` file into the `UNKEY_ROOT_KEY` field
901+
902+
Note: If you don't configure Unkey, Cal.com will work normally without rate limiting enabled.
903+
891904
## Workflows
892905

893906
### Setting up SendGrid for Email reminders

0 commit comments

Comments
 (0)