20 |
21 | ## Restoring a Snapshot
22 |
23 | Once your snapshots are indexed, they are visible in backrest in a tree view ordered by their creation timestamp. To view details about a snapshot, click on it in the tree view. This will open a side panel with the history of operations that created the snapshot (if it was created by this backrest install) as well as the snapshot operation itself which includes:
24 |
25 | * Metadata about the snapshot
26 | * Snapshot browser which can be used to browse and restore files in the snapshot
27 |
28 | 
29 |
30 | To restore a snapshot start by browsing for the files you'd like to restore. Click on the "Snapshot Browser" shown in the red box in the image above. This view will expand to show the files in your snapshot.
31 |
32 | ::alert{type="warning"}
33 | If your repo is using remote storage browsing can be very slow as restic fetches pack files to index the directory structure of your snapshot.
34 | ::
35 |
36 | Once you have found the directory you'd like to restore, hover over the directory and click the restore icon and select "Restore to path". The restore location options are
37 |
38 | 1. Restore to a specific location, the default populated location will be the folder name + the first 8 digets of the snapshot's ID.
39 | 2. If the location is left empty, Backrest will attempt to locate and restore to your Downloads directory.
40 |
41 | Once you have selected a location, click "Restore". Backrest will begin the restore process as a new operation visible at the top of the operation tree. You can monitor the progress of the restore in the operation tree.
42 |
43 | 
44 |
45 |
--------------------------------------------------------------------------------
/docs/content/1.introduction/_dir.yml:
--------------------------------------------------------------------------------
1 | icon: ph:star-duotone
2 | navigation.redirect: /introduction/getting-started
3 |
--------------------------------------------------------------------------------
/docs/content/2.docs/3.api.md:
--------------------------------------------------------------------------------
1 | # API
2 |
3 | Backrest provides a limited HTTP API for interacting with the backrest service. To use the API authentication must be disabled (or you can optionally provide a username and password with basic auth headers) e.g. `curl -u user:password http://localhost:9898/v1/
10 | 
11 |
12 |
13 | ```
14 | {
15 | "blocks": [
16 | {
17 | "type": "section",
18 | "text": {
19 | "type": "mrkdwn",
20 | "text": "Backup: *{{ .Plan.Id }}* ➝ *{{ .Repo.Id }}* at *{{ .FormatTime .CurTime }}*"
21 | }
22 | },
23 | {
24 | "type": "divider"
25 | },
26 | {{ if .Error }}
27 | {
28 | "type": "section",
29 | "text": {
30 | "type": "mrkdwn",
31 | "text": ":x: *Snapshot failed:*\n```{{ .Error }}```"
32 | }
33 | }
34 | {{ else }}
35 | {
36 | "type": "section",
37 | "text": {
38 | "type": "mrkdwn",
39 | "text": ":white_check_mark: *Snapshot `{{ .SnapshotId }}` created*"
40 | }
41 | },
42 | {
43 | "type": "section",
44 | "fields": [
45 | {
46 | "type": "mrkdwn",
47 | "text": "*Total Added:*\n`{{ .FormatSizeBytes .SnapshotStats.DataAdded }}`"
48 | },
49 | {
50 | "type": "mrkdwn",
51 | "text": "*Files Processed:*\n`{{ .SnapshotStats.TotalFilesProcessed }}`"
52 | },
53 | {
54 | "type": "mrkdwn",
55 | "text": "*Bytes Processed:*\n`{{ .FormatSizeBytes .SnapshotStats.TotalBytesProcessed }}`"
56 | },
57 | {
58 | "type": "mrkdwn",
59 | "text": "*Time:*\n`{{ .SnapshotStats.TotalDuration }}s`"
60 | }
61 | ]
62 | },
63 | {
64 | "type": "section",
65 | "text": {
66 | "type": "mrkdwn",
67 | "text": "*Backup Stats:*\n• *Files:* `{{ .SnapshotStats.FilesNew }} new`, `{{ .SnapshotStats.FilesChanged }} changed`, `{{ .SnapshotStats.FilesUnmodified }} unmodified`\n• *Dirs:* `{{ .SnapshotStats.DirsNew }} new`, `{{ .SnapshotStats.DirsChanged }} changed`, `{{ .SnapshotStats.DirsUnmodified }} unmodified`"
68 | }
69 | }
70 | {{ end }}
71 | ]
72 | }
73 | ```
--------------------------------------------------------------------------------
/docs/content/3.cookbooks/3.reverse-proxy-examples.md:
--------------------------------------------------------------------------------
1 | # Reverse Proxy Examples
2 |
3 | ## Introduction
4 |
5 | Reverse proxies like [Caddy](https://caddyserver.com/) and [Traefik](https://traefik.io/traefik/) can be configured to front and protect your Backrest endpoint.
6 |
7 | ## Using Caddy
8 | For this example, we'll be running Caddy alongside Backrest via docker-compose.yaml but you can adapt this config to your environment.
9 |
10 | Here is an example docker-compose.yaml:
11 | ```
12 | version: "3.2"
13 | services:
14 | backrest:
15 | image: garethgeorge/backrest
16 | container_name: backrest
17 | hostname:
11 |
37 | {contents}
38 |
39 |
40 | );
41 | }
42 | return `${prefix}: ${contents}`;
43 | };
44 |
--------------------------------------------------------------------------------
/webui/src/components/ConfigProvider.tsx:
--------------------------------------------------------------------------------
1 | import React, { useContext, useEffect, useState } from "react";
2 | import { Config, Repo } from "../../gen/ts/v1/config_pb";
3 |
4 | type ConfigCtx = [Config | null, (config: Config) => void];
5 |
6 | const ConfigContext = React.createContext
62 | {displayLines.map((line, i) => (
63 |
83 | );
84 | };
85 |
--------------------------------------------------------------------------------
/webui/src/components/ModalManager.tsx:
--------------------------------------------------------------------------------
1 | import React, { useContext } from "react";
2 | import { createContext } from "react";
3 |
4 | const ModalContext = createContext<{
5 | model: React.ReactNode | null;
6 | setModel: (model: React.ReactNode | null) => void;
7 | }>({
8 | model: null,
9 | setModel: () => {
10 | throw new Error("add a ModelContextProvider to your hierarchy");
11 | },
12 | });
13 |
14 | export const ModalContextProvider = ({
15 | children,
16 | }: {
17 | children: React.ReactNode;
18 | }) => {
19 | const [modal, setModals] = React.useState
67 | {line}
68 |
69 | ))}
70 | {lines.length > limit ? (
71 | <>
72 |
80 |
81 | ) : null}
82 |