Added a troubleshooting section with steps to deal with broken pipes.

2026-07-30 13:23:01 +02:00 · 2015-02-28 11:03:22 -08:00
parent 89703111d0
commit b755d09b0a
2 changed files with 25 additions and 0 deletions
@@ -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.
@@ -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 <mailto:witten@torsion.org>.