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.

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

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.

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

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

token

Repository Auth Token

Name Value
type string
default null