From 99a4c1d53d4499f663aff820fadd7799d3e9b408 Mon Sep 17 00:00:00 2001 From: Guinness Date: Mon, 23 Nov 2020 15:16:32 +0100 Subject: [PATCH 1/4] Complete documentation on append-only remote repos I have updated both the FAQ and the https://github.com/borgbackup/borg/blob/master/docs/deployment/hosting-repositories.rst files. --- docs/deployment/hosting-repositories.rst | 9 +++++++++ docs/faq.rst | 8 ++++++++ 2 files changed, 17 insertions(+) diff --git a/docs/deployment/hosting-repositories.rst b/docs/deployment/hosting-repositories.rst index 66d3b73578..4bd850d803 100644 --- a/docs/deployment/hosting-repositories.rst +++ b/docs/deployment/hosting-repositories.rst @@ -68,6 +68,15 @@ can be filled to the specified quota. If storage quotas are used, ensure that all deployed Borg releases support storage quotas. +**Append-only repositorues** + +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 :ref:`internals_storage_quota` for more details on storage quotas. Refer to the `sshd(8) `_ diff --git a/docs/faq.rst b/docs/faq.rst index dc71964a41..cd29c90bb3 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`. +Do we have to run borg config "backup" append_only 0 and borg config "backup" append_only 1 on the sever to switch append only mode +----------------------------------------------------------------------------------------------------------------------------------- + +You could do that, but using different ssh keys and different entries in +authorized_keys is much easier and also maybe has less potential of thing going +wrong somehow. + + My machine goes to sleep causing `Broken pipe` ---------------------------------------------- From d7586dbfb3d04a7ac4dcf801d9d4de2fdaaf81fa Mon Sep 17 00:00:00 2001 From: Guinness Date: Tue, 24 Nov 2020 14:56:06 +0100 Subject: [PATCH 2/4] Fix some typos and more accurate documentation --- docs/deployment/hosting-repositories.rst | 13 +++++++------ docs/faq.rst | 6 +++--- 2 files changed, 10 insertions(+), 9 deletions(-) diff --git a/docs/deployment/hosting-repositories.rst b/docs/deployment/hosting-repositories.rst index 4bd850d803..8702ff1f6d 100644 --- a/docs/deployment/hosting-repositories.rst +++ b/docs/deployment/hosting-repositories.rst @@ -68,16 +68,17 @@ can be filled to the specified quota. If storage quotas are used, ensure that all deployed Borg releases support storage quotas. -**Append-only repositorues** +Refer to :ref:`internals_storage_quota` for more details on storage quotas. + +**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. +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 +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 :ref:`internals_storage_quota` for more details on storage quotas. - Refer to the `sshd(8) `_ man page for more details on SSH options. diff --git a/docs/faq.rst b/docs/faq.rst index cd29c90bb3..7004b6b2e1 100644 --- a/docs/faq.rst +++ b/docs/faq.rst @@ -183,12 +183,12 @@ This is not a problem anymore. For more details, see :ref:`checkpoints_parts`. -Do we have to run borg config "backup" append_only 0 and borg config "backup" append_only 1 on the sever to switch append only mode +How can I switch append-only mode on and off? ----------------------------------------------------------------------------------------------------------------------------------- You could do that, but using different ssh keys and different entries in -authorized_keys is much easier and also maybe has less potential of thing going -wrong somehow. +``authorized_keys`` is much easier and also maybe has less potential of thing +going wrong somehow. My machine goes to sleep causing `Broken pipe` From d03198230041a832388cd0266ac9386a7c914f6a Mon Sep 17 00:00:00 2001 From: Guinness Date: Sat, 28 Nov 2020 21:36:14 +0100 Subject: [PATCH 3/4] Fix small corrections --- docs/faq.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/faq.rst b/docs/faq.rst index 7004b6b2e1..30cb33738c 100644 --- a/docs/faq.rst +++ b/docs/faq.rst @@ -186,9 +186,9 @@ For more details, see :ref:`checkpoints_parts`. How can I switch append-only mode on and off? ----------------------------------------------------------------------------------------------------------------------------------- -You could do that, but using different ssh keys and different entries in -``authorized_keys`` is much easier and also maybe has less potential of thing -going wrong somehow. +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` From c42a3b9d1552ef42975850b6db44612b96d5d524 Mon Sep 17 00:00:00 2001 From: Guinness Date: Thu, 3 Dec 2020 11:56:49 +0100 Subject: [PATCH 4/4] Specify that append-only repo doc is a specificity --- docs/deployment/hosting-repositories.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/deployment/hosting-repositories.rst b/docs/deployment/hosting-repositories.rst index 8702ff1f6d..b9d7d35f71 100644 --- a/docs/deployment/hosting-repositories.rst +++ b/docs/deployment/hosting-repositories.rst @@ -70,7 +70,7 @@ support storage quotas. Refer to :ref:`internals_storage_quota` for more details on storage quotas. -**Append-only repositories** +**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