mirror of
https://github.com/borgbackup/borg.git
synced 2026-10-12 02:11:36 +00:00
misc docs updates
This commit is contained in:
+15
-12
@@ -310,12 +310,22 @@ Important notes:
|
||||
|
||||
- When using ``--`` to give options to py.test, you MUST also give ``borg.testsuite[.module]``.
|
||||
|
||||
Running pytest directly without tox:
|
||||
|
||||
::
|
||||
|
||||
# run the tests, with parallelism, skipping remote tests
|
||||
pytest -v -rs --benchmark-skip -n auto -k "not remote"
|
||||
|
||||
# run the tests, skipping remote tests, only running repository test
|
||||
pytest -v -rs --benchmark-skip -k "not remote and repository"
|
||||
|
||||
Running the tests (using the pypi package)
|
||||
------------------------------------------
|
||||
|
||||
Since borg 1.4, it is also possible to run the tests without a development
|
||||
environment, using the borgbackup dist package (downloaded from pypi.org or
|
||||
github releases page):
|
||||
It is also possible to run the tests without a development environment, using
|
||||
the borgbackup dist package (downloaded from pypi.org or github releases page):
|
||||
|
||||
::
|
||||
|
||||
# optional: create and use a virtual env:
|
||||
@@ -453,19 +463,12 @@ Creating standalone binaries
|
||||
----------------------------
|
||||
|
||||
Make sure you have everything built and installed (including fuse stuff).
|
||||
When using the Vagrant VMs, pyinstaller will already be installed.
|
||||
|
||||
With virtual env activated::
|
||||
|
||||
pip install pyinstaller # or git checkout master
|
||||
pyinstaller -F -n borg-PLATFORM borg/__main__.py
|
||||
for file in dist/borg-*; do gpg --armor --detach-sign $file; done
|
||||
scripts/build-borg-using-pyinstaller.sh
|
||||
scripts/build-borg-using-nuitka.sh
|
||||
|
||||
If you encounter issues, see also our `Vagrantfile` for details.
|
||||
|
||||
.. note:: Standalone binaries built with pyinstaller are supposed to
|
||||
work on same OS, same architecture (x86 32bit, amd64 64bit)
|
||||
without external dependencies.
|
||||
|
||||
.. _releasing:
|
||||
|
||||
|
||||
+2
-2
@@ -35,8 +35,8 @@ hash table of all chunks that already exist.
|
||||
The "key" object provides both compression and authenticated
|
||||
encryption used by the data access layer. The "key" object represents
|
||||
the sole trust boundary in Borg.
|
||||
The lowest layer is the repository, either accessed directly
|
||||
(Repository) or remotely (RemoteRepository).
|
||||
The lowest layer is the repository accessed via class Repository.
|
||||
Repository uses ``borgstore`` internally.
|
||||
|
||||
.. toctree::
|
||||
:caption: Internals contents
|
||||
|
||||
@@ -174,24 +174,21 @@ Now, let's see how to restore some LVs from such a backup.
|
||||
Separate compaction
|
||||
~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Borg does not auto-compact the segment files in the repository at commit time
|
||||
(at the end of each repository-writing command) any more (since borg 1.2.0).
|
||||
Borg does not automatically compact the files in the repository when doing
|
||||
borg operations.
|
||||
|
||||
This has some notable consequences:
|
||||
|
||||
- repository space is not freed immediately when deleting / pruning archives
|
||||
- commands finish quicker
|
||||
- repository is more robust and might be easier to recover after damages (as
|
||||
it contains data in a more sequential manner, historic manifests, multiple
|
||||
commits - until you run ``borg compact``)
|
||||
- commands finish quicker, less I/O
|
||||
- it is possible to undelete deleted archives as long as no compaction has been
|
||||
invoked.
|
||||
- user can choose when to run compaction (it should be done regularly, but not
|
||||
necessarily after each single borg command)
|
||||
- user can choose from where to invoke ``borg compact`` to do the compaction
|
||||
(from client or from server, it does not need a key)
|
||||
- less repo sync data traffic in case you create a copy of your repository by
|
||||
using a sync tool (like rsync, rclone, ...)
|
||||
|
||||
You can manually run compaction by invoking the ``borg compact`` command.
|
||||
You can run compaction by invoking the ``borg compact`` command.
|
||||
|
||||
SSH batch mode
|
||||
~~~~~~~~~~~~~~
|
||||
|
||||
@@ -41,12 +41,6 @@ locations like ``/etc/environment`` or in the forced command itself (example bel
|
||||
This automatically blocks potentially dangerous SSH features, even when
|
||||
they are added in a future update. Thus, this option should be preferred.
|
||||
|
||||
If you are using OpenSSH server < 7.2, however, you must explicitly
|
||||
specify the SSH features to restrict and cannot simply use the ``restrict`` option, as it
|
||||
was introduced in v7.2. We recommend using
|
||||
``no-port-forwarding,no-X11-forwarding,no-pty,no-agent-forwarding,no-user-rc``
|
||||
in this case.
|
||||
|
||||
Details about sshd usage: `sshd(8) <https://www.openbsd.org/cgi-bin/man.cgi/OpenBSD-current/man8/sshd.8>`_
|
||||
|
||||
.. _ssh_configuration:
|
||||
|
||||
Reference in New Issue
Block a user