mirrors/core-lightning
1
0
Fork 0
mirror of https://github.com/ElementsProject/lightning.git synced 2024-11-19 18:11:28 +01:00
Code Issues Projects Releases Wiki Activity
efd7a5868b
core-lightning/doc/lightning-listconfigs.7.md

224 lines
10 KiB
Markdown
Raw Normal View History

Added doc file for the command getlog, help and listconfigs Signed-off-by: Vincenzo Palazzo <vincenzopalazzodev@gmail.com>
2020-08-26 14:43:56 +02:00
lightning-listconfigs -- Command to list all configuration options.
================================================================
SYNOPSIS
--------
Remove useless \
2022-01-26 18:18:49 +01:00
**listconfigs** [*config*]
Added doc file for the command getlog, help and listconfigs Signed-off-by: Vincenzo Palazzo <vincenzopalazzodev@gmail.com>
2020-08-26 14:43:56 +02:00
DESCRIPTION
-----------
doc: improve/update lightning-plugin, PLUGINS.md and lightning-listconfigs
2022-06-22 18:37:46 +02:00
*config* (optional) is a configuration option name, or "plugin" to show plugin options
The **listconfigs** RPC command to list all configuration options, or with *config* only a selection.
Added doc file for the command getlog, help and listconfigs Signed-off-by: Vincenzo Palazzo <vincenzopalazzodev@gmail.com>
2020-08-26 14:43:56 +02:00
doc: schema for listconfigs, compare with documentation. This made me document what are options are now in plugins, too. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-06-16 03:12:17 +02:00
The returned values reflect the current configuration, including
showing default values (`dev-` options are not shown).
Added doc file for the command getlog, help and listconfigs Signed-off-by: Vincenzo Palazzo <vincenzopalazzodev@gmail.com>
2020-08-26 14:43:56 +02:00
EXAMPLE JSON REQUEST
--------------------
```json
{
"id": 82,
"method": "listconfigs",
Fixed doc format and rebase Signed-off-by: Vincenzo Palazzo <vincenzopalazzodev@gmail.com>
2020-09-04 21:07:19 +02:00
"params": {
"config": "network"
}
Added doc file for the command getlog, help and listconfigs Signed-off-by: Vincenzo Palazzo <vincenzopalazzodev@gmail.com>
2020-08-26 14:43:56 +02:00
}
```
RETURN VALUE
------------
doc: schema for listconfigs, compare with documentation. This made me document what are options are now in plugins, too. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-06-16 03:12:17 +02:00
[comment]: # (GENERATE-FROM-SCHEMA-START)
On success, an object is returned, containing:
doc: generate correct markdown from schemas. You can't start a list without a paragraph separator. ```diff --- /tmp/before 2022-07-20 22:02:23.485372596 +0930 +++ /tmp/after 2022-07-20 22:02:33.745528456 +0930 @@ -21,12 +21,16 @@ On startup of the daemon, no autoclean is set up. RETURN VALUE - On success, an object is returned, containing: - enabled (boolean): - whether invoice autocleaning is active + On success, an object is returned, containing: - If enabled is true: - expired_by (u64): how long an invoice must be ex‐ - pired (seconds) before we delete it - cycle_seconds (u64): how long an - invoice must be expired (seconds) before we delete it + • enabled (boolean): whether invoice autocleaning is active + + If enabled is true: + + • expired_by (u64): how long an invoice must be expired (seconds) be‐ + fore we delete it + • cycle_seconds (u64): how long an invoice must be expired (seconds) + before we delete it AUTHOR ZmnSCPxj <ZmnSCPxj@protonmail.com> is mainly responsible. ``` Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2022-09-05 23:33:09 +02:00
doc: schema for listconfigs, compare with documentation. This made me document what are options are now in plugins, too. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-06-16 03:12:17 +02:00
- **# version** (string, optional): Special field indicating the current version
- **plugins** (array of objects, optional):
- **path** (string): Full path of the plugin
- **name** (string): short name of the plugin
- **options** (object, optional): Specific options set for this plugin:
- **important-plugins** (array of objects, optional):
- **path** (string): Full path of the plugin
- **name** (string): short name of the plugin
- **options** (object, optional): Specific options set for this plugin:
- **conf** (string, optional): `conf` field from cmdline, or default
- **lightning-dir** (string, optional): `lightning-dir` field from config or cmdline, or default
- **network** (string, optional): `network` field from config or cmdline, or default
- **allow-deprecated-apis** (boolean, optional): `allow-deprecated-apis` field from config or cmdline, or default
- **rpc-file** (string, optional): `rpc-file` field from config or cmdline, or default
- **disable-plugin** (array of strings, optional):
- `disable-plugin` field from config or cmdline
bkpr: add option --bookkeeper-dir Allow setting custom directory for bookkeeper's database and default directory for any csv file creation
2022-07-19 09:34:37 +02:00
- **bookkeeper-dir** (string, optional): `bookkeeper-dir` field from config or cmdline, or default
bkpr: Add an option to set the database to something else (postgres) `lightningd` has an option --wallet that lets you supply a database dsn string to connect to a sqlite3/postgres database that's hosted/stored elsewhere. This adds the `--bookkeeper-db` option which does the same, except for the bookkeeping data for a node! Note that the default is to go in the `lightning-dir` in a database called `accounts.sqlite3`
2022-07-19 09:34:40 +02:00
- **bookkeeper-db** (string, optional): `bookkeeper-db` field from config or cmdline, or default
doc: schema for listconfigs, compare with documentation. This made me document what are options are now in plugins, too. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-06-16 03:12:17 +02:00
- **always-use-proxy** (boolean, optional): `always-use-proxy` field from config or cmdline, or default
- **daemon** (boolean, optional): `daemon` field from config or cmdline, or default
- **wallet** (string, optional): `wallet` field from config or cmdline, or default
- **large-channels** (boolean, optional): `large-channels` field from config or cmdline, or default
- **experimental-dual-fund** (boolean, optional): `experimental-dual-fund` field from config or cmdline, or default
- **experimental-onion-messages** (boolean, optional): `experimental-onion-messages` field from config or cmdline, or default
- **experimental-offers** (boolean, optional): `experimental-offers` field from config or cmdline, or default
- **experimental-shutdown-wrong-funding** (boolean, optional): `experimental-shutdown-wrong-funding` field from config or cmdline, or default
experimental-websocket-port: option to create a WebSocket port. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-10-18 02:13:33 +02:00
- **experimental-websocket-port** (u16, optional): `experimental-websocket-port` field from config or cmdline, or default
lightningd: refuse to upgrade db on non-released versions by default. This is a good sanity check that users understand that if they upgrade to master mid-cycle they can't go back! Suggested-by: @wtogami Changelog-Added: Config: `--database-upgrade=true` required if a non-release version wants to (irrevocably!) upgrade the db. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2022-08-24 12:05:42 +02:00
- **database-upgrade** (boolean, optional): `database-upgrade` field from config or cmdline
doc: schema for listconfigs, compare with documentation. This made me document what are options are now in plugins, too. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-06-16 03:12:17 +02:00
- **rgb** (hex, optional): `rgb` field from config or cmdline, or default (always 6 characters)
- **alias** (string, optional): `alias` field from config or cmdline, or default
- **pid-file** (string, optional): `pid-file` field from config or cmdline, or default
- **ignore-fee-limits** (boolean, optional): `ignore-fee-limits` field from config or cmdline, or default
- **watchtime-blocks** (u32, optional): `watchtime-blocks` field from config or cmdline, or default
- **max-locktime-blocks** (u32, optional): `max-locktime-blocks` field from config or cmdline, or default
- **funding-confirms** (u32, optional): `funding-confirms` field from config or cmdline, or default
- **cltv-delta** (u32, optional): `cltv-delta` field from config or cmdline, or default
- **cltv-final** (u32, optional): `cltv-final` field from config or cmdline, or default
- **commit-time** (u32, optional): `commit-time` field from config or cmdline, or default
- **fee-base** (u32, optional): `fee-base` field from config or cmdline, or default
- **rescan** (integer, optional): `rescan` field from config or cmdline, or default
- **fee-per-satoshi** (u32, optional): `fee-per-satoshi` field from config or cmdline, or default
- **max-concurrent-htlcs** (u32, optional): `max-concurrent-htlcs` field from config or cmdline, or default
doc: htlc_minimum_msat htlc_maximum_msat announce_discovered_ip doc/schemas: adds htlc min/max and ip discovery
2022-03-26 14:36:28 +01:00
- **htlc-minimum-msat** (msat, optional): `htlc-minimum-msat` field from config or cmdline, or default
- **htlc-maximum-msat** (msat, optional): `htlc-maximum-msat` field from config or cmdline, or default
lightningd: new option for htlc dust limit To reduce the surface area of amount of a channel balance that can be eaten up as htlc dust, we introduce a new config '--max-dust-htlc-exposure-msat', which sets the max amount that any channel's balance can be added as dust Changelog-Added: config: new option --max-dust-htlc-exposure-msat, which limits the total amount of sats to be allowed as dust on a channel
2021-09-28 21:03:08 +02:00
- **max-dust-htlc-exposure-msat** (msat, optional): `max-dust-htlc-exposure-mast` field from config or cmdline, or default
doc: schema for listconfigs, compare with documentation. This made me document what are options are now in plugins, too. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-06-16 03:12:17 +02:00
- **min-capacity-sat** (u64, optional): `min-capacity-sat` field from config or cmdline, or default
- **addr** (string, optional): `addr` field from config or cmdline (can be more than one)
- **announce-addr** (string, optional): `announce-addr` field from config or cmdline (can be more than one)
- **bind-addr** (string, optional): `bind-addr` field from config or cmdline (can be more than one)
- **offline** (boolean, optional): `true` if `offline` was set in config or cmdline
- **autolisten** (boolean, optional): `autolisten` field from config or cmdline, or default
- **proxy** (string, optional): `proxy` field from config or cmdline, or default
- **disable-dns** (boolean, optional): `true` if `disable-dns` was set in config or cmdline
doc: htlc_minimum_msat htlc_maximum_msat announce_discovered_ip doc/schemas: adds htlc min/max and ip discovery
2022-03-26 14:36:28 +01:00
- **disable-ip-discovery** (boolean, optional): `true` if `disable-ip-discovery` was set in config or cmdline
doc: schema for listconfigs, compare with documentation. This made me document what are options are now in plugins, too. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-06-16 03:12:17 +02:00
- **encrypted-hsm** (boolean, optional): `true` if `encrypted-hsm` was set in config or cmdline
- **rpc-file-mode** (string, optional): `rpc-file-mode` field from config or cmdline, or default
- **log-level** (string, optional): `log-level` field from config or cmdline, or default
- **log-prefix** (string, optional): `log-prefix` field from config or cmdline, or default
- **log-file** (string, optional): `log-file` field from config or cmdline, or default
- **log-timestamps** (boolean, optional): `log-timestamps` field from config or cmdline, or default
doc: fix GH/readthedocs rendering of manual pages. They render the comment as if it's in the list. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-09-03 12:07:59 +02:00
- **force-feerates** (string, optional): force-feerate configuration setting, if any
doc: schema for listconfigs, compare with documentation. This made me document what are options are now in plugins, too. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-06-16 03:12:17 +02:00
- **subdaemon** (string, optional): `subdaemon` fields from config or cmdline if any (can be more than one)
lightningd: allow extra tlv types in non-experimental mode. The old `experimental-accept-extra-tlv-types` is now `accept-htlc-tlv-types`. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au> Changelog-Added: Config: `accept-htlc-tlv-types` lets us accept unknown even HTLC TLV fields we would normally reject on parsing (was EXPERIMENTAL-only `experimental-accept-extra-tlv-types`).
2022-09-21 06:09:51 +02:00
- **fetchinvoice-noconnect** (boolean, optional): `fetchinvoice-noconnect` fields from config or cmdline, or default
- **accept-htlc-tlv-types** (string, optional): `accept-extra-tlvs-type` fields from config or cmdline, or not present
doc: schema for listconfigs, compare with documentation. This made me document what are options are now in plugins, too. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-06-16 03:12:17 +02:00
- **tor-service-password** (string, optional): `tor-service-password` field from config or cmdline, if any
opening: Add `dev-allowdustreserve` option to opt into dust reserves Technically this is a non-conformance with the spec, hence the `dev` flag to opt-in, however I'm being told that it is also implemented in other implementations. I'll follow this up with a proposal to the spec to remove the checks we now bypass.
2022-06-24 12:58:26 +02:00
- **dev-allowdustreserve** (boolean, optional): Whether we allow setting dust reserves
fromschema.py: escape underscores in descriptions
2022-11-11 03:03:13 +01:00
- **announce-addr-dns** (boolean, optional): Whether we put DNS entries into node\_announcement
doc: fix GH/readthedocs rendering of manual pages. They render the comment as if it's in the list. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-09-03 12:07:59 +02:00
doc: schema for listconfigs, compare with documentation. This made me document what are options are now in plugins, too. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-06-16 03:12:17 +02:00
[comment]: # (GENERATE-FROM-SCHEMA-END)
doc: language tidyups and a few minor refinements. Some additional detail was warranted in several places, though the listconfigs is better off simply referring to lightningd-config. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au> Changelog-Fixed: doc: Many missing manual pages were completed
2020-09-07 12:46:28 +02:00
Fixed doc format and rebase Signed-off-by: Vincenzo Palazzo <vincenzopalazzodev@gmail.com>
2020-09-04 21:07:19 +02:00
Added doc file for the command getlog, help and listconfigs Signed-off-by: Vincenzo Palazzo <vincenzopalazzodev@gmail.com>
2020-08-26 14:43:56 +02:00
On failure, one of the following error codes may be returned:
Fixed mistake inside the docs Thanks @rustyrussell. Signed-off-by: Vincenzo Palazzo <vincenzopalazzodev@gmail.com>
2020-08-31 14:42:28 +02:00
- -32602: Error in given parameters or field with *config* name doesn't exist.
Added doc file for the command getlog, help and listconfigs Signed-off-by: Vincenzo Palazzo <vincenzopalazzodev@gmail.com>
2020-08-26 14:43:56 +02:00
EXAMPLE JSON RESPONSE
---------------------
```json
{
"# version": "v0.9.0-1",
"lightning-dir": "/media/vincent/Maxtor/sanboxTestWrapperRPC/lightning_dir_dev",
"network": "testnet",
"allow-deprecated-apis": true,
"rpc-file": "lightning-rpc",
"plugins": [
{
"path": "/home/vincent/Github/plugins/sauron/sauron.py",
"name": "sauron.py",
"options": {
"sauron-api-endpoint": "http://blockstream.info/testnet/api/",
"sauron-tor-proxy": ""
}
},
{
"path": "/home/vincent/Github/reckless/reckless.py",
"name": "reckless.py"
}
],
"important-plugins": [
{
"path": "/home/vincent/Github/lightning/lightningd/../plugins/autoclean",
"name": "autoclean",
"options": {
"autocleaninvoice-cycle": null,
"autocleaninvoice-expired-by": null
}
},
{
"path": "/home/vincent/Github/lightning/lightningd/../plugins/fundchannel",
"name": "fundchannel"
},
{
"path": "/home/vincent/Github/lightning/lightningd/../plugins/keysend",
"name": "keysend"
},
{
"path": "/home/vincent/Github/lightning/lightningd/../plugins/pay",
"name": "pay",
"options": {
"disable-mpp": false
}
}
],
"important-plugin": "/home/vincent/Github/lightning/lightningd/../plugins/autoclean",
"important-plugin": "/home/vincent/Github/lightning/lightningd/../plugins/fundchannel",
"important-plugin": "/home/vincent/Github/lightning/lightningd/../plugins/keysend",
"important-plugin": "/home/vincent/Github/lightning/lightningd/../plugins/pay",
"plugin": "/home/vincent/Github/plugins/sauron/sauron.py",
"plugin": "/home/vincent/Github/reckless/reckless.py",
"disable-plugin": [
"bcli"
],
"always-use-proxy": false,
"daemon": "false",
"wallet": "sqlite3:///media/vincent/Maxtor/sanboxTestWrapperRPC/lightning_dir_dev/testnet/lightningd.sqlite3",
"wumbo": false,
"wumbo": false,
"rgb": "03ad98",
"alias": "BRUCEWAYN-TES-DEV",
"pid-file": "/media/vincent/Maxtor/sanboxTestWrapperRPC/lightning_dir_dev/lightningd-testne...",
"ignore-fee-limits": true,
"watchtime-blocks": 6,
"max-locktime-blocks": 2016,
"funding-confirms": 1,
"commit-fee-min": 0,
"commit-fee-max": 0,
"cltv-delta": 6,
"cltv-final": 10,
"commit-time": 10,
"fee-base": 1,
"rescan": 30,
"fee-per-satoshi": 10,
"max-concurrent-htlcs": 483,
"min-capacity-sat": 10000,
"addr": "autotor:127.0.0.1:9051",
"bind-addr": "127.0.0.1:9735",
"announce-addr": "fp463inc4w3lamhhduytrwdwq6q6uzugtaeapylqfc43agrdnnqsheyd.onion:9735",
"offline": "false",
"autolisten": true,
"proxy": "127.0.0.1:9050",
"disable-dns": "false",
"encrypted-hsm": false,
"rpc-file-mode": "0600",
"log-level": "DEBUG",
"log-prefix": "lightningd",
}
```
AUTHOR
------
Vincenzo Palazzo <<vincenzo.palazzo@protonmail.com>> wrote the initial version of this man page, but many others did the hard work of actually implementing this rpc command.
SEE ALSO
--------
doc: language tidyups and a few minor refinements. Some additional detail was warranted in several places, though the listconfigs is better off simply referring to lightningd-config. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au> Changelog-Fixed: doc: Many missing manual pages were completed
2020-09-07 12:46:28 +02:00
lightning-getinfo(7), lightningd-config(5)
Added doc file for the command getlog, help and listconfigs Signed-off-by: Vincenzo Palazzo <vincenzopalazzodev@gmail.com>
2020-08-26 14:43:56 +02:00
RESOURCES
---------
Main web site: <https://github.com/ElementsProject/lightning>
dox: fix "sphinx-build -b html" warning: reference target not found when runnning `sphinx-build -b html . build/`: WARNING: None:any reference target not found: #
2022-12-09 08:10:12 +01:00
doc: sphinx-build fix external links (urls), language warning and broken footnote
2022-12-09 08:09:07 +01:00
[comment]: # ( SHA256STAMP:862a1d319a30cb4a0e851d0d57b62eef78d7b7e35f76c70c6bc71d4d2f270a94)
Reference in New Issue Copy Permalink