Ride-The-Lightning-RTL/.github/docs/Channel_backups.md

### Channel Backups
Static Channel Backup APIs of LND has been leveraged to provide channel backup feature on RTL.

#### Backup folder location
Default location: If no folder location is specified in the RTL conf files (single or mult-node setup), RTL will create a folder `backup` on the RTL root. If multiple nodes are being managed via RTL, multiple node sub-folders will be created in the `backup` folder.

User defined: User can specify the folder where channel backups should be created, by setting a config variable `channelBackupPath` in the `RTL-Config.json` file. Please ensure that RTL has the permission to write in the specified folder location.

Environment variable: Channel backup folder location can also be controlled via an environment variable `CHANNEL_BACKUP_PATH`

#### Backup execution
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.
Update Channel_backups.md 2019-06-19 11:45:53 +02:00			`### Channel Backups`
Create Channel_backups.md 2019-06-19 11:33:18 +02:00			`Static Channel Backup APIs of LND has been leveraged to provide channel backup feature on RTL.`

			`#### Backup folder location`
Update Channel_backups.md 2019-06-19 11:45:53 +02:00			Default location: If no folder location is specified in the RTL conf files (single or mult-node setup), RTL will create a folder `backup` on the RTL root. If multiple nodes are being managed via RTL, multiple node sub-folders will be created in the `backup` folder.

Documentation Updated Documentation Updated 2020-01-20 17:15:04 +01:00			User defined: User can specify the folder where channel backups should be created, by setting a config variable `channelBackupPath` in the `RTL-Config.json` file. Please ensure that RTL has the permission to write in the specified folder location.
Update Channel_backups.md 2019-06-19 11:45:53 +02:00
Update Channel_backups.md 2019-06-19 11:48:18 +02:00			Environment variable: Channel backup folder location can also be controlled via an environment variable `CHANNEL_BACKUP_PATH`

Update Channel_backups.md 2019-06-19 11:45:53 +02:00			`#### Backup execution`
			`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.
channel backup doc update 2020-09-01 04:17:31 +02:00
			`#### 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.`