You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+12-9Lines changed: 12 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -94,13 +94,13 @@ For those familiar with setting up backup scripts, here is a fast track to get y
94
94
95
95
-----
96
96
97
-
### Restoring Your Data
97
+
### Restoring Data
98
98
99
-
The script provides three distinct modes for restoring data, each designed for a different scenario.
99
+
Script provides three distinct modes for restoring data, each designed for a different scenario.
100
100
101
101
#### 1. Interactive Restore (`--restore`)
102
102
103
-
This is a user-friendly wizard for guided restores. It is the best option when you are at the terminal and need to find and recover specific files or directories.
103
+
This is an interactive wizard for guided restores. It is the best option when you are at the terminal and need to find and recover specific files or directories.
104
104
105
105
- **Best for**: Visually finding and restoring specific files or small directories.
106
106
- **Process**:
@@ -122,9 +122,9 @@ This mode is designed for restoring large amounts of data (e.g., a full server r
122
122
- **Best for**: Large, time-consuming restores or recovering data over a slow network connection.
123
123
- **How it works**:
124
124
- This command is **non-interactive**. You must provide the snapshot ID and destination path as arguments directly on the command line.
125
-
- The restore job is launched in the background, immediately freeing up your terminal.
125
+
- The restore job is launched in the background, immediately freeing up terminal.
126
126
- All output is saved to a log file in`/tmp/`.
127
-
- You will receive a success or failure notification (via ntfy, Discord, etc.) upon completion.
127
+
- A success or failure notification (via ntfy, Discord, etc.) upon completion.
This mode runs the restore in the foreground and waits for it to complete before exiting. It's a reliable, non-interactive way to create a complete, consistent copy of your backup data.
141
+
This mode runs the restore in the foreground and waits for it to complete before exiting. It's a reliable, non-interactive way to create a complete, consistent copy of backup data.
142
142
143
-
- **Best for**: Creating a secondary copy of your backup on another server (for a 3-2-1 strategy) or for use in any automation where subsequent steps depend on the restore being finished.
143
+
- **Best for**: Creating a secondary copy of backup (for example, via a cron job) on another server (for a 3-2-1 strategy) or for use in any automation where subsequent steps depend on the restore being finished.
144
144
- **How it works**:
145
145
- This command is **non-interactive** and requires the snapshot ID and destination path as command-line arguments.
146
-
- It runs as a foreground process, blocking the terminal or script until the restore is 100% complete.
147
-
- This guarantees the data copy is finished before any other commands are run.
146
+
- It runs as a synchronous (blocking) process. When a cron job executes the command, the job itself will not finish until the restore is 100% complete.
147
+
- This guarantees the data copy is finished before any other commands are run or the cron job is marked as complete.
148
148
149
149
**Usage:**
150
150
151
151
```sh
152
152
# On a second server, pull a full copy of the latest backup
0 commit comments