LIGHTNING-SETCONFIG(7)

✨ NAME ✨

bestie, this is LIGHTNING-SETCONFIG(7) — and the command is setconfig: dynamically change some config options 💅

---

🫶 SYNOPSIS 🫶

setconfig config [val] [transient]

---

🌸 DESCRIPTION 🌸

Command added in v23.08.

The setconfig RPC command lets 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.setconfig file (but see lightningd-config), for persistence across restarts (and any old value commented out if they were set in other config files). Slay, persistence 💖

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. Iconic behavior, honestly ✨

• config (string) — name of the config variable which should be set to the value of the variable.
• val (one of, optional) — value of the config variable to be set or updated. For multi options, this must be an array of strings, and the possible shapes are:
  • (string)
  • (integer)
  • (boolean)
  • (array of strings) — for multi options, an array of string values.
  • (string, optional)
• transient (boolean, optional) — if set, this change does NOT try to alter the configuration files, so the change will be reverted on any restart. The default is False. (added v25.02)

---

👑 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.
• dynamic (boolean) (always true) — whether this option is settable via setconfig.
• source (string, optional) — source of configuration setting (file:linenum) for non-multi options.
• sources (array of strings, optional) — sources of configuration settings (file:linenum) for multi options. (added v26.06):
  • (string, optional)
• 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.
• values_str (array of strings, optional) — for multi-string options. (added v26.06):
  • (string, optional)

---

😭 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 🎀

Go check out lightningd-config(5) and lightning-listconfigs(7) — iykyk 💖

---

🌈 RESOURCES 🌈

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

---

🔥 EXAMPLES 🔥

Example 1:

Request:

$ lightning-cli setconfig "autoclean-expiredinvoices-age" "300"

{
  "id": "example:setconfig#1",
  "method": "setconfig",
  "params": [
    "autoclean-expiredinvoices-age",
    300
  ]
}

Response:

{
  "config": {
    "config": "autoclean-expiredinvoices-age",
    "value_int": 300,
    "source": "/tmp/.lightning/regtest/config.setconfig:2",
    "plugin": "/root/lightning/plugins/autoclean",
    "dynamic": true
  }
}

Example 2:

Request:

$ lightning-cli setconfig -k "config"="min-capacity-sat" "val"=500000

{
  "id": "example:setconfig#2",
  "method": "setconfig",
  "params": {
    "config": "min-capacity-sat",
    "val": 500000
  }
}

Response:

{
  "config": {
    "config": "min-capacity-sat",
    "value_int": 500000,
    "source": "/tmp/.lightning/regtest/config.setconfig:3",
    "dynamic": true
  }
}

Example 3: This shows setting a multi-value dynamic plugin option (requires a plugin that defines such an option).

Request:

$ lightning-cli setconfig -k "config"="my-multi-option" "val"='["value1", "value2"]'

{
  "id": "example:setconfig#3",
  "method": "setconfig",
  "params": {
    "config": "my-multi-option",
    "val": [
      "value1",
      "value2"
    ]
  }
}

Response:

{
  "config": {
    "config": "my-multi-option",
    "values_str": [
      "value1",
      "value2"
    ],
    "sources": [
      "/tmp/.lightning/regtest/config.setconfig:4",
      "/tmp/.lightning/regtest/config.setconfig:5"
    ],
    "plugin": "/root/lightning/plugins/myplugin",
    "dynamic": true
  }
}

---

okay bestie, that’s the whole page — brought to you by Core Lightning v26.06.9 and the LIGHTNING-SETCONFIG(7) manual page. mwah 💋✨