Skip to content
Snippets Groups Projects
Unverified Commit 791ec0b9 authored by HonkingGoose's avatar HonkingGoose Committed by GitHub
Browse files

docs(self-hosted config): use admonitions (#13888)


* docs(self-hosted config): use admonitions

* Update docs/usage/self-hosted-configuration.md

Co-authored-by: default avatarHonkingGoose <34918129+HonkingGoose@users.noreply.github.com>

Co-authored-by: default avatarRhys Arkins <rhys@arkins.net>
parent 4114f313
No related branches found
No related tags found
No related merge requests found
...@@ -183,7 +183,9 @@ The format of the environment variables must follow: ...@@ -183,7 +183,9 @@ The format of the environment variables must follow:
Hyphens (`-`) in datasource or host name must be replaced with double underscores (`__`). Hyphens (`-`) in datasource or host name must be replaced with double underscores (`__`).
Periods (`.`) in host names must be replaced with a single underscore (`_`). Periods (`.`) in host names must be replaced with a single underscore (`_`).
Note: the following prefixes cannot be supported for this functionality: `npm_config_`, `npm_lifecycle_`, `npm_package_`. <!-- prettier-ignore -->
!!! note
The following prefixes cannot be supported for this functionality: `npm_config_`, `npm_lifecycle_`, `npm_package_`.
### npmjs registry token example ### npmjs registry token example
...@@ -242,7 +244,9 @@ Adds a custom prefix to the default Renovate sidecar Docker containers name and ...@@ -242,7 +244,9 @@ Adds a custom prefix to the default Renovate sidecar Docker containers name and
If this is set to `myprefix_` the final container created from `renovate/node` image would be named `myprefix_node` instead of currently used `renovate_node` and be labeled `myprefix_child` instead of `renovate_child`. If this is set to `myprefix_` the final container created from `renovate/node` image would be named `myprefix_node` instead of currently used `renovate_node` and be labeled `myprefix_child` instead of `renovate_child`.
Note that dangling containers will not be removed until Renovate is run with the same prefix again. <!-- prettier-ignore -->
!!! note
Dangling containers will only be removed when Renovate runs again with the same prefix.
## dockerImagePrefix ## dockerImagePrefix
...@@ -385,13 +389,16 @@ Set this to `false` only if all three statements are true: ...@@ -385,13 +389,16 @@ Set this to `false` only if all three statements are true:
## onboardingBranch ## onboardingBranch
Note that this setting is independent of `branchPrefix`. <!-- prettier-ignore -->
!!! note
This setting is independent of `branchPrefix`.
For example, if you configure `branchPrefix` to be `renovate-` then you'd still have the onboarding PR created with branch `renovate/configure` until you configure `onboardingBranch=renovate-configure` or similar. For example, if you configure `branchPrefix` to be `renovate-` then you'd still have the onboarding PR created with branch `renovate/configure` until you configure `onboardingBranch=renovate-configure` or similar.
If you have an existing Renovate installation and you change `onboardingBranch` then it's possible that you'll get onboarding PRs for repositories that had previously closed the onboarding PR unmerged. If you have an existing Renovate installation and you change `onboardingBranch` then it's possible that you'll get onboarding PRs for repositories that had previously closed the onboarding PR unmerged.
## onboardingCommitMessage ## onboardingCommitMessage
Note that if `commitMessagePrefix` or `semanticCommits` values are defined then they will be prepended to the commit message using the same logic that is used for adding them to non-onboarding commit messages. If `commitMessagePrefix` or `semanticCommits` values are defined then they will be prepended to the commit message using the same logic that is used for adding them to non-onboarding commit messages.
## onboardingConfig ## onboardingConfig
...@@ -505,7 +512,9 @@ Any encrypted secrets using GPG must have a mandatory organization/group scope, ...@@ -505,7 +512,9 @@ Any encrypted secrets using GPG must have a mandatory organization/group scope,
The reason for this is to avoid "replay" attacks where someone could learn your encrypted secret and then reuse it in their own Renovate repositories. The reason for this is to avoid "replay" attacks where someone could learn your encrypted secret and then reuse it in their own Renovate repositories.
Instead, with scoped secrets it means that Renovate ensures that the organization and optionally repository values encrypted with the secret match against the running repository. Instead, with scoped secrets it means that Renovate ensures that the organization and optionally repository values encrypted with the secret match against the running repository.
Note: simple public key encryption was previously used to encrypt secrets, but this approach has now been deprecated and no longer documented. <!-- prettier-ignore -->
!!! note
Simple public key encryption was previously used to encrypt secrets, but this approach has been deprecated and is no longer documented.
## privateKeyOld ## privateKeyOld
...@@ -543,7 +552,9 @@ Set this to `"enabled"` to have Renovate maintain a JSON file cache per-reposito ...@@ -543,7 +552,9 @@ Set this to `"enabled"` to have Renovate maintain a JSON file cache per-reposito
Set to `"reset"` if you ever need to bypass the cache and have it overwritten. Set to `"reset"` if you ever need to bypass the cache and have it overwritten.
JSON files will be stored inside the `cacheDir` beside the existing file-based package cache. JSON files will be stored inside the `cacheDir` beside the existing file-based package cache.
Warning: this is an experimental feature and may be modified or removed in a future non-major release. <!-- prettier-ignore -->
!!! warning
This is an experimental feature and may be modified or removed in a future non-major release.
## requireConfig ## requireConfig
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment