feat: add docs for cloud and self hosted rate limiting #196
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: rohan <rohan.chaturvedi@protonmail.com>
There was a problem hiding this comment.
Pull request overview
This PR adds comprehensive documentation for rate limiting in both Phase Cloud and self-hosted deployments. The documentation clarifies the different rate limits for various subscription tiers and provides configuration guidance for administrators.
- Adds a new
RATE_LIMIT_DEFAULTenvironment variable to the self-hosting configuration documentation - Introduces a dedicated "Rate Limits" section to the public API documentation with tier-based limits
- Provides example HTTP 429 response with headers to help developers handle rate limit errors
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| src/pages/self-hosting/configuration/envars.mdx | Adds documentation for the RATE_LIMIT_DEFAULT environment variable with format examples and usage instructions |
| src/pages/public-api/index.mdx | Adds comprehensive rate limiting section with subscription tier limits, HTTP 429 response example, and cross-reference to self-hosting configuration |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Deploying phase-docs with
|
| Latest commit: |
98b253d
|
| Status: | ⚡️ Build in progress... |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
…d worker containers
|
You have run out of free Bugbot PR reviews for this billing cycle. This will reset on January 13. To receive reviews on all of your PRs, visit the Cursor dashboard to activate Pro and start your 14-day free trial. |
…documentation for backend and worker containers
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds docs for Cloud and Self hosted rate limiting
Note
Adds Cloud API rate limit docs and 429 example, notes self-hosted configurability, and documents
RATE_LIMIT_DEFAULTandREDIS_SSLenv vars (plus clarifiesREDIS_PASSWORDrequirement).src/pages/public-api/index.mdx):429 Too Many Requestsresponse.RATE_LIMIT_DEFAULT.src/pages/self-hosting/configuration/envars.mdx):REDIS_SSLboolean env var description.REDIS_PASSWORDis required forbackendandworker.RATE_LIMIT_DEFAULTenv var under Additional Environment Variables for configuring API rate limits.Written by Cursor Bugbot for commit 5ffaa5a. This will update automatically on new commits. Configure here.