diff --git a/NEWS b/NEWS index 93d33a5d..0d2cb0ee 100644 --- a/NEWS +++ b/NEWS @@ -1,3 +1,7 @@ +0.0.4-dev + + * Added a troubleshooting section with steps to deal with broken pipes. + 0.0.3 * After pruning, run attic's consistency checks on all archives. diff --git a/README.md b/README.md index 99b8a561..d289369a 100644 --- a/README.md +++ b/README.md @@ -94,6 +94,27 @@ To actually run tests, run: nosetests --detailed-errors +## Troubleshooting + +### Broken pipe with remote repository + +When running atticmatic on a large remote repository, you may receive errors +like the following, particularly while "attic check" is valiating backups for +consistency: + + Write failed: Broken pipe + attic: 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: + + Host * + ServerAliveInterval 120 + +This should make the client keep the connection alive while validating +backups. + + ## Feedback Questions? Comments? Got a patch? Contact .