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
Note: you can set the linux user and group to your primary user (e.g. `whoami` when logged in).
157
158
158
-
</details>
159
-
160
159
## Running on MacOS
161
160
162
-
<details>
163
-
164
161
Download a Darwin release from the [releases page](https://github.com/garethgeorge/backrest/releases) and install it to `/usr/local/bin`.
165
162
166
163
#### Using launchd with the install script (Recommended)
@@ -186,21 +183,15 @@ Read the script before running it to make sure you are comfortable with these op
186
183
187
184
If setting up backrest manually it's recommended to install the binary to `/usr/local/bin` and run it manually. You can also create a launch agent to run it on startup or may run it manually when needed.
188
185
189
-
</details>
190
-
191
186
## Running on Windows
192
187
193
-
<details>
194
-
195
188
Download a Windows release from the [releases page](https://github.com/garethgeorge/backrest/releases) and install it to `C:\Program Files\Backrest\backrest.exe` (create the path if it does not exist).
196
189
197
190
To run the binary on login, create a shortcut to the binary and place it in the `shell:startup` folder. See [this windows support article](https://support.microsoft.com/en-us/windows/add-an-app-to-run-automatically-at-startup-in-windows-10-150da165-dcd9-7230-517b-cf3c295d89dd) for more details.
198
191
199
192
warning: If you get filesystem errors you may need to run Backrest as administrator for full filesystem access.
200
193
201
-
warning: Backrest is not tested on Windows to the same bar as Linux and MacOS. Please report any issues you encounter. Some folders may not be accessible to Backrest or to restic on Windows due to permissions issues.
202
-
203
-
</details>
194
+
warning: Backrest is not tested on Windows to the same bar as Linux and MacOS. Some features may not work as expected.
204
195
205
196
# Configuration
206
197
@@ -212,7 +203,7 @@ warning: Backrest is not tested on Windows to the same bar as Linux and MacOS. P
212
203
*`BACKREST_RESTIC_COMMAND` - the path to the restic binary. Defaults managed version of restic which will be downloaded and installed in the data directory.
213
204
*`XDG_CACHE_HOME` -- the path to the cache directory. This is propagated to restic.
214
205
215
-
# Usage
206
+
# User Guide
216
207
217
208
## Adding a Repository
218
209
@@ -236,3 +227,4 @@ Backups are run automatically based on the scheduled specified in your plan. You
236
227
* Backup your configuration (e.g. `$BACKREST_CONFIG` or `$HOME/.config/backrest/config.json` by default on Linux/MacOS)
237
228
* Your configuration contains the encryption keys for your repositories. If you loose this file you will not be able to restore your backups.
238
229
* You may alternatively backup your encryption keys individually in which case you will be able to use restic directly to restore your backups.
0 commit comments