2021-03-16 09:23:06 -06:00
# Self-hosted experimental environment variables
2021-03-16 03:16:59 -06:00
2023-03-13 23:25:26 -06:00
The following environment variables are "experimental" because they:
2021-03-16 03:16:59 -06:00
2023-03-13 23:25:26 -06:00
- 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
2021-03-16 03:16:59 -06:00
2021-08-22 02:51:42 -06:00
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 bot developers.
2021-03-16 03:16:59 -06:00
2021-03-16 09:23:06 -06:00
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.
2021-08-22 02:51:42 -06:00
We will try to keep breakage to a minimum, but make no guarantees that an experimental variable will keep working.
2021-03-16 03:16:59 -06:00
2023-11-29 06:08:37 -07:00
## `OTEL_EXPORTER_OTLP_ENDPOINT`
If set, Renovate will export OpenTelemetry data to the supplied endpoint.
For more information see [the OpenTelemetry docs ](opentelemetry.md ).
2021-12-19 06:11:12 -07:00
## `RENOVATE_PAGINATE_ALL`
2021-03-16 03:16:59 -06:00
If set to any value, Renovate will always paginate requests to GitHub fully, instead of stopping after 10 pages.
2024-06-28 02:10:32 -06:00
## `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
2024-04-21 08:39:38 -06:00
## `RENOVATE_X_DOCKER_HUB_TAGS_DISABLE`
2023-12-07 04:15:13 -07:00
2024-04-21 08:39:38 -06:00
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` .
2023-12-07 04:15:13 -07:00
2023-11-29 06:08:37 -07:00
## `RENOVATE_X_EXEC_GPID_HANDLE`
If set, Renovate will terminate the whole process group of a terminated child process spawned by Renovate.
2023-11-28 02:11:59 -07:00
## `RENOVATE_X_GITLAB_AUTO_MERGEABLE_CHECK_ATTEMPS`
2024-02-19 05:36:39 -07:00
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.
2024-01-05 03:56:21 -07:00
The formula for the delay between attempts is `RENOVATE_X_GITLAB_MERGE_REQUEST_DELAY * attempt * attempt` milliseconds.
2023-11-28 02:11:59 -07:00
Default value: `5` (attempts results in max. 13.75 seconds timeout).
## `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).
2024-01-05 03:56:21 -07:00
## `RENOVATE_X_GITLAB_MERGE_REQUEST_DELAY`
If set, Renovate will use this as a delay to proceed with an automerge.
Default value: `250` (milliseconds).
2021-12-19 06:11:12 -07:00
## `RENOVATE_X_HARD_EXIT`
2021-03-16 06:34:43 -06:00
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.
2023-03-13 23:25:26 -06:00
See [issue 8660 ](https://github.com/renovatebot/renovate/issues/8660 ) for background on why this was created.
2021-08-25 22:56:28 -06:00
2023-04-08 02:38:43 -06:00
## `RENOVATE_X_IGNORE_RE2`
Skip initializing `RE2` for regular expressions and instead use Node-native `RegExp` instead.
2024-04-20 00:21:19 -06:00
## `RENOVATE_X_NUGET_DOWNLOAD_NUPKGS`
If set to any value, Renovate will download `nupkg` files for determining package metadata.
2023-11-29 06:08:37 -07:00
## `RENOVATE_X_PLATFORM_VERSION`
2022-11-01 04:12:33 -06:00
2024-03-21 00:08:28 -06:00
Specify this string for Renovate to skip API checks and provide GitLab/Bitbucket server version directly.
Particularly useful with GitLab's `CI_JOB_TOKEN` to authenticate Renovate or to reduce API calls for Bitbucket.
2022-11-01 04:12:33 -06:00
2023-11-29 06:08:37 -07:00
Read [platform details ](modules/platform/gitlab/index.md ) to learn why we need the server version on GitLab.
2022-11-01 04:12:33 -06:00
2023-11-29 06:08:37 -07:00
## `RENOVATE_X_REBASE_PAGINATION_LINKS`
2022-11-01 04:12:33 -06:00
2023-11-29 06:08:37 -07:00
If set, Renovate will rewrite GitHub Enterprise Server's pagination responses to use the `endpoint` URL from the Renovate config.
2022-11-01 04:12:33 -06:00
<!-- prettier - ignore -->
!!! note
2023-11-29 06:08:37 -07:00
For the GitHub Enterprise Server platform only.
2022-11-01 04:12:33 -06:00
2024-04-11 10:40:59 -06:00
## `RENOVATE_X_REPO_CACHE_FORCE_LOCAL`
If set, Renovate will persist repository cache locally after uploading to S3.
2024-01-30 00:50:24 -07:00
## `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.
2024-03-02 00:06:08 -07:00
## `RENOVATE_X_SUPPRESS_PRE_COMMIT_WARNING`
Suppress the pre-commit support warning in PR bodies.
2024-03-18 15:48:02 -06:00
2024-04-22 05:57:19 -06:00
## `RENOVATE_X_USE_OPENPGP`
Use `openpgp` instead of `kbpgp` for `PGP` decryption.
2024-03-24 02:51:57 -06:00
## `RENOVATE_X_YARN_PROXY`
2024-03-18 15:48:02 -06:00
2024-03-24 02:51:57 -06:00
Configure global Yarn proxy settings if HTTP proxy environment variables are detected.