mirror of
https://github.com/ElementsProject/lightning.git
synced 2024-11-20 10:39:49 +01:00
703ffdf59b
Do it slightly intelligently, so if we had set previously using setconfig we don't keep appending new ones, but replace it in-place. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
60 lines
2.0 KiB
Markdown
60 lines
2.0 KiB
Markdown
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 (and any old value commented out).
|
|
|
|
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
|
|
------------
|
|
|
|
[comment]: # (GENERATE-FROM-SCHEMA-START)
|
|
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
|
|
|
|
[comment]: # (GENERATE-FROM-SCHEMA-END)
|
|
|
|
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>
|
|
|
|
[comment]: # ( SHA256STAMP:d61e4e6eea7b8c214644334ee194b273aef2a8a26465adfcd685be0d70653966)
|