Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: correct minor spelling and grammar errors #479

Merged
merged 1 commit into from
Sep 18, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/content/2.docs/1.operations.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +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 its data directory (typically `~/.local/share/backrest`), followed by `/bin/`. The restic binary must be named `restic-{VERSION}`. You can override restic 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).

Expand All @@ -22,7 +22,7 @@ The backup flow is as follows

- Hook trigger: `CONDITION_SNAPSHOT_START`, if any hooks are configured for this event they will run.
- If any hook exits with a non-zero status, the hook's failure policy will be applied (e.g. cancelling or failing the backup operation).
- The `restic backup` command is run. The newly craeted snapshot is tagged with the ID of the plan creating it e.g. `plan:{PLAN_ID}`.
- The `restic backup` command is run. The newly created snapshot is tagged with the ID of the plan creating it e.g. `plan:{PLAN_ID}`.
- On backup completion
- The summary event is parsed from the backup and is stored in the operation's metadata. This includes: files added, files changed, files unmodified, total files processed, bytes added, bytes processed, and most importantly the snapshot ID.
- If an error occurred: hook trigger `CONDITION_SNAPSHOT_ERROR`, if any hooks are configured for this event they will run.
Expand Down