From bf8c687d6d42e9208f5157e6b48767fa99fa0845 Mon Sep 17 00:00:00 2001 From: saubyk <39208279+saubyk@users.noreply.github.com> Date: Mon, 31 Aug 2020 22:17:31 -0400 Subject: [PATCH] channel backup doc update --- docs/Channel_backups.md | 17 +++++++++++++++++ docs/recovery_from_backup.md | 17 ----------------- 2 files changed, 17 insertions(+), 17 deletions(-) delete mode 100644 docs/recovery_from_backup.md diff --git a/docs/Channel_backups.md b/docs/Channel_backups.md index 60a84464..7b1f5e6d 100644 --- a/docs/Channel_backups.md +++ b/docs/Channel_backups.md @@ -14,3 +14,20 @@ Channel backups will be taken at the following instances: - Server startup: RTL will automatically execute all channel backup, everytime the server is started. - Channel open/close: RTL will automatically execute all channel backup, everytime a new channel is opened or an existing channel is closed. - Manual backups: A user can also manually execute the backup commands. The menu options are available on the `Backup` page under `Channels`. User can take all channel backups or individual channel backups as well as verify all/individual channel backup files. + +#### Process to restore from the channel backup files +##### Assumptions +- The node has been restored with a LND's cipher seed mnemonic. +- RTL generated channel backup file/s is available (all channel backup file is `channel-all.bak`). + +##### Steps to recover the funds +- Create a `restore` folder in your backup location folder, as specified in the RTL config file. +- Place the channel backup file in the `restore` folder. +- Access the `Restore` page under the `Channels` section of RTL. +- RTL will list the options to restore funds from the all channel file or individual channel backup file. +- Click on the `Restore` button on the grid to restore the funds. +- Once the restore function is executed successfully, RTL will rename the backup file and it will no longer be visible on the page. +- Restore function will force close the channels and recover the funds from them. +- The pending close channels can be viewed on the Pending page under `Channels`. +- The corresponding pending on-chain transactions can also be viewed on the Transactions list under the `On-Chain` page. +- Once the transactions are confirmed, the channels funds will be restored to your LND Wallet. \ No newline at end of file diff --git a/docs/recovery_from_backup.md b/docs/recovery_from_backup.md deleted file mode 100644 index 5c2a267d..00000000 --- a/docs/recovery_from_backup.md +++ /dev/null @@ -1,17 +0,0 @@ -### Channel Fund Restore from the channel backup files - -#### Assumptions -- The node has been restored with a LND's cipher seed mnemonic. -- RTL generated channel backup file/s is available (all channel backup file is `channel-all.bak`). - -#### Steps to recover the funds -- Create a `restore` folder in your backup location folder, as specified in the RTL config file. -- Place the channel backup file in the `restore` folder. -- Access the `Restore` page under the `Channels` section of RTL. -- RTL will list the options to restore funds from the all channel file or individual channel backup file. -- Click on the `Restore` button on the grid to restore the funds. -- Once the restore function is executed successfully, RTL will rename the backup file and it will no longer be visible on the page. -- Restore function will force close the channels and recover the funds from them. -- The pending close channels can be viewed on the Pending page under `Channels`. -- The corresponding pending on-chain transactions can also be viewed on the Transactions list under the `On-Chain` page. -- Once the transactions are confirmed, the channels funds will be restored to your LND Wallet. \ No newline at end of file