From 3cff6577dadf5bf4f199d66c3edf76ed96d42f3a Mon Sep 17 00:00:00 2001 From: a-kenji Date: Sun, 16 Feb 2025 13:04:53 +0700 Subject: [PATCH] docs: Extend backups guide Closes #2792 --- docs/site/getting-started/backups.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/docs/site/getting-started/backups.md b/docs/site/getting-started/backups.md index ad72eabf8..9cde83f40 100644 --- a/docs/site/getting-started/backups.md +++ b/docs/site/getting-started/backups.md @@ -143,3 +143,25 @@ Ensure the path to the public key is correct. ```bash clan backups create mymachine ``` + +- **Restoring Backups:** To restore a backup that has been listed by the list command (NAME): + + ```bash + clan backups restore [MACHINE] [PROVIDER] [NAME] + + ``` + + Example (Restoring a machine called `client` with the backup provider `borgbackup`): + + ```bash + clan backups restore client borgbackup [NAME] + + ``` + + The `backups` command is service aware and allows optional specification of the `--service` flag. + + To only restore the service called `zerotier` on a machine called `controller` through the backup provider `borgbackup` use the following command: + +```bash + clan backups restore client borgbackup [NAME] --service zerotier +```