Skip to content

Latest commit

 

History

History
70 lines (45 loc) · 2.25 KB

config_file.rst

File metadata and controls

70 lines (45 loc) · 2.25 KB

Raiden Config File

Raiden supports reading configuration parameters from a configuration file. Raiden configuration parameter can also be given as environment variables - the variable has to be prefixed with RAIDEN_ - otherwise the options are the same as the commandline arguments.

Location

The default location is <datadir>/config.toml (where datadir defaults to ~/.raiden).

It is possible to override the datadir in the config file but please be aware that at that point the config file will already have been loaded from the default location and therefore won't be re-read from the 'new' datadir.

Precedence

The precedence order in which configuration option values are applied is as follows (high to low):

  1. Option given on the command line
  2. Option read from the prefixed RAIDEN_<config option> environment variables
  3. Option read from the config file
  4. Option default value (as seen in the output of raiden --help)

Format

The config file uses the TOML format.

Option names may be quoted unless they contain punctuation in which case they must be. Values except numbers must always be quoted. Both single or double quotes are acceptable.

Lines starting with a # are comments.

Parameter Naming

All parameters that can be given as command line options are also settable in the config file. The name corresponds to the long option name without the leading double dash (--). For example the CLI option --password-file would be called password-file inside the config file.

The only option deviating from this scheme is the logging configuration which is explained below.

Logging Configuration

Raiden allows configuration of the logging system using a concise syntax on the command line. Inside the configuration file this is split out into a somewhat more expanded syntax.

The logging configuration is placed inside a section called [log-config] which each following lines key representing the logger name and the value the log level.

Example:

# CLI:
--log-config ':debug,raiden.network:info'

# Config file equivalent:
[log-config]
"" = "debug"
"raiden.network" = "info"