Skip to content

Commit

Permalink
Complete documentation on append-only remote repos (#5519)
Browse files Browse the repository at this point in the history
improve docs/FAQ about append-only remote repos, fixes #5497
  • Loading branch information
Gu1nness authored Dec 6, 2020
1 parent fd62f9b commit 810d823
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 0 deletions.
10 changes: 10 additions & 0 deletions docs/deployment/hosting-repositories.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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) <http://www.openbsd.org/cgi-bin/man.cgi/OpenBSD-current/man8/sshd.8>`_
man page for more details on SSH options.
8 changes: 8 additions & 0 deletions docs/faq.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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`
----------------------------------------------

Expand Down

0 comments on commit 810d823

Please sign in to comment.