mirror of
https://github.com/renovatebot/renovate.git
synced 2026-10-27 07:50:47 +00:00
Jamie Tanna
b62fe59594
We dropped the "bot" from our terminology long ago, but it looks like we've got some outdated docs + code that reference it. We should remove this to keep things consistent. A `fix`, as we're changing the commit author's name, and log lines. Co-authored-by: Claude Sonnet 5 <jamie.tanna+claude-code@mend.io> Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
79 lines
2.9 KiB
Markdown
79 lines
2.9 KiB
Markdown
# Configuration
|
|
|
|
## Configuration Methods
|
|
|
|
Renovate global config can be defined via any of these methods:
|
|
|
|
- Configuration file
|
|
- Additional configuration file
|
|
- Environment variables
|
|
- CLI parameters
|
|
|
|
The above are listed in **_reverse order_** of preference. e.g. CLI values will override environment values if they conflict.
|
|
|
|
### Default Configuration
|
|
|
|
The default configuration values can be found in [lib/config/options/index.ts](../../lib/config/options/index.ts).
|
|
Options which have `"globalOnly": true` are reserved only for global self-hosted configuration and cannot be configured within repository config files.
|
|
|
|
### Configuration File
|
|
|
|
You can override default configuration using a configuration file, with default name `config.js` in the working directory.
|
|
If you need an alternate location or name, set it in the environment variable `RENOVATE_CONFIG_FILE`.
|
|
|
|
You can also add one more configuration file, with an additional config which overwrites the default config file.
|
|
To use such a file, you need to set the env var `RENOVATE_ADDITIONAL_CONFIG_FILE` as this file does not have a default name.
|
|
|
|
**Note:** `RENOVATE_CONFIG_FILE` and `RENOVATE_ADDITIONAL_CONFIG_FILE` must be provided with an explicit file extension.
|
|
For example `RENOVATE_CONFIG_FILE=myconfig.js` or `RENOVATE_CONFIG_FILE=myconfig.json` and not `RENOVATE_CONFIG_FILE=myconfig`.
|
|
If none is provided, or the file type is invalid, Renovate will fail.
|
|
|
|
If you are in an ESM repo (`"type": "module"` in `package.json`) then you must use a `.cjs` extension and set `RENOVATE_CONFIG_FILE`.
|
|
For example `RENOVATE_CONFIG_FILE=myconfig.cjs`.
|
|
|
|
Using a configuration file gives you very granular configuration options.
|
|
For instance, you can override most settings at the global (file), repository, or package level.
|
|
e.g. apply one set of labels for `backend/package.json` and a different set of labels for `frontend/package.json` in the same repository.
|
|
|
|
```javascript
|
|
module.exports = {
|
|
npmrc: '//registry.npmjs.org/:_authToken=abc123',
|
|
baseDir: '/tmp/renovate',
|
|
forkProcessing: 'enabled',
|
|
gradle: { enabled: false },
|
|
};
|
|
```
|
|
|
|
### CLI
|
|
|
|
```
|
|
node renovate --help
|
|
```
|
|
|
|
To configure any `<list>` items, separate with commas.
|
|
E.g. `renovate --labels=renovate,dependency`.
|
|
|
|
To enable debug logging export `LOG_LEVEL=debug` to your environment.
|
|
|
|
### renovate.json
|
|
|
|
If you add a `renovate.json` file to the root of your repository, you can use this to override default settings.
|
|
|
|
### package.json
|
|
|
|
If you add configuration options to your `package.json` then these will override any other settings above.
|
|
|
|
```json {configType=none}
|
|
{
|
|
"renovate": {
|
|
"labels": ["upgrade", "bot"]
|
|
}
|
|
}
|
|
```
|
|
|
|
## Configuration Options
|
|
|
|
Please read [our list of user-facing configuration options](https://docs.renovatebot.com/configuration-options/).
|
|
|
|
For further options when running your own instance of Renovate, please see the full config options file at `lib/config/options/index.ts`.
|