diff --git a/docs/usage/configuration-options.md b/docs/usage/configuration-options.md index 239f20d4db45544adc24050b419306228ba31171..c19f6c28a7bf191519a31e419659746fb58cb1b0 100644 --- a/docs/usage/configuration-options.md +++ b/docs/usage/configuration-options.md @@ -1206,6 +1206,25 @@ If the value starts with `http(s)` then it will only match against URLs which st Otherwise, it will be matched by checking if the URL's hostname matches the `matchHost` directly or ends with it. When checking the end of the hostname, a single dot is prefixed to the value of `matchHost`, if one is not already present, to ensure it can only match against whole domain segments. +The `matchHost` URL must be the same as the `registryUrl` set in `.npmrc`, or you'll get authentication issues when the artifacts are updated when yarn or npm runs. + +```json +{ + "hostRules": [ + { + "matchHost": "https://gitlab.myorg.com/api/v4/packages/npm/", + "token": "abc123" + } + ] +} +``` + +The above corresponds with an `.npmrc` like the following: + +``` +registry=https://gitlab.myorg.com/api/v4/packages/npm/ +``` + <!-- prettier-ignore --> !!! note Values containing a URL path but missing a scheme will be prepended with 'https://' (e.g. `domain.com/path` -> `https://domain.com/path`)