Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Redis made optional #333

Merged
merged 3 commits into from
Nov 3, 2023
Merged

feat: Redis made optional #333

merged 3 commits into from
Nov 3, 2023

Conversation

YoussefLaunchUp
Copy link
Contributor

I made a small change to make Redis (and rate limiting) optional, this is to make local development easier. I updated the contributing doc to reflect this as well. Just leaving the UPSTASH_REDIS_REST_URL empty will lead to skipping rate limiting.

@vercel
Copy link

vercel bot commented Oct 28, 2023

@YoussefLaunchUp is attempting to deploy a commit to the Noodle Team on Vercel.

A member of the Team first needs to authorize it.

package.json Outdated Show resolved Hide resolved
.devcontainer/devcontainer.json Outdated Show resolved Hide resolved
.codesandbox/tasks.json Outdated Show resolved Hide resolved
@YoussefLaunchUp
Copy link
Contributor Author

@ixahmedxi removed the newer commites

@@ -185,6 +185,7 @@ And now you got Auth!
6. In the "Connect to your database" section, select "@upstash/redis"
7. Copy the url into your `.env` file as `REDIS_URL` key
8. Copy the token into your `.env` file as `REDIS_TOKEN` key
9. Upstash is only used for ratelimiting, if left empty then ratelimiting will be disabled
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I feel this looks like a step of setting up upstash, since it is in the ordered list. I would probably place it above the ordered list so that people read it before setting up upstash.

@@ -185,6 +185,7 @@ And now you got Auth!
6. In the "Connect to your database" section, select "@upstash/redis"
7. Copy the url into your `.env` file as `REDIS_URL` key
8. Copy the token into your `.env` file as `REDIS_TOKEN` key
9. Upstash is only used for ratelimiting, if left empty then ratelimiting will be disabled
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Replace this line with the current content and place it on top of the bullet list, as a note when the user firstly starts reading this section:

> **Note** Upstash is used to provide rate-limiting capabilities to Noodle, which is optional when self hosting as that it's really only needed in the production version.

@ixahmedxi ixahmedxi merged commit d292e24 into noodle-run:main Nov 3, 2023
1 check passed
Erb3 pushed a commit to Erb3-forked/noodle-legacy that referenced this pull request May 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants