mirror of https://github.com/borgbackup/borg.git
ran setup.py build_usage
This commit is contained in:
parent
1845074b2e
commit
e32503b84c
|
@ -73,8 +73,12 @@ Description
|
||||||
~~~~~~~~~~~
|
~~~~~~~~~~~
|
||||||
|
|
||||||
This command creates a backup archive containing all files found while recursively
|
This command creates a backup archive containing all files found while recursively
|
||||||
traversing all paths specified. The archive will consume almost no disk space for
|
traversing all paths specified. When giving '-' as path, borg will read data
|
||||||
files or parts of files that have already been stored in other archives.
|
from standard input and create a file 'stdin' in the created archive from that
|
||||||
|
data.
|
||||||
|
|
||||||
|
The archive will consume almost no disk space for files or parts of files that
|
||||||
|
have already been stored in other archives.
|
||||||
|
|
||||||
The archive name needs to be unique. It must not end in '.checkpoint' or
|
The archive name needs to be unique. It must not end in '.checkpoint' or
|
||||||
'.checkpoint.N' (with N being a number), because these names are used for
|
'.checkpoint.N' (with N being a number), because these names are used for
|
||||||
|
|
|
@ -14,7 +14,7 @@ positional arguments
|
||||||
|
|
||||||
optional arguments
|
optional arguments
|
||||||
``-e``, ``--encryption``
|
``-e``, ``--encryption``
|
||||||
| select encryption key mode (default: "repokey")
|
| select encryption key mode (default: "None")
|
||||||
``-a``, ``--append-only``
|
``-a``, ``--append-only``
|
||||||
| create an append-only mode repository
|
| create an append-only mode repository
|
||||||
|
|
||||||
|
@ -27,21 +27,22 @@ Description
|
||||||
This command initializes an empty repository. A repository is a filesystem
|
This command initializes an empty repository. A repository is a filesystem
|
||||||
directory containing the deduplicated data from zero or more archives.
|
directory containing the deduplicated data from zero or more archives.
|
||||||
|
|
||||||
Encryption can be enabled at repository init time (the default).
|
Encryption can be enabled at repository init time.
|
||||||
|
|
||||||
It is not recommended to disable encryption. Repository encryption protects you
|
It is not recommended to work without encryption. Repository encryption protects
|
||||||
e.g. against the case that an attacker has access to your backup repository.
|
you e.g. against the case that an attacker has access to your backup repository.
|
||||||
|
|
||||||
But be careful with the key / the passphrase:
|
But be careful with the key / the passphrase:
|
||||||
|
|
||||||
If you want "passphrase-only" security, use the repokey mode. The key will
|
If you want "passphrase-only" security, use one of the repokey modes. The
|
||||||
be stored inside the repository (in its "config" file). In above mentioned
|
key will be stored inside the repository (in its "config" file). In above
|
||||||
attack scenario, the attacker will have the key (but not the passphrase).
|
mentioned attack scenario, the attacker will have the key (but not the
|
||||||
|
passphrase).
|
||||||
|
|
||||||
If you want "passphrase and having-the-key" security, use the keyfile mode.
|
If you want "passphrase and having-the-key" security, use one of the keyfile
|
||||||
The key will be stored in your home directory (in .config/borg/keys). In
|
modes. The key will be stored in your home directory (in .config/borg/keys).
|
||||||
the attack scenario, the attacker who has just access to your repo won't have
|
In the attack scenario, the attacker who has just access to your repo won't
|
||||||
the key (and also not the passphrase).
|
have the key (and also not the passphrase).
|
||||||
|
|
||||||
Make a backup copy of the key file (keyfile mode) or repo config file
|
Make a backup copy of the key file (keyfile mode) or repo config file
|
||||||
(repokey mode) and keep it at a safe place, so you still have the key in
|
(repokey mode) and keep it at a safe place, so you still have the key in
|
||||||
|
@ -72,12 +73,27 @@ Encryption modes
|
||||||
repokey and keyfile use AES-CTR-256 for encryption and HMAC-SHA256 for
|
repokey and keyfile use AES-CTR-256 for encryption and HMAC-SHA256 for
|
||||||
authentication in an encrypt-then-MAC (EtM) construction. The chunk ID hash
|
authentication in an encrypt-then-MAC (EtM) construction. The chunk ID hash
|
||||||
is HMAC-SHA256 as well (with a separate key).
|
is HMAC-SHA256 as well (with a separate key).
|
||||||
|
These modes are compatible with borg 1.0.x.
|
||||||
|
|
||||||
repokey-blake2 and keyfile-blake2 use the same authenticated encryption, but
|
repokey-blake2 and keyfile-blake2 are also authenticated encryption modes,
|
||||||
use a keyed BLAKE2b-256 hash for the chunk ID hash.
|
but use BLAKE2b-256 instead of HMAC-SHA256 for authentication. The chunk ID
|
||||||
|
hash is a keyed BLAKE2b-256 hash.
|
||||||
|
These modes are new and not compatible with borg 1.0.x.
|
||||||
|
|
||||||
"authenticated" mode uses no encryption, but authenticates repository contents
|
"authenticated" mode uses no encryption, but authenticates repository contents
|
||||||
through the same keyed BLAKE2b-256 hash as the other blake2 modes.
|
through the same keyed BLAKE2b-256 hash as the other blake2 modes (it uses it
|
||||||
The key is stored like repokey.
|
as chunk ID hash). The key is stored like repokey.
|
||||||
|
This mode is new and not compatible with borg 1.0.x.
|
||||||
|
|
||||||
|
"none" mode uses no encryption and no authentication. It uses sha256 as chunk
|
||||||
|
ID hash. Not recommended, rather consider using an authenticated or
|
||||||
|
authenticated/encrypted mode.
|
||||||
|
This mode is compatible with borg 1.0.x.
|
||||||
|
|
||||||
Hardware acceleration will be used automatically.
|
Hardware acceleration will be used automatically.
|
||||||
|
|
||||||
|
On modern Intel/AMD CPUs (except very cheap ones), AES is usually hw
|
||||||
|
accelerated. BLAKE2b is faster than sha256 on Intel/AMD 64bit CPUs.
|
||||||
|
|
||||||
|
On modern ARM CPUs, NEON provides hw acceleration for sha256 making it faster
|
||||||
|
than BLAKE2b-256 there.
|
||||||
|
|
|
@ -17,6 +17,8 @@ optional arguments
|
||||||
| do not change repository
|
| do not change repository
|
||||||
``--force``
|
``--force``
|
||||||
| force pruning of corrupted archives
|
| force pruning of corrupted archives
|
||||||
|
``-p``, ``--progress``
|
||||||
|
| show progress display while deleting archives
|
||||||
``-s``, ``--stats``
|
``-s``, ``--stats``
|
||||||
| print statistics for the deleted archive
|
| print statistics for the deleted archive
|
||||||
``--list``
|
``--list``
|
||||||
|
|
|
@ -36,7 +36,7 @@ Description
|
||||||
Upgrade an existing Borg repository.
|
Upgrade an existing Borg repository.
|
||||||
|
|
||||||
Borg 1.x.y upgrades
|
Borg 1.x.y upgrades
|
||||||
-------------------
|
+++++++++++++++++++
|
||||||
|
|
||||||
Use ``borg upgrade --tam REPO`` to require manifest authentication
|
Use ``borg upgrade --tam REPO`` to require manifest authentication
|
||||||
introduced with Borg 1.0.9 to address security issues. This means
|
introduced with Borg 1.0.9 to address security issues. This means
|
||||||
|
@ -58,7 +58,7 @@ https://borgbackup.readthedocs.io/en/stable/changes.html#pre-1-0-9-manifest-spoo
|
||||||
for details.
|
for details.
|
||||||
|
|
||||||
Attic and Borg 0.xx to Borg 1.x
|
Attic and Borg 0.xx to Borg 1.x
|
||||||
-------------------------------
|
+++++++++++++++++++++++++++++++
|
||||||
|
|
||||||
This currently supports converting an Attic repository to Borg and also
|
This currently supports converting an Attic repository to Borg and also
|
||||||
helps with converting Borg 0.xx to 1.0.
|
helps with converting Borg 0.xx to 1.0.
|
||||||
|
|
Loading…
Reference in New Issue