feat: whitelist #3939
Open
feat: whitelist #3939
Conversation
This file contains 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
|
@kyleaupton is attempting to deploy a commit to the github readme stats Team on Vercel. A member of the Team first needs to authorize it. |
github-actions
bot
added
stats-card
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.
This PR adds a whitelist concept so the api will only render things you want it to.
Motivation
I am self-hosting an instance of this project on a VPS that doesn't have much resources. And because of that I would like to ensure that only cards for my username are rendered. Also, I am using my own PAT and would like to limit the number of times it's used against GitHub's api.
This PR adds two new env vars:
WHITELISTandGIST_WHITELISTthat are comma-separated lists. If someone hits a username based endpoint (/,/pin,/top-langs, and/wakatime), andprocess.env.WHITELISThas a populated value, then the whitelist will be enforced. Same thing with/gistexcept the whitelist is gist IDs.P.S.- I noticed that
/wakatimedoesn't enforce the blacklist. Not sure if this is intended or not, just wanted to bring it up.