mirror of
https://github.com/renovatebot/renovate.git
synced 2026-10-29 16:59:02 +00:00
Jamie Tanna
b62fe59594
We dropped the "bot" from our terminology long ago, but it looks like we've got some outdated docs + code that reference it. We should remove this to keep things consistent. A `fix`, as we're changing the commit author's name, and log lines. Co-authored-by: Claude Sonnet 5 <jamie.tanna+claude-code@mend.io> Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
183 lines
8.0 KiB
Markdown
183 lines
8.0 KiB
Markdown
# Self-hosted experimental environment variables
|
||
|
||
The following environment variables are "experimental" because they:
|
||
|
||
- are not commonly needed
|
||
- are typically an effort to work around some other service's or platform's problem
|
||
- can be removed at any time
|
||
- are variables for Renovate's internal use to validate they work as intended
|
||
|
||
Experimental variables which are commonly used and for which there is no external solution in sight can be converted to an official configuration option by the Renovate developers.
|
||
|
||
Use these experimental variables at your own risk.
|
||
We do not follow Semantic Versioning for any experimental variables.
|
||
These variables may be removed or have their behavior changed in **any** version.
|
||
We will try to keep breakage to a minimum, but make no guarantees that an experimental variable will keep working.
|
||
|
||
## `OTEL_EXPORTER_OTLP_ENDPOINT`
|
||
|
||
If set, Renovate will export OpenTelemetry data to the supplied endpoint.
|
||
For more information see [the OpenTelemetry docs](opentelemetry.md).
|
||
|
||
## `RENOVATE_PAGINATE_ALL`
|
||
|
||
If set to any value, Renovate will always paginate requests to GitHub fully, instead of stopping after 10 pages.
|
||
|
||
## `RENOVATE_X_DOCKER_HUB_DISABLE_LABEL_LOOKUP`
|
||
|
||
If set to any value, Renovate will skip attempting to get release labels (e.g. gitRef, sourceUrl) from manifest annotations for `https://index.docker.io`.
|
||
|
||
Due to the missing label information like sourceUrl, Renovate will not be able to perform certain actions dependent on these information for the images.
|
||
|
||
This includes the following:
|
||
|
||
- Generating changelogs
|
||
- Applying package rules dependent on the labels
|
||
- Including the sourceUrls in PR bodies
|
||
|
||
## `RENOVATE_X_DOCKER_HUB_TAGS_DISABLE`
|
||
|
||
If set to any value, Renovate will stop using the Docker Hub API (`https://hub.docker.com`) to fetch tags and instead use the normal Docker API for images pulled from `https://index.docker.io`.
|
||
|
||
## `RENOVATE_X_DOCKER_PAGINATION_ALLOW_CROSS_ORIGIN`
|
||
|
||
!!! warning
|
||
This is an explicit opt-out of a security control.
|
||
|
||
If set to any value, the `docker` datasource will follow paginated `next` links pointing to a different origin than the registry it is querying.
|
||
|
||
By default Renovate drops such cross-origin pagination links, so a malicious or compromised registry cannot redirect an authenticated request to an attacker-controlled host and exfiltrate credentials.
|
||
Set this only if you trust the registry and it legitimately paginates across hosts (for example, an absolute `next` link pointing at a CDN or backend host).
|
||
|
||
## `RENOVATE_X_ENCRYPTED_STRICT`
|
||
|
||
If set to `"true"`, a config error Issue will be raised in case repository config contains `encrypted` objects without any `privateKey` defined.
|
||
|
||
## `RENOVATE_X_EXEC_GPID_HANDLE`
|
||
|
||
If set, Renovate will terminate the whole process group of a terminated child process spawned by Renovate.
|
||
|
||
## `RENOVATE_X_GITLAB_AUTO_APPROVE_TOKEN`
|
||
|
||
If set, when `autoApprove` is enabled, the provided token is used to authenticate GitLab approve requests instead of the default one.
|
||
This is useful in environments where a user cannot approve its own PRs.
|
||
|
||
## `RENOVATE_X_GITLAB_AUTO_MERGEABLE_CHECK_ATTEMPS`
|
||
|
||
If set to an positive integer, Renovate will use this as the number of attempts to check if a merge request on GitLab is mergeable before trying to automerge.
|
||
The formula for the delay between attempts is `RENOVATE_X_GITLAB_MERGE_REQUEST_DELAY * attempt * attempt` milliseconds.
|
||
|
||
Default value: `5` (attempts results in max. 13.75 seconds timeout).
|
||
|
||
## `RENOVATE_X_GITLAB_BRANCH_STATUS_CHECK_ATTEMPTS`
|
||
|
||
If set to a positive integer, Renovate will use this as the number of attempts to check branch status before trying to add a status check.
|
||
The delay between attempts is `RENOVATE_X_GITLAB_BRANCH_STATUS_DELAY` milliseconds.
|
||
|
||
Default value: `2` (attempts results in maximum 2 seconds timeout).
|
||
|
||
!!! warning Increasing this value too much penalizes projects that do not have defined pipelines, Renovate will systematically wait `RENOVATE_X_GITLAB_BRANCH_STATUS_CHECK_ATTEMPTS * RENOVATE_X_GITLAB_BRANCH_STATUS_DELAY` milliseconds on these projects and slow down the Renovate analyzes.
|
||
|
||
## `RENOVATE_X_GITLAB_BRANCH_STATUS_DELAY`
|
||
|
||
Adjust default time (in milliseconds) given to GitLab to create pipelines for a commit pushed by Renovate.
|
||
|
||
Can be useful for slow-running, self-hosted GitLab instances that don't react fast enough for the default delay to help.
|
||
|
||
Default value: `1000` (milliseconds).
|
||
|
||
## `RENOVATE_X_GITLAB_MERGE_REQUEST_DELAY`
|
||
|
||
If set, Renovate will use this as a delay to proceed with an automerge.
|
||
|
||
Default value: `250` (milliseconds).
|
||
|
||
## `RENOVATE_X_GITLAB_SKIP_STATUS_WITHOUT_PIPELINE`
|
||
|
||
If set to `true` value, Renovate will skip setting a branch status check on GitLab when no pipeline is found for the commit.
|
||
This is useful for GitLab configurations where pipelines are only created for merge requests, not for branches.
|
||
|
||
## `RENOVATE_X_HARD_EXIT`
|
||
|
||
If set to any value, Renovate will use a "hard" `process.exit()` once all work is done, even if a sub-process is otherwise delaying Node.js from exiting.
|
||
See [issue 8660](https://github.com/renovatebot/renovate/issues/8660) for background on why this was created.
|
||
|
||
## `RENOVATE_X_IGNORE_RE2`
|
||
|
||
Skip initializing `RE2` for regular expressions and instead use Node-native `RegExp` instead.
|
||
|
||
## `RENOVATE_X_NUGET_DOWNLOAD_NUPKGS`
|
||
|
||
If set to any value, Renovate will download `nupkg` files for determining package metadata.
|
||
|
||
## `RENOVATE_X_NUGET_PAGINATION_ALLOW_CROSS_ORIGIN`
|
||
|
||
!!! warning
|
||
This is an explicit opt-out of a security control.
|
||
|
||
If set to any value, the `nuget` datasource will follow paginated `next` links pointing to a different origin than the feed it is querying.
|
||
|
||
By default Renovate drops such cross-origin pagination links, so a malicious or compromised feed cannot redirect an authenticated request to an attacker-controlled host and exfiltrate credentials.
|
||
Set this only if you trust the feed and it legitimately paginates across hosts (for example, an absolute `next` link pointing at a backend host).
|
||
|
||
## `RENOVATE_X_PGP_RUNTIME`
|
||
|
||
Specify which PGP runtime to use for decrypting Renovate config.
|
||
Allowed values are `js-java`, `wasm-java` and `wasm-dotnet`.
|
||
|
||
!!! note
|
||
`js-java` and `wasm-dotnet` are not recommended due to performance reasons.
|
||
Incompatible with `RENOVATE_X_USE_OPENPGP`.
|
||
|
||
Default: `wasm-java`.
|
||
|
||
## `RENOVATE_X_PLATFORM_VERSION`
|
||
|
||
Specify this string for Renovate to skip API checks and provide Bitbucket server, Forgejo or GitLab version directly.
|
||
Particularly useful with GitLab's `CI_JOB_TOKEN` to authenticate Renovate or to reduce API calls for Bitbucket.
|
||
|
||
Read [platform details](modules/platform/gitlab/index.md) to learn why we need the server version on GitLab.
|
||
|
||
## `RENOVATE_X_REBASE_PAGINATION_LINKS`
|
||
|
||
If set, Renovate will rewrite GitHub Enterprise Server's pagination responses to use the `endpoint` URL from the Renovate config.
|
||
|
||
!!! note
|
||
For the GitHub Enterprise Server platform only.
|
||
|
||
## `RENOVATE_X_SQLITE_BUSY_TIMEOUT`
|
||
|
||
Set the SQLite busy timeout in milliseconds. Defaults to `5000`.
|
||
|
||
Only applies when `RENOVATE_X_SQLITE_PACKAGE_CACHE` is set.
|
||
|
||
## `RENOVATE_X_SQLITE_PACKAGE_CACHE`
|
||
|
||
If set, Renovate will use SQLite as the backend for the package cache.
|
||
Don't combine with `redisUrl`, Redis would be preferred over SQlite.
|
||
|
||
## `RENOVATE_X_STATIC_REPO_CONFIG_FILE`
|
||
|
||
If set to a valid path pointing to a file containing a _valid_ Renovate configuration in `JSON` format, it will be applied to the repository config before resolving the actual configuration file within the repository.
|
||
|
||
!!! warning
|
||
If the file is missing or contains invalid configuration, the scan will be aborted.
|
||
|
||
!!! note
|
||
You probably **shouldn’t use this** unless you have a very specific reason to override the repository’s normal configuration resolution process.
|
||
|
||
## `RENOVATE_X_SUPPRESS_PRE_COMMIT_WARNING`
|
||
|
||
Suppress the pre-commit support warning in PR bodies.
|
||
|
||
## `RENOVATE_X_USE_OPENPGP`
|
||
|
||
!!! note
|
||
Incompatible with `RENOVATE_X_PGP_RUNTIME`.
|
||
|
||
Use `openpgp` instead of [Bouncy Castle](https://www.bouncycastle.org/) for `PGP` decryption.
|
||
|
||
## `RENOVATE_X_YARN_PROXY`
|
||
|
||
Configure global Yarn proxy settings if HTTP proxy environment variables are detected.
|