mirror
/
borg
mirror of https://github.com/borgbackup/borg.git
1
0
Fork 0
Code Issues Releases Wiki Activity
8,486 Commits 9 Branches 137 Tags 57 MiB
Commit Graph

40 Commits

Author SHA1 Message Date
Thalian 19aa9825a8 [DOCS] #4587 – Make Sphinx warnings break docs build 
general.rst and man_intro.rst both included usage_general.rst.inc, which resulted in three Sphinx warning "WARNING: duplicate label".
To prevent this we move all sections of usage_general into own include files and add a second usage_general file without the three labels.
 2020-03-16 19:22:59 +01:00
Thalian 07c89cd794
[DOCS] #4941 – FAQ Borg config dir (#5029) 
[DOCS] #4941 – How important is Borg config?

Add one FAQ with for $HOME/.config/borg, describing its content and how to take care of it.

Change "Default to" to "Defaults to".
Move TMPDIR to "Directories and files" section.
Add link to new FAQ for Borg config directory.
Add link to cache internals.
 2020-03-16 00:17:46 +01:00
DifficultDerek 85928fe6ae Update usage_general.rst.inc 
- Added "Will move with BORG_CONFIG_DIR variable unless specified." to BORG_SECURITY_DIR info.
- put BORG_SECURITY_DIR immediately below BORG_CONFIG_DIR (and moved BORG_CACHE_DIR up before them).
 2020-02-09 18:34:09 +01:00
finefoot 61b8234704 Add paragraph regarding cache security assumptions (#4900) 
docs: tell about borg cache security precautions
 2020-01-13 12:25:03 +01:00
Christian Paul 8be4007e1b Fix typo: degress -> degrees 2019-09-30 23:57:18 +02:00
Ioannis Cherouvim 76a3dca3db Typo fix (neccessary -> necessary). 2019-09-21 08:59:50 +03:00
Thomas Waldmann b43d3bb7fa new BORG_WORKAROUNDS mechanism, basesyncfile, fixes #4710 
remove WSL autodetection. if WSL still has this problem, you need to
set BORG_WORKAROUNDS=basesyncfile in the borg process environment to
work around it.

(cherry picked from commit beb948fc71)
 2019-08-27 19:37:40 +05:30
Endareth 3445d4cca0 Updated doc to cover use of temp directory on remote (#4545) 
docs about remote temp directory usage

Updated doc to cover use of temp directory on remote, in particular how to handle changing the directory used for systems such as QNAP with tiny default /tmp directories.

fixup by tw: do not mention specific brands, specific amounts

this is not QNAP specific, but may happen as well on other limited
systems. the amount of tmp files can also vary widely.
 2019-08-10 00:08:10 +02:00
Sitaram Chamarty 884798c3cb add a sample logging.conf in docs/misc (#4380) 
add a sample logging.conf in docs/misc

(and point to it in the man page)
 2019-03-17 15:05:04 +01:00
Thomas Waldmann 39300d1fd0 docs: fix markup 2019-03-11 00:16:12 +01:00
Manuel Riel 9ab0a095ab Add --rsh command line option to complement BORG_RSH env var. Fixes #… (#4290) 
Add --rsh command line option to complement BORG_RSH env var. Fixes #1701
 2019-01-31 13:54:17 +01:00
Manu d13ddb224a Update BORG_PASSCOMMAND example and clarify variable expansion. Fixes #4249 2019-01-30 10:12:47 +08:00
Łukasz Stelmach 548355125e read a passphrase from a file descriptor 
Read a passpharase from a file descriptor specified in the
BORG_PASSPHRASE_FD environment variable.
 2018-09-21 09:11:39 +02:00
newtonne 11a2f1f684 Remove row/column-spanning from docs source, fixes #4000 
Sphinx doesn't support row or column-spanning, which caused the content
of the additional features table to be incorrect. To fix this, we now
define the content of each cell explicitly.

This change also fixes #3990.
 2018-08-09 20:38:46 +01:00
Thomas Waldmann 90348c1de9 add BORG_HOST_ID, fixes #3985 2018-08-04 15:01:48 +02:00
lumbric bbd1533c99 docs: add link to tempfile module 
Linking tempfile docs helps to figure out, which default value might be
used, if TMPDIR is not set.
 2018-06-25 20:32:44 +02: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
André-Patrick Bubel 1ba0e85621
docs: describe what BORG_LIBZSTD_PREFIX does 2018-04-16 19:12:01 +02:00
Thomas Waldmann 99be106bc8 docs: improve logging docs, fixes #3549 2018-03-09 20:44:20 +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
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
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 a107233f75 docs: document birthtime support on platforms supporting it 
stat.st_birthtime, MacOS and (some?) BSDs.
 2017-11-25 19:51:33 +01:00
Thomas Waldmann e3cb7c3c32 docs: document good and problematic option placements, see #3356 2017-11-25 19:46:48 +01:00
narendravardi 764a62f42c Added documentation for BORG_CONFIG_DIR 2017-10-29 21:52:33 +05:30
Thomas Waldmann a5c6a50ebe increase Python minimum requirement to 3.5.0 
also:
- drop testing on 3.4
- add some TODO for the docs and vagrant machines
 2017-07-29 20:55:04 +02:00
Marian Beermann b3e0dd3761 docs: file system requirements, update segs per dir 2017-07-23 16:03:45 +02:00
Marian Beermann cc93cbb202 docs: usage; remove strange blurb about tested platforms 2017-07-21 12:32:30 +02:00
Marian Beermann 735339c209 docs: streamline installation: platforms table 2017-07-21 12:32:30 +02:00
Marian Beermann 3d5a8016e6 docs: streamline installation: file systems 2017-07-21 12:32:30 +02:00
Marian Beermann 0288fff6b7 docs: explain formatting 2017-06-17 14:29:56 +02:00
Marian Beermann 5aa865c8d8 docs: double backticks for --options 2017-06-17 12:27:53 +02:00
Andrea Gelmini e4247cc0d2 Fix typos 2017-06-09 16:49:30 +02:00
TuXicc 578b76af3a Added BORG_PASSCOMMAND environment variable (#2573) 2017-05-31 19:25:21 +02:00
Marian Beermann e036ebc340 docs: installation: pre-install considerations, fix crossrefs 
posix_fadvise -> only used when available; not part of the filesystem.
sync -> fsync
 2017-04-28 10:40:21 +02:00
Marian Beermann bb6b4fde93 BORG_HOSTNAME_IS_UNIQUE=yes by default. 2017-04-01 21:28:41 +02:00
Marian Beermann e98b5b20df yes(): handle JSON output 2017-03-09 21:36:37 +01:00
Thomas Waldmann d5707929fd [docs] improve remote-path description 
(ported bebehei's 1.0-maint change to master)
 2017-03-01 01:53:23 +01:00
Thomas Waldmann 4e08bbcf0b document BORG_HOSTNAME_IS_UNIQUE, fixes #2087 2017-02-19 05:12:00 +01:00
Marian Beermann 96fa1e8414 docs: define "ours" merge strategy for auto-generated files 2017-02-12 18:51:40 +01:00
Renamed from docs/usage/general.rst.inc (Browse further)