Skip to content

Commit

Permalink
doc: recover.
Browse files Browse the repository at this point in the history
Signed-off-by: Rusty Russell <[email protected]>
  • Loading branch information
rustyrussell committed Oct 23, 2023
1 parent c9470c7 commit d1cae99
Show file tree
Hide file tree
Showing 3 changed files with 44 additions and 0 deletions.
1 change: 1 addition & 0 deletions doc/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,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 \
Expand Down
1 change: 1 addition & 0 deletions doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,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>
Expand Down
42 changes: 42 additions & 0 deletions doc/lightning-recover.7.md
Original file line number Diff line number Diff line change
@@ -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 <<[email protected]>> is mainly responsible.

SEE ALSO
--------

lightning-hsmtool(7)

RESOURCES
---------

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

[comment]: # ( SHA256STAMP:9cfaa9eb4609b36accc3e3b12a352c00ddd402307e4461f4df274146d12f6eb0)

0 comments on commit d1cae99

Please sign in to comment.