Skip to content

Commit bf36b01

Browse files
committed
docs: update README.md with new screenshots
1 parent b19438a commit bf36b01

File tree

2 files changed

+13
-21
lines changed

2 files changed

+13
-21
lines changed

README.md

+12-20
Original file line numberDiff line numberDiff line change
@@ -37,10 +37,14 @@ Backrest is a fully open source web UI wrapper for [restic](https://restic.net/)
3737

3838
# Preview
3939

40-
| | |
41-
| -------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
42-
| <img src="https://f000.backblazeb2.com/file/gshare/screenshots/restora-backup-view.png" width="400px"/> | <img src="https://f000.backblazeb2.com/file/gshare/screenshots/restora-add-repo.png" width="400px" /> |
43-
| <img src="https://f000.backblazeb2.com/file/gshare/screenshots/restora-realtime-progress.png" width="400px" /> | <img src="https://f000.backblazeb2.com/file/gshare/screenshots/restora-add-plan.png" width="400px" /> |
40+
Operation History & Snapshot Browser
41+
42+
<img src="https://f000.backblazeb2.com/file/gshare/screenshots/2024/Screenshot+from+2024-01-04+18-30-14.png" width="700px" />
43+
44+
Repo Creation Wizard
45+
46+
<img src="https://f000.backblazeb2.com/file/gshare/screenshots/2024/Screenshot+from+2024-01-04+18-19-50.png" width="700px" />
47+
4448

4549
# Getting Started
4650

@@ -60,7 +64,6 @@ Note: backrest installs a specific restic version to ensure that the version of
6064

6165
Docker image: https://hub.docker.com/garethgeorge/backrest
6266

63-
<details>
6467
Example compose file:
6568

6669
```yaml
@@ -74,6 +77,7 @@ services:
7477
- ./backrest/config:/config
7578
- ./backrest/cache:/cache
7679
- /MY-BACKUP-DATA:/userdata # mount your directories to backup somewhere in the filesystem
80+
- /MY-REPOS:/repos # (optional) mount your restic repositories somewhere in the filesystem.
7781
environment:
7882
- BACKREST_DATA=/data # path for backrest data. restic binary and the database are placed here.
7983
- BACKREST_CONFIG=/config/config.json # path for the backrest config file.
@@ -82,12 +86,9 @@ services:
8286
ports:
8387
- 9898:9898
8488
```
85-
</details>
8689
8790
## Running on Linux
8891
89-
<details>
90-
9192
Download a release from the [releases page](https://github.com/garethgeorge/backrest/releases)
9293
9394
#### Using systemd with the install script (Recommended)
@@ -155,12 +156,8 @@ sudo systemctl start backrest
155156

156157
Note: you can set the linux user and group to your primary user (e.g. `whoami` when logged in).
157158

158-
</details>
159-
160159
## Running on MacOS
161160

162-
<details>
163-
164161
Download a Darwin release from the [releases page](https://github.com/garethgeorge/backrest/releases) and install it to `/usr/local/bin`.
165162

166163
#### 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
186183

187184
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.
188185

189-
</details>
190-
191186
## Running on Windows
192187

193-
<details>
194-
195188
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).
196189

197190
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.
198191

199192
warning: If you get filesystem errors you may need to run Backrest as administrator for full filesystem access.
200193

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.
204195

205196
# Configuration
206197

@@ -212,7 +203,7 @@ warning: Backrest is not tested on Windows to the same bar as Linux and MacOS. P
212203
* `BACKREST_RESTIC_COMMAND` - the path to the restic binary. Defaults managed version of restic which will be downloaded and installed in the data directory.
213204
* `XDG_CACHE_HOME` -- the path to the cache directory. This is propagated to restic.
214205

215-
# Usage
206+
# User Guide
216207

217208
## Adding a Repository
218209

@@ -236,3 +227,4 @@ Backups are run automatically based on the scheduled specified in your plan. You
236227
* Backup your configuration (e.g. `$BACKREST_CONFIG` or `$HOME/.config/backrest/config.json` by default on Linux/MacOS)
237228
* Your configuration contains the encryption keys for your repositories. If you loose this file you will not be able to restore your backups.
238229
* You may alternatively backup your encryption keys individually in which case you will be able to use restic directly to restore your backups.
230+

webui/src/index.tsx

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ el &&
2626
<ConfigProvider
2727
theme={{
2828
algorithm: [
29-
darkThemeMq ? theme.darkAlgorithm : theme.defaultAlgorithm,
29+
darkThemeMq.matches ? theme.darkAlgorithm : theme.defaultAlgorithm,
3030
theme.compactAlgorithm,
3131
],
3232
}}

0 commit comments

Comments
 (0)