Reading list¶

Renovate's documentation has a lot of pages. To ease you into using Renovate we created reading lists. The reading lists contain the essential information for each type of user.

How much you should read depends on how much you want to customize Renovate's behavior.

How to use this page¶

We created reading lists for these types of users:

Beginners
Intermediate
Advanced

Start with the "Beginners" reading list. If you're self-hosting or need to update private packages, complete the relevant reading lists for those.

I don't know where to start¶

If you're new to Renovate, you should:

Use the Mend Renovate App, or let someone else host Renovate for you
Stick with the config:recommended preset
Use the Dependency Dashboard (config:recommended enables it automatically)
Read the pages in the "Beginners" list
Only create custom Renovate configuration when really needed

Beginners¶

Start by reading:

Intermediate¶

First, complete the "Beginners" reading list. Read this list after experiencing Renovate's default behavior, once you really want/need to make changes to Renovate's behavior.

Skim the repository configuration options to learn about the kind of customizations you can make to Renovate. Feel free to read up on anything that looks interesting to you.

Advanced¶

First, complete the "Beginners" and the "Intermediate" reading list. Then read:

Define your own custom manager with customManagers (previously regexManagers)
Define your own custom datasources with customDatasources
Shareable config presets

Self-hosting Renovate¶

If you're going to self-host Renovate then read:

Running Renovate
Self-hosting examples
Skim the self hosted configuration options

Private packages¶

If you want Renovate to update private packages then read:

Private package support