Skip to content

Commit 4f0aadc

Browse files
docs(readme): update information about CACHE_SECONDS environment variable (anuraghazra#4544)
Co-authored-by: Alexandr <qwerty541zxc@gmail.com>
1 parent 956d6de commit 4f0aadc

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

readme.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -885,7 +885,7 @@ Since the GitHub API only allows 5k requests per hour, my `https://github-readme
885885

886886
GitHub Readme Stats provides several environment variables that can be used to customize the behavior of your self-hosted instance. These include:
887887

888-
* `CACHE_SECONDS`: This takes precedence over our cache minimum and maximum values and can circumvent these values for self-hosted instances.
888+
* `CACHE_SECONDS`: Sets the cache duration in seconds for the generated cards. This variable takes precedence over the default cache timings for the public instance. You can also set it to `0` to disable caching completely. If this variable is not set, the default cache duration is 24 hours (86,400 seconds).
889889
* `WHITELIST`: A comma-separated list of GitHub usernames that are allowed to access your instance. If this variable is not set, all usernames are allowed.
890890
* `GIST_WHITELIST`: A comma-separated list of GitHub gist IDs that are allowed to be accessed on your instance. If this variable is not set, all gist IDs are allowed.
891891
* `EXCLUDE_REPO`: A comma-separated list of repositories that will be excluded from stats and top languages cards on your instance. This allows repository exclusion without exposing repository names in public URLs. This enhances privacy for self-hosted instances that include private repositories in stats cards.

0 commit comments

Comments
 (0)