renovate/website/docs/self-hosted-configuration.md
Rhys Arkins d0ec341e15
feat: skipInstalls (#2390)
Adds new admin option “skipInstalls” that is applicable for npm-only for now (including lerna-npm). If set to false, Renovate will perform a full install of modules rather than `—package-lock-only`. This is necessary in some cases to work around bugs in npm.

Self-hosted bot users can set this option themselves on the bot’s config, but app users will require it to be enabled per-repository by the app admin.
2018-08-15 17:13:07 +02:00

68 lines
2.2 KiB
Markdown

---
title: Self-Hosted Configuration
description: Self-Hosted Configuration usable in renovate.json or package.json
---
# Self-Hosted Configuration Options
The below configuration options are applicable only if you are running your own instance ("bot") of Renovate.
## autodiscover
Be cautious when using this option - it will run Renovate over _every_ repository that the bot account has access to.
## endpoint
## exposeEnv
## force
This object is used as a "force override" when you need to make sure certain configuration overrides whatever is configured in the repository. For example, forcing a null (no) schedule to make sure Renovate raises PRs on a run even if the repository itself or its preset defines a schedule that's currently in active.
In practice, it is implemented by converting the `force` configuration into a `packageRule` that matches all packages.
## forceCli
This is set to true by default, meaning that any settings (such as `schedule`) take maximum priority even against custom settings existing inside individual repositories.
## forkMode
You probably have no need for this option - it is an experimental setting for the Renovate hosted GitHub App.
## gitAuthor
RFC5322-compliant string if you wish to customise the git author for commits.
## gitPrivateKey
## logFile
## logFileLevel
## logLevel
## mirrorMode
You probably have no need for this option - it is an experimental setting for the Renovate hosted GitHub App.
## onboarding
Set this to `false` if (a) you configure Renovate entirely on the bot side (i.e. empty `renovate.json` in repositories) and (b) you wish to run Renovate on every repository the bot has access to, and (c) you wish to skip the onboarding PRs.
## onboardingConfig
## platform
## prFooter
## privateKey
## repositories
## requireConfig
## skipInstalls
By default, Renovate will use the most efficient approach to updating package files and lock files, which in most cases skips the need to perform a full module install by the bot. If this is set to false, then a full install of modules will be done. This is currently applicable to `npm` and `lerna`/`npm` only, and only used in cases where bugs in `npm` result in incorrect lock files being updated.
## token