docs: update README.md and docs wiki

This commit is contained in:
garethgeorge
2024-04-18 00:40:31 -07:00
parent eb870cc090
commit c297d3cd65
4 changed files with 12 additions and 32 deletions
+10 -22
View File
@@ -33,33 +33,21 @@ Backrest itself is built in Golang (matching restic's implementation) and is shi
**Features**
* WebUI for restic supports local and remote access (e.g. run on a NAS and access from your desktop)
* Realtime UI e.g. live progress bars for backup operations and live refreshes of operation history.
* Snapshot browser
* Restore interface
* Configurable backup plans
* Cronexprs provide flexible scheduling options
* Configurable retention policies with restic forget (e.g. keep 1 snapshot per day for 30 days, 1 snapshot per week for 6 months, etc)
* Include lists
* Exclusion lists
* Add custom CLI flags for detailed control of restic e.g. for use with rclone
* Supported destinations are any restic supported repository (e.g. local filesystem, S3, Backblaze, rclone, etc).
* Automatic repo health operations e.g. forget and prune.
* Forget runs after every backup.
* Prune once every 7 days by default.
* Multiple backup plans can be configured running on different schedules and with different retention policies.
* Multiple restic repositories can be configured and used in different plans.
* Event hooks for notifications
* Lifecycle hooks are triggered with status information from operations backrest runs on your behalf.
* Supported services: Discord, Gotify, Shell Command
* Events: Backup Start, Backup Finish, Backup Error, Any Error
* Multi-user authentication: backrest can be secured with a username and password.
* WebUI supports local and remote access (e.g. run on a NAS and access from your desktop)
* Multi-platform support (Linux, MacOS, Windows, FreeBSD, [Docker](https://hub.docker.com/r/garethgeorge/backrest))
* Import your existing restic repositories
* Cron scheduled backups and health operations (e.g. prune and forget)
* UI for browing and restoring files from snapshots
* Configurable backup notifications (e.g. Discord, Slack, Shoutrrr, Gotify)
* Add shell command hooks to run before and after backup operations.
* Compatible with rclone remotes
* Backup to any restic supported storage (e.g. S3, B2, Azure, GCS, local, SFTP, and all [rclone remotes](https://rclone.org/))
-----
# User Guide
[See the backrest wiki](https://github.com/garethgeorge/backrest/wiki).
[See the backrest docs](https://garethgeorge.github.io/backrest/introduction/getting-started).
# Installation
+1 -1
View File
@@ -8,7 +8,7 @@ export default defineAppConfig({
github: 'garethgeorge/backrest',
},
github: {
dir: 'docs',
dir: 'docs/content',
branch: 'main',
repo: 'backrest',
owner: 'garethgeorge',
+1 -2
View File
@@ -4,8 +4,7 @@ This section describes the operations that Backrest can be configured to perform
## Overview
Backrest executes commands by forking the [restic][https://restic.net] binary. Each Backrest version is validated against a specific version of restic. On startup Backrest searches for a versioned restic in it's data directory (typically `~/.local/share/backrest`), followed by `/bin/`. The restic binary must be named `restic-{VERSION}`. You can overriderestic command by setting `BACKREST_RESTIC_COMMAND` env variable when starting Backrest. Otherwise, if no binary is found Backrest will download and install a recent version of restic from [restic's github releases](https://github.com/restic/restic/releases/tag/v0.16.4). When downloading a restic binary, the download is verified by checking the sha256sum of the downloaded binary against the sha256sum provided by restic and signed by the restic maintainers GPG key.
Backrest executes commands by forking the [restic](https://restic.net) binary. Each Backrest version is validated against a specific version of restic. On startup Backrest searches for a versioned restic in it's data directory (typically `~/.local/share/backrest`), followed by `/bin/`. The restic binary must be named `restic-{VERSION}`. You can overriderestic command by setting `BACKREST_RESTIC_COMMAND` env variable when starting Backrest. Otherwise, if no binary is found Backrest will download and install a recent version of restic from [restic's github releases](https://github.com/restic/restic/releases/tag/v0.16.4). When downloading a restic binary, the download is verified by checking the sha256sum of the downloaded binary against the sha256sum provided by restic and signed by the restic maintainers GPG key.
When running restic commands, Backrest injects the environment variables configured in the repo into the environment of the restic process and it appends the flags configured in the repo to the command line arguments of the restic process. Logs are collected for each command. In the case of an error, Backrest captures the last ~500 bytes of output and displays this directly in the error message (the first and last 250 bytes are shown if the output is longer than 500 bytes). Logs of the command are typically also available by clicking \[View Logs\] next to an operation, these logs are truncated to 32KB (with the first and last 16KB shown if the log is longer than 32KB).
-7
View File
@@ -11,13 +11,6 @@ Available event types are
* `CONDITION_SNAPSHOT_END` the end of a backup operation (e.g. corresponds to `restic backup` completing). Note that Snapshot End will still be called if a backup failed.
* `CONDITION_SNAPSHOT_ERROR` an error occurred during a backup operation (e.g. `restic backup` returned a non-zero exit code OR invalid output).
Available notification services are
* Discord webhook
* Gotify
* Shoutrrr destinations https://containrrr.dev/shoutrrr/v0.8/
* Command (e.g. execute a shell script)
## Notification Services
| Service | Docs |