diff --git a/readme.md b/readme.md index e7faba9885405..78fe9ae42fb69 100644 --- a/readme.md +++ b/readme.md @@ -890,11 +890,42 @@ Since the GitHub API only allows 5k requests per hour, my `https://github-readme GitHub Readme Stats provides several environment variables that can be used to customize the behavior of your self-hosted instance. These include: -* `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). -* `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. -* `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. -* `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. -* `FETCH_MULTI_PAGE_STARS`: When set to `true`, this enables fetching all starred repositories for accurate star counts, especially for users with more than 100 repositories. This may increase response times and API points usage, so it is disabled on the public instance. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionSupported values
CACHE_SECONDSSets the cache duration in seconds for the generated cards. This variable takes precedence over the default cache timings for the public instance. If this variable is not set, the default cache duration is 24 hours (86,400 seconds).Any positive integer or 0 to disable caching
WHITELISTA comma-separated list of GitHub usernames that are allowed to access your instance. If this variable is not set, all usernames are allowed.Comma-separated GitHub usernames
GIST_WHITELISTA 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.Comma-separated GitHub Gist IDs
EXCLUDE_REPOA 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.Comma-separated repository names
FETCH_MULTI_PAGE_STARSEnables fetching all starred repositories for accurate star counts, especially for users with more than 100 repositories. This may increase response times and API points usage, so it is disabled on the public instance.true or false
See [the Vercel documentation](https://vercel.com/docs/concepts/projects/environment-variables) on adding these environment variables to your Vercel instance. diff --git a/src/cards/stats.js b/src/cards/stats.js index 44f787c5882a2..6b428d48c34ae 100644 --- a/src/cards/stats.js +++ b/src/cards/stats.js @@ -34,6 +34,7 @@ const LONG_LOCALES = [ "fr", "hu", "id", + "ja", "ml", "my", "nl", diff --git a/src/common/I18n.js b/src/common/I18n.js index bd5f29fcb6a84..75b9c91aa2766 100644 --- a/src/common/I18n.js +++ b/src/common/I18n.js @@ -1,3 +1,5 @@ +// @ts-check + const FALLBACK_LOCALE = "en"; /** @@ -9,7 +11,7 @@ class I18n { * * @param {Object} options Options. * @param {string=} options.locale Locale. - * @param {Object} options.translations Translations. + * @param {any} options.translations Translations. */ constructor({ locale, translations }) { this.locale = locale || FALLBACK_LOCALE; diff --git a/src/common/envs.js b/src/common/envs.js index f1ae30de4b2e5..5f1319662b94d 100644 --- a/src/common/envs.js +++ b/src/common/envs.js @@ -1,3 +1,5 @@ +// @ts-check + const whitelist = process.env.WHITELIST ? process.env.WHITELIST.split(",") : undefined; diff --git a/src/common/http.js b/src/common/http.js index 388d105289906..ef6258b0b85eb 100644 --- a/src/common/http.js +++ b/src/common/http.js @@ -1,3 +1,5 @@ +// @ts-check + import axios from "axios"; /** diff --git a/src/common/icons.js b/src/common/icons.js index 771704a335d12..98023b675e292 100644 --- a/src/common/icons.js +++ b/src/common/icons.js @@ -1,3 +1,5 @@ +// @ts-check + const icons = { star: ``, commits: ``,