Distribute troubleshooting among relevant how-to guides.
This commit is contained in:
parent
19155607af
commit
0bce77a2ac
3 changed files with 39 additions and 36 deletions
36
README.md
36
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
|
Also, please check out the [borgmatic development
|
||||||
how-to](docs/how-to/develop-on-borgmatic.md) for info on cloning source code,
|
how-to](docs/how-to/develop-on-borgmatic.md) for info on cloning source code,
|
||||||
running tests, etc.
|
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.
|
|
||||||
|
|
|
@ -65,6 +65,32 @@ consistency:
|
||||||
- path/of/repository_to_check.borg
|
- 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
|
## Related documentation
|
||||||
|
|
||||||
* [Set up backups with borgmatic](../../docs/how-to/set-up-backups.md)
|
* [Set up backups with borgmatic](../../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.
|
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
|
## Related documentation
|
||||||
|
|
||||||
* [Make per-application backups](../../docs/how-to/make-per-application-backups.md)
|
* [Make per-application backups](../../docs/how-to/make-per-application-backups.md)
|
||||||
|
|
Loading…
Reference in a new issue