From 0bce77a2ac2d536bbf3809d316e363b5892bebb7 Mon Sep 17 00:00:00 2001 From: Dan Helfman Date: Mon, 4 Feb 2019 20:53:47 -0800 Subject: [PATCH] Distribute troubleshooting among relevant how-to guides. --- README.md | 36 --------------------- docs/how-to/deal-with-very-large-backups.md | 26 +++++++++++++++ docs/how-to/set-up-backups.md | 13 ++++++++ 3 files changed, 39 insertions(+), 36 deletions(-) diff --git a/README.md b/README.md index 42b2f8e..6407875 100644 --- a/README.md +++ b/README.md @@ -89,39 +89,3 @@ your thing. In general, contributions are very welcome. We don't bite! Also, please check out the [borgmatic development how-to](docs/how-to/develop-on-borgmatic.md) for info on cloning source code, running tests, etc. - - -## Troubleshooting - -### Broken pipe with remote repository - -When running borgmatic on a large remote repository, you may receive errors -like the following, particularly while "borg check" is validating backups for -consistency: - -```text - Write failed: Broken pipe - borg: Error: Connection closed by remote host -``` - -This error can be caused by an ssh timeout, which you can rectify by adding -the following to the `~/.ssh/config` file on the client: - -```text - Host * - ServerAliveInterval 120 -``` - -This should make the client keep the connection alive while validating -backups. - - -### libyaml compilation errors - -borgmatic depends on a Python YAML library (ruamel.yaml) that will optionally -use a C YAML library (libyaml) if present. But if it's not installed, then -when installing or upgrading borgmatic, you may see errors about compiling the -YAML library. If so, not to worry. borgmatic should install and function -correctly even without the C YAML library. And borgmatic won't be any faster -with the C library present, so you don't need to go out of your way to install -it. diff --git a/docs/how-to/deal-with-very-large-backups.md b/docs/how-to/deal-with-very-large-backups.md index dccc5bd..f820d03 100644 --- a/docs/how-to/deal-with-very-large-backups.md +++ b/docs/how-to/deal-with-very-large-backups.md @@ -65,6 +65,32 @@ consistency: - path/of/repository_to_check.borg ``` + +## Troubleshooting + +### Broken pipe with remote repository + +When running borgmatic on a large remote repository, you may receive errors +like the following, particularly while "borg check" is validating backups for +consistency: + +```text + Write failed: Broken pipe + borg: Error: Connection closed by remote host +``` + +This error can be caused by an ssh timeout, which you can rectify by adding +the following to the `~/.ssh/config` file on the client: + +```text + Host * + ServerAliveInterval 120 +``` + +This should make the client keep the connection alive while validating +backups. + + ## Related documentation * [Set up backups with borgmatic](../../docs/how-to/set-up-backups.md) diff --git a/docs/how-to/set-up-backups.md b/docs/how-to/set-up-backups.md index c1fd3c1..231609d 100644 --- a/docs/how-to/set-up-backups.md +++ b/docs/how-to/set-up-backups.md @@ -159,6 +159,19 @@ Feel free to modify the timer file based on how frequently you'd like borgmatic to run. +## Troubleshooting + +### libyaml compilation errors + +borgmatic depends on a Python YAML library (ruamel.yaml) that will optionally +use a C YAML library (libyaml) if present. But if it's not installed, then +when installing or upgrading borgmatic, you may see errors about compiling the +YAML library. If so, not to worry. borgmatic should install and function +correctly even without the C YAML library. And borgmatic won't be any faster +with the C library present, so you don't need to go out of your way to install +it. + + ## Related documentation * [Make per-application backups](../../docs/how-to/make-per-application-backups.md)