Commit Graph

1134 Commits

Author SHA1 Message Date
Saurav Sachidanand b3c1104760 Update docs on deleting multiple archives 2018-05-27 09:38:23 +05:30
TW 485368d50d
docs: fix and deduplicate encryption quickstart docs (#3776)
docs: fix and deduplicate encryption quickstart docs

just refer to "borg init" docs rather than duplicating it in quickstart.

also: s/archive/repository/
2018-05-23 14:17:01 -07:00
Thomas Waldmann d94bd22740 BORG_SHOW_SYSINFO=no to hide system information from exceptions
Can be used:
- in case of troubles with the sysinfo code
- by borg backup providers who do not want to show system information

(cherry picked from commit 64aaec6628)
2018-05-18 18:49:56 +02:00
infectormp 8f6be74993 Add note from borg with-lock about copy repo (#3749)
docs: Improve FAQ about copying a repo
2018-04-19 15:34:11 +02:00
infectormp 60f9849336 docs: Improve borg with-lock (#3780)
docs: improve borg with-lock, link to FAQ
2018-04-19 15:29:47 +02:00
André-Patrick Bubel 1ba0e85621
docs: describe what BORG_LIBZSTD_PREFIX does 2018-04-16 19:12:01 +02:00
TW b2c141899b
Merge pull request #3710 from ThomasWaldmann/docs-security-fingerprinting
security: describe chunk size / proximity issue, see #331
2018-03-24 21:50:17 +01:00
TW b6b8e1bb16
Merge pull request #3683 from milkey-mouse/repo-archive-quickstart
Add quickstart introduction to repositories & archives (fixes #3620)
2018-03-24 21:31:27 +01:00
Milkey Mouse d41c9296c0
fixup! Add quickstart introduction to repositories & archives (fixes #3620) 2018-03-24 12:05:47 -07:00
Thomas Waldmann 8ac272f35f security: describe chunk size / proximity issue, see #3687 2018-03-23 17:54:02 +01:00
TW 201c62430a
Merge pull request #3675 from ThomasWaldmann/crypto-compression-docs
security docs: add about combining compression and encryption
2018-03-17 19:46:42 +01:00
TW c206f8b403
Merge pull request #3677 from ThomasWaldmann/docs-avoid-permission-mixup
quickstart: add note about permissions, borg@localhost, fixes #3452
2018-03-12 15:18:16 +01:00
TW 6b3191a285
Merge pull request #3678 from ThomasWaldmann/docs-log
docs: improve logging docs, fixes #3549
2018-03-12 15:16:47 +01:00
TW e6978fa2ea
Merge pull request #3680 from ThomasWaldmann/transaction-rollback-docs
docs: extend append-only repo rollback docs, fixes #3579
2018-03-12 15:13:53 +01:00
Milkey Mouse 09beb64f34
Add quickstart introduction to repositories & archives (fixes #3620) 2018-03-10 17:19:46 -08:00
Thomas Waldmann 451b22ee51 docs: extend append-only repo rollback docs, fixes #3579 2018-03-09 23:27:31 +01:00
Thomas Waldmann 99be106bc8 docs: improve logging docs, fixes #3549 2018-03-09 20:44:20 +01:00
Thomas Waldmann 7bc2138dcb quickstart: add note about permissions, borg@localhost, fixes #3452 2018-03-09 20:01:38 +01:00
TW 1473ea708c
Merge pull request #3526 from borgbackup/enkore-patch-1
sec docs: explicitly note what happens OUTSIDE the attack model
2018-03-09 18:49:32 +01:00
Thomas Waldmann be8913a93c security docs: add about combining compression and encryption 2018-03-09 18:02:57 +01:00
Thomas Schwinge 2458035057 Mark up Unicode string
Running Sphinx v1.4.8
    WARNING: the config value 'copyright' is set to a string with non-ASCII characters; this can lead to Unicode errors occurring. Please use Unicode strings, e.g. u'Content'.
    [...]
    Encoding error:
    'ascii' codec can't decode byte 0xc3 in position 23: ordinal not in range(128)
2018-03-08 11:37:45 +01:00
Josh Holland 9f2f4132ec
Improve formatting of GPG output in documentation 2018-03-05 13:21:20 +00:00
Michael Gajda 74a3058abc Add docs on how to verify a signed release
Short howto on using gpg to verify a signed binary release.
Fixes #3634
2018-03-02 21:40:42 +01:00
Jesus Fernandez Manzano 3a0ae9c7f3
[Docs] Update quickstart.rst to fix typo 2018-02-26 10:58:31 +01:00
TW 24b0bcb461
Merge pull request #3589 from Gu1nness/docs
A few documentation fixes for Documentation issue 19
2018-02-10 11:31:19 +01:00
Rémi Oudin 88972d7d81 Better formatting of CPU usage documentation
This is now displayed as a list, with bold fonts for each bullet.
Refers https://github.com/borgbackup/borg/issues/3554
2018-02-03 17:34:45 +01:00
Alexander 'Leo' Bergolth 74c10e4643 add chunker_params to archive info (at least to json output) 2018-01-25 21:02:39 +01:00
enkore 674ce72fda sec docs: explicitly note what happens OUTSIDE the attack model 2018-01-10 15:30:12 +01:00
TW 4b98393542
Merge pull request #3520 from pngwjpgh/doc/chunk-seed
Chunk seed is generated per /repository/
2018-01-10 07:26:26 +01:00
Gregor Kleen 1820e22c02 Chunk seed is generated per /repository/ 2018-01-09 18:17:46 +01:00
Gianfranco Costamagna 0980d6ac43 fixup allows one to, with suggestions from Dan Christensen 2018-01-03 15:54:52 +01:00
Gianfranco Costamagna 111a19f7fa fix typo: allows to -> allows one to 2018-01-03 11:42:38 +01:00
Gianfranco Costamagna 1a74326b5a borg: fix typo: explicitely -> explicitly 2018-01-03 11:42:30 +01:00
Abogical 937736ceb9 Happy new year! 2018-01-02 11:10:07 +02:00
Thomas Waldmann c5a339384e added BORG_BASE_DIR, s/get_home_dir/get_base_dir/g, docs, fixes #3338
also: sorted env var docs by level
2017-12-23 01:42:18 +01:00
Josh Holland 95a05dbbf1
docs: Fix missing apostrophe 2017-12-22 21:44:12 +00:00
Thomas Waldmann 2588e50f0b readme / docs: mention zstd 2017-12-18 22:55:00 +01:00
Thomas Waldmann 061321b668 update requirements and install docs about bundled lz4 and zstd 2017-12-18 22:55:00 +01:00
Thomas Waldmann fe48caf853 fix lz4 deprecation warning, require lz4 >= 1.7.0 (r129)
as we bundle lz4 1.8.0 now, platform not having a recent liblz4 can
now just use the bundled code.
2017-12-18 00:53:26 +01:00
Thomas Waldmann 9b6924d27f rename BORG_LZ4_PREFIX env var to BORG_LIBLZ4_PREFIX
consistency:
we also have BORG_LIBB2_PREFIX and BORG_LIBZSTD_PREFIX.
2017-12-18 00:53:26 +01:00
Thomas Waldmann c8b2820225 bundle lz4 1.8.0 src code, license 2017-12-15 06:33:04 +01:00
Thomas Waldmann dc883f62ae bundle zstd 1.3.2 source code
only .c and .h files + license
2017-12-15 00:29:26 +01:00
Thomas Waldmann d81ea0321d git add docs/man/borg-config.1 2017-12-13 04:40:20 +01:00
Gregor Kleen 85fb38e2f3 Add placeholder for fqdn in reverse notation 2017-12-11 23:00:38 +01:00
Thomas Waldmann ce92960c63 add auto-generated docs for borg config
also: move a bit upwards in the use docs
(cherry picked from commit 278ed640e9)
2017-12-09 13:43:36 +01:00
Thomas Waldmann 209bf2dc24 move 3rd party docs/license file from package dir to docs/3rd_party
setup.py excludes all .c .h .pyx files from installation, but such
docs / license files would still be copied to the target directory
if they are inside the python "borg" package dir.

(cherry picked from commit 831a06a07d)
2017-12-02 18:13:11 +01:00
Thomas Waldmann 63bdae8314 docs: fix broken links
(cherry picked from commit c7994b598b)
2017-11-27 00:00:46 +01:00
Thomas Waldmann c2521a7759 link to the homepage for support/service
otherwise people ONLY reading the docs (and not coming from the
homepage) will miss these options.

(cherry picked from commit 7438cb2ef4)
2017-11-26 23:37:04 +01:00
Michael Rupert 6dd54f93ce fixed support links (#3379)
fixed support links
2017-11-26 05:10:22 +01:00
Thomas Waldmann 0eaec60384 docs: give examples for borg mount exclusion options 2017-11-25 20:18:59 +01:00