Skip to content

Latest commit

 

History

History

updaters

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 

Updater modules

Each updater block in the configuration file drives an updater module. The updaters are executed one after the other in the order they are listed in the configuration file.

Each updater module can be appear multiple times in the configuration file.

Documentation on specific modules

Documentation format

Each updater is documented in the following format. The module-name is the value to enter in the block's module parameter to use this module. Unknown module names in the configuration file are an error.

Updater name (module-name)

Description of the updater.

# Example block with dummy values
[[updater]]
module = "module-name"
enabled = true
arg1 = "Value 1"
arg2 = "Value 2"
# ...
  • arg1

    Description of the first argument

  • arg2

    Description of the second argument

Options common to all updaters

  • module-name

    Name of the updater module configured by this block.

  • enabled (Optional)

    If set to false, the updater module will not be executed.

  • tag (Optional)

    A string identifying this updater module as part of a group. Multiple modules using the same tag will share information as they can. If the same module is used multiple times in the configuration file, each should have its own tag or they might encounter problems.