Skip to content

Complete documentation on append-only remote repos #5519

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ThomasWaldmann merged 4 commits into from
Dec 6, 2020
Merged

Complete documentation on append-only remote repos #5519

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
99a4c1d
Complete documentation on append-only remote repos
Gu1nness Nov 23, 2020
d7586db
Fix some typos and more accurate documentation
Gu1nness Nov 24, 2020
d031982
Fix small corrections
Gu1nness Nov 28, 2020
c42a3b9
Specify that append-only repo doc is a specificity
Gu1nness Dec 3, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions docs/deployment/hosting-repositories.rst
View file
Open in desktop
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
View file
Open in desktop
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