Skip to content

Self-Hosted Configuration Options

The below configuration options are applicable only if you are running your own instance ("bot") of Renovate.

autodiscover

Autodiscover all repositories

Name Value
type boolean
default false

Be cautious when using this option - it will run Renovate over every repository that the bot account has access to.

binarySource

Where to source binaries like npm and yarn from

Name Value
type string
default "bundled"

Set this to 'global' if you wish Renovate to use globally-installed binaries (npm, yarn, etc) instead of using its bundled versions.

dryRun

If enabled, Renovate will log messages instead of creating/updating/deleting branches and PRs

Name Value
type boolean
default false

endpoint

Custom endpoint to use

Name Value
type string

exposeEnv

Enable this to expose bot process.env to repositories for npmrc substitution and package installation

Name Value
type boolean
default false

force

Any configuration defined within this object will force override existing settings

Name Value
type json

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

Whether CLI configuration options should be moved to the force config section

Name Value
type boolean
default false

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

Set to true if Renovate should fork the source repository and create branches there instead

Name Value
type boolean
default false

You probably have no need for this option - it is an experimental setting for the Renovate hosted GitHub App.

gitAuthor

Author to use for git commits. RFC5322

Name Value
type string
default null

RFC5322-compliant string if you wish to customise the git author for commits.

gitFs

Use git for FS operations instead of API. GitHub only.

Name Value
type string
allowedValues https,http,ssh

This setting is experimental, and works for GitHub repositories only. If enabled, Renovate will git clone repos and use git for file operations such as creating branches and committing files. Set it to a string specifing the transport used by Git (https, http or ssh).

gitPrivateKey

PGP key to use for signing git commits

Name Value
type string
default null

logFile

Log file path

Name Value
type string
default null

logFileLevel

Log file log level

Name Value
type string
default "debug"

logLevel

Logging level

Name Value
type string
default "info"

mirrorMode

Set to true if Renovate should use fork mode with a renovate.json in branch renovate-config

Name Value
type boolean
default false

You probably have no need for this option - it is an experimental setting for the Renovate hosted GitHub App.

onboarding

Require a Configuration PR first

Name Value
type boolean
default true

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

Configuration to use in onboarding PRs

Name Value
type json
mergeable true

password

Password for authentication. Currently Bitbucket only (AppPassword).

Name Value
type string
default null

platform

Platform type of repository

Name Value
type string
default "github"

prFooter

Pull Request footer template

Name Value
type string
default "This PR has been generated by [Renovate Bot](https://renovatebot.com)."

privateKey

Server-side private key

Name Value
type string
replaceLineReturns true
default null

repositories

List of Repositories

Name Value
type list
default []

requireConfig

Set to true if repositories must have a config to activate Renovate.

Name Value
type boolean
default false

skipInstalls

Skip installing modules/dependencies if lock file updating is possible alone

Name Value
type boolean
default null

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

Repository Auth Token

Name Value
type string
default null

username

Username for authentication. Currently Bitbucket only

Name Value
type string
default null