Commit Graph

1238 Commits

Author SHA1 Message Date
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
Thalian 053b0db009 Add FAQ describing difference between a local repo vs. repo on a server.
Taken from a Q/A on the mailing list.
2019-12-23 13:13:08 +01:00
TW 66d86b6280
Merge pull request #4789 from ThomasWaldmann/regen-docs-man
ran python setup.py build_man
2019-11-02 13:53:58 +01:00
Thalian a89539439e #1552 Deployment Pull Backup (#4804)
docs: add a pull backup / push restore how-to, fixes #1552
2019-11-02 13:48:32 +01:00
Thomas Waldmann 451c4dd5de build_man 2019-11-01 18:22:58 +01:00
TW 454dbfcaea
Merge pull request #4813 from Gu1nness/fix-borg-man-page
Fix the borg(1) man page creation
2019-11-01 18:09:15 +01:00
Rémi Oudin 5bdf998a21
Fix the borg(1) man page creation
Now the date is updated every time the page is regenerated.
2019-10-22 22:17:58 +02:00
Thalian 87abe5d927 Doc/4532 faq retain original paths (#4794)
More general FAQ for backup and retain original paths, fixes #4532
2019-10-20 16:51:06 +02:00
Thalian f07bcb1387 [DOC] #3866 - Add FAQ for preventing SSH timeout in extract. (#4782)
Add FAQ for preventing SSH timeout in extract, fixes #3866
2019-10-19 21:19:17 +02:00
Thalian 21dc2b9ca0 [DOC] #4591 - Improve password FAQ (decrease pw length, add -w 0 option to base64 to prevent line wrap). 2019-10-18 21:11:25 +02: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
Ioannis Cherouvim b586a6a20e
docs: List items consistency
Capitalized list items and finished them with a full stop. This was inconsistent.
2019-09-20 21:19:38 +03:00
Thomas Waldmann 33862f5a50 build_man 2019-09-07 00:36:10 +02:00
Thomas Waldmann 102068bfeb build_usage 2019-09-07 00:27:17 +02:00
Thomas Waldmann 75dcf93563 update CHANGES 2019-09-07 00:25:11 +02:00
Thomas Waldmann 3f63234974 create: make --noatime the default, deprecate --noatime, fixes #4673
also: add --atime option to enable storing files' atime.
2019-09-06 21:48:54 +02:00
Thomas Waldmann de88c87fd0 update CHANGES (master) 2019-08-30 20:55:31 +02:00
Dmitry Astapov dc1c8c062c Reiterate that 'file cache names are absolute' in FAQ (#4738)
Reiterate that 'file cache names are absolute'

Drive home the point that relative source names does not save you from re-chunking if absolute pathnames change.

Also: mention bind mount solution.
2019-08-30 15:29:17 +02: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
TW ae2ff8066c
add restore docs, fixes #4670 (#4723)
add restore docs, fixes #4670
2019-08-22 23:45:21 +02:00
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
ntova 627ca1376b Fix various code blocks in the docs (#4708)
Fix various code blocks in the docs

- rst markup: put codeblock markup on separate line to make it better visible / separate it from normal text colons.

- borg help texts in archiver.py: put codeblock markup instead of colon - that way it looks like a single colon when using the cli help and also works as code block markup.
2019-08-09 23:13:11 +02:00
Stefan Majewsky fc2c92b054 add a push-style example to borg-create(1) (#4613)
add a push-style example to borg-create docs

When I browsed the readthedocs and manpages while setting up Borg for
myself for the first time, I saw multiple hints that pushing backups via
SSH is supported (e.g. the existence of the `borg serve` command and the
`--rsh` option), but I never found a clear example. I only found
<https://borgbackup.readthedocs.io/en/stable/usage/general.html#repository-urls>
after being pointed to it by @ThomasWaldmann.

Therefore, an explicit example in the `borg create` documentation seems
appropriate. I put it next to the pull-style example using sshfs which
serves a similar usecase.
2019-08-09 22:46:57 +02:00
Thomas Waldmann 8622014188 timestamps in the files cache are now usually ctime, fixes #4583 2019-08-09 21:27:30 +02:00
ntova c2ae9673b4 docs: benchmark crud: clarify that space is used until compact 2019-07-28 15:29:44 +02:00
Tiago Donato 8db4106150
Update documentation of borg create
Corrects a mention of borg 1.1 as a future version.
2019-07-15 21:53:30 -05:00
Joachim Breitner b86aaa606d
RST syntax fix in docs 2019-07-09 10:23:33 +02:00
Russell Davis 3fb5998bae Fix osxfuse github link in installation docs
It was broken because there's already a different reference named
github in `docs/global.rst.inc`. Fixed by using an anonymous hyperlink
reference, per https://stackoverflow.com/a/14067756/278488
2019-06-23 19:24:37 -07:00
Elmar Hoffmann d2595065b4 fix spelling 2019-06-15 13:19:43 +02:00
TW 47fa7a83a7
Merge pull request #4620 from ThomasWaldmann/quickstart-passphrase-providing-master
how to supply a passphrase, use crypto devices, fixes #4549
2019-06-10 23:21:59 +02:00
Thomas Waldmann faae9c9d56 how to supply a passphrase, use crypto devices, fixes #4549 2019-06-10 22:31:29 +02:00
Thomas Waldmann 897e81dbe9 extract: document limitation "needs empty destination", fixes #4598 2019-06-10 21:39:35 +02:00
Thomas Waldmann dc8077acba remove superfluous whitespace in docs 2019-06-09 14:45:18 +02:00
Sebastiaan Lokhorst 8aafc622e7
docs: update macOS Brew link 2019-05-28 13:44:16 +02:00
Luke Murphy 3f55841591
Add note for software for automating backup docs
Closes https://github.com/borgbackup/borg/issues/4581.
2019-05-21 12:48:03 +02:00
Ori Livneh 92049f5405 Fix reference in FAQ 2019-05-12 13:35:31 -04:00
Thomas Waldmann 3082b1f1eb compact: move --cleanup-commits description from examples to docs 2019-05-06 23:10:07 +02:00
Thomas Waldmann 78cb2b1de5 build_man 2019-04-22 18:00:56 +02:00
Thomas Waldmann 1f527464ab build_usage 2019-04-22 18:00:28 +02:00
Thomas Waldmann 0b65a79a79 update CHANGES (master) 2019-04-22 17:54:43 +02:00
Thomas Waldmann e74f4adea1 update CHANGES (master) 2019-04-20 18:33:42 +02:00
Mike ef90cda43a Add "SSH Configuration" section (#4493)
Add "SSH Configuration" section

Add "SSH Configuration" section to "borg serve" documentation, to outline ssh/sshd configuration to prevent borg serve keeping a lock on a repo in the event the ssh connection is abnormally disconnected.

In response to issues #3988, #636 and #4485 (and probably others).
2019-04-08 21:10:26 +02:00
Thomas Waldmann 572a778554 build_man 2019-03-21 21:11:46 +01:00
Thomas Waldmann 9c380405a2 build_usage 2019-03-21 21:11:18 +01:00
Thomas Waldmann f1d23e0963 add release date 2019-03-21 21:08:08 +01:00
Thomas Waldmann 3157809719 update CHANGES (master) 2019-03-21 20:35:13 +01:00
Thomas Waldmann 060fb02112 docs: update requirements, fixes #4374
also some other minor install docs updates, to be continued...
2019-03-20 00:01:30 +01:00
Thomas Waldmann f922cdd803 docs: remove libzmq3* for debian/ubuntu 2019-03-19 23:19:38 +01:00