core-lightning/doc/lightning-setconfig.7.md
Rusty Russell 6546be9757 lightningd: setconfig command.
Currently only implemented for min-capacity-sat.

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
Changelog-Added: JSON-RPC: new command `setconfig` allows a limited number of configuration settings to be changed without restart.
2023-06-20 20:08:25 +09:30

1.9 KiB

lightning-setconfig -- Dynamically change some config options

SYNOPSIS

setconfig config [val]

DESCRIPTION

The setconfig RPC command allows you set the (dynamic) configuration option named by config: options which take a value (as separate from simple flag options) also need a val parameter.

This new value will also be written at the end of the config file, for persistence across restarts.

You can see what options are dynamically adjustable using lightning-listconfigs(7). Note that you can also adjust existing options for stopped plugins; they will have an effect when the plugin is restarted.

RETURN VALUE

On success, an object containing config is returned. It is an object containing:

  • config (string): name of the config variable which was set
  • source (string): source of configuration setting (file:linenum)
  • dynamic (boolean): whether this option is settable via setconfig (always true)
  • plugin (string, optional): the plugin this configuration setting is for
  • set (boolean, optional): for simple flag options
  • value_str (string, optional): for string options
  • value_msat (msat, optional): for msat options
  • value_int (integer, optional): for integer options
  • value_bool (boolean, optional): for boolean options

ERRORS

The following error codes may occur:

  • -32602: JSONRPC2_INVALID_PARAMS, i.e. the parameter is not dynamic, or the val was invalid.

AUTHOR

Rusty Russell <rusty@rustcorp.com.au> is mainly responsible for this feature.

SEE ALSO

lightningd-config(5), lightning-listconfigs(7)

RESOURCES

Main web site: https://github.com/ElementsProject/lightning