From 810d82395de0db0bc0ca53d76602b8baacc582be Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nehalenni=C3=A6=20Oudin?= Date: Sun, 6 Dec 2020 15:53:39 +0100 Subject: [PATCH] Complete documentation on append-only remote repos (#5519) improve docs/FAQ about append-only remote repos, fixes #5497 --- docs/deployment/hosting-repositories.rst | 10 ++++++++++ docs/faq.rst | 8 ++++++++ 2 files changed, 18 insertions(+) diff --git a/docs/deployment/hosting-repositories.rst b/docs/deployment/hosting-repositories.rst index 66d3b7357..b9d7d35f7 100644 --- a/docs/deployment/hosting-repositories.rst +++ b/docs/deployment/hosting-repositories.rst @@ -70,5 +70,15 @@ support storage quotas. Refer to :ref:`internals_storage_quota` for more details on storage quotas. +**Specificities: Append-only repositories** + +Running ``borg init`` via a ``borg serve --append-only`` server will **not** +create a repository that is configured to be append-only by its repository +config. + +But, ``--append-only`` arguments in ``authorized_keys`` will override the +repository config, therefore append-only mode can be enabled on a key by key +basis. + Refer to the `sshd(8) `_ man page for more details on SSH options. diff --git a/docs/faq.rst b/docs/faq.rst index dc71964a4..30cb33738 100644 --- a/docs/faq.rst +++ b/docs/faq.rst @@ -183,6 +183,14 @@ This is not a problem anymore. For more details, see :ref:`checkpoints_parts`. +How can I switch append-only mode on and off? +----------------------------------------------------------------------------------------------------------------------------------- + +You could do that (via borg config REPO append_only 0/1), but using different +ssh keys and different entries in ``authorized_keys`` is much easier and also +maybe has less potential of things going wrong somehow. + + My machine goes to sleep causing `Broken pipe` ----------------------------------------------