mirror of
https://github.com/ElementsProject/lightning.git
synced 2025-01-19 05:44:12 +01:00
doc: recover.
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
This commit is contained in:
parent
a50b795bc2
commit
13fec8d657
@ -88,6 +88,7 @@ MANPAGES := doc/lightning-cli.1 \
|
||||
doc/lightning-plugin.7 \
|
||||
doc/lightning-preapproveinvoice.7 \
|
||||
doc/lightning-preapprovekeysend.7 \
|
||||
doc/lightning-recover.7 \
|
||||
doc/lightning-recoverchannel.7 \
|
||||
doc/lightning-renepay.7 \
|
||||
doc/lightning-renepaystatus.7 \
|
||||
|
@ -100,6 +100,7 @@ Core Lightning Documentation
|
||||
lightning-plugin <lightning-plugin.7.md>
|
||||
lightning-preapproveinvoice <lightning-preapproveinvoice.7.md>
|
||||
lightning-preapprovekeysend <lightning-preapprovekeysend.7.md>
|
||||
lightning-recover <lightning-recover.7.md>
|
||||
lightning-recoverchannel <lightning-recoverchannel.7.md>
|
||||
lightning-renepay <lightning-renepay.7.md>
|
||||
lightning-renepaystatus <lightning-renepaystatus.7.md>
|
||||
|
42
doc/lightning-recover.7.md
Normal file
42
doc/lightning-recover.7.md
Normal file
@ -0,0 +1,42 @@
|
||||
lightning-recover -- Reinitialize Your Node for Recovery
|
||||
========================================================
|
||||
|
||||
SYNOPSIS
|
||||
--------
|
||||
|
||||
**recover** *hsmsecret*
|
||||
|
||||
DESCRIPTION
|
||||
-----------
|
||||
|
||||
The **recover** RPC command wipes your node and restarts it with
|
||||
the `--recover` option. This is only permitted if the node is unused:
|
||||
no channels, no bitcoin addresses issued (you can use `check` to see
|
||||
if recovery is possible).
|
||||
|
||||
*hsmsecret* is either a codex32 secret starting with "cl1" as returned
|
||||
by `hsmtool getcodexsecret`, or a raw 64 character hex string.
|
||||
|
||||
NOTE: this command only currently works with the `sqlite3` database backend.
|
||||
|
||||
RETURN VALUE
|
||||
------------
|
||||
|
||||
On success, an empty object is returned, and your node is restarted.
|
||||
|
||||
AUTHOR
|
||||
------
|
||||
|
||||
Rusty Russell <<rusty@blockstream.com>> is mainly responsible.
|
||||
|
||||
SEE ALSO
|
||||
--------
|
||||
|
||||
lightning-hsmtool(7)
|
||||
|
||||
RESOURCES
|
||||
---------
|
||||
|
||||
Main web site: <https://github.com/ElementsProject/lightning>
|
||||
|
||||
[comment]: # ( SHA256STAMP:9cfaa9eb4609b36accc3e3b12a352c00ddd402307e4461f4df274146d12f6eb0)
|
Loading…
Reference in New Issue
Block a user