From f66af8d2cfe7668fd6aad9d9ccbbc7c68b7b0844 Mon Sep 17 00:00:00 2001 From: "Wladimir J. van der Laan" Date: Fri, 12 Feb 2021 12:47:26 +0100 Subject: [PATCH] backup: Add section on backup compaction to README --- backup/README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/backup/README.md b/backup/README.md index 4caa81a..4f110cb 100644 --- a/backup/README.md +++ b/backup/README.md @@ -57,6 +57,19 @@ On daemon startup the plugin will check the integrity of the existing backup and complain if there is a version mismatch. +## Performing backup compaction + +A backup compaction incorporates incremental updates into a single snapshot. +This will reduce the size of the backup file and reduce the time needed to +restore the backup. This can be done through the plugin command `backup-compact`: + +``` +lightning-cli backup-compact +``` + +Be aware that this can take a long time depending on the size of the backup +and I/O speeds, during which the daemon will not be reachable. + ## Restoring a backup If things really messed up and you need to reinstall clightning, you can