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

1724 Commits

Author SHA1 Message Date
Andrey Bienkowski 6bc1f48e4e Apply review suggestions 2022-02-05 09:07:13 +03:00
Andrey Bienkowski d6c16d77cb Review suggestion: mention local nonce path 
> do we maybe also want to mention the specific path where the local
> nonce is kept?
 2022-02-05 09:07:13 +03:00
Andrey Bienkowski fab5024cb7 Doc: warn about tampered server nonce 
https://github.com/borgbackup/borg/pull/6188#discussion_r794752672
> Well, guess one could also use max(list of trusted nonce values).
>
> The real issue is if you have lost all or some of the trusted
> (client side) nonce values and you also have reason to not trust the
> server side nonce, because someone might attack you on the server.
 2022-02-05 09:07:13 +03:00
Andrey Bienkowski 62fe1cab30 Doc: impact of deleting path/to/repo/nonce 
Fixes: https://github.com/borgbackup/borg/issues/5858
 2022-02-05 09:07:04 +03:00
Thomas Waldmann 6c517e4c25 docs: FUSE "versions" view is not experimental any more 2022-01-31 21:01:49 +01:00
Andrey Bienkowski 3c380f8a90 Compile the screencast 2022-01-29 17:16:16 +03:00
Andrey Bienkowski e4c08f0643 rm basic.sh 2022-01-29 17:03:08 +03:00
Andrey Bienkowski cc6768ec71 Add prompts 2022-01-29 16:36:19 +03:00
Andrey Bienkowski c67646857f Remove commented-out code 2022-01-29 16:36:13 +03:00
Andrey Bienkowski 7a6454618c Automate the basic usage screencast 2022-01-29 16:31:29 +03:00
Andrey Bienkowski 910852acbf Begin automating asciinema screencasts 2022-01-29 15:54:30 +03:00
Thomas Waldmann faf980cb69 update install docs, fixes #6180 2022-01-29 01:52:41 +01:00
Dee Newcum 03bbad0d17
docs: fix/update cygwin package requirements (#5735) 
docs: cygwin package requirements fixes/updates

Co-authored-by: Thomas Waldmann <tw@waldmann-edv.de>
 2022-01-29 01:51:23 +01:00
Andrey Bienkowski 98fcef57ce
Doc: ~/.config/borg/keys is not used w/ repokey (#6185) 
docs: ~/.config/borg/keys is not used for repokey keys, fixes #6107

Thanks to ThomasWaldmann for suggesting this
https://github.com/borgbackup/borg/pull/6185#discussion_r793995379
 2022-01-28 18:29:40 +01:00
Thomas Waldmann ab1a83c813 changes.rst markup fixes 2022-01-23 17:18:17 +01:00
Thomas Waldmann c643210741 docs: fix tar-related doc structure 2022-01-23 17:16:20 +01:00
Thomas Waldmann 61c7ee2b35 build_man 2022-01-23 15:53:42 +01:00
Thomas Waldmann 572e996d9a build_usage 2022-01-23 15:52:21 +01:00
Thomas Waldmann 5b60761bd7 update CHANGES 2022-01-23 15:39:40 +01:00
Mateusz Konieczny b4f54399d8
minor rewrite to make it less confusing (get rid of "Avoid to create a mixup") (#5490) 
docs: permissions note rewritten to make it less confusing

Original wording was confusing "Avoid to create a mixup of users and permissions in your repository (or cache)." is not clear, what should be avoided?

Also implement some feedback of @jdchristensen.

Co-authored-by: Thomas Waldmann <tw@waldmann-edv.de>
 2022-01-22 20:21:36 +01:00
Thomas Waldmann 35d00ceb2f updated 1.0.x changes up to last one, dissect 1.0.x vs 1.1.x 2022-01-21 14:44:14 +01:00
Thomas Waldmann 5d0446ccf8 updated 1.1.x changes up to 1.1.17 2022-01-21 14:24:12 +01:00
Thomas Waldmann 78f0f3518e remove leftovers of BORG_HOSTNAME_IS_UNIQUE from docs 
thanks to @snsmac for the hint: there is no code implementing this any more. it was replaced by
BORG_HOST_ID (if needed).
 2022-01-20 23:38:43 +01:00
TW b8419c9859
Merge pull request #6129 from ThomasWaldmann/y2022-master 
it's 2022
 2022-01-20 02:26:00 +01:00
Chen Yufei 7e746e10e7
docs: excluded parent dir's metadata can't restore. (#6062) 
docs: if parent dir is not extracted, we do not have its metadata
 2022-01-20 02:04:15 +01:00
Tavlor 2c7253dcbb
clarify who starts the remote agent 
It was unclear that the user _only_ needs to have borg installed on a remote system to use client/server mode. Hopefully this change makes it apparent that the user doesn't start anything on the remote system themselves.
 2022-01-18 02:07:01 +00:00
Thomas Waldmann 035c175cbb it's 2022 2022-01-16 23:28:18 +01:00
TW 836cb61b4c
Merge pull request #6127 from ThomasWaldmann/update-changes-master 
update CHANGES
 2022-01-16 23:07:31 +01:00
Thomas Waldmann 549f83a220 update CHANGES 2022-01-16 21:34:24 +01:00
TW 0aabff67f7
Merge pull request #6065 from enkore/patch-2 
docs/data-structures: add content-defined chunking explainer
 2022-01-16 21:01:09 +01:00
Thomas Waldmann 94e93ba7e6 formula is only approximately correct 
the movement of the start of the hashing window stops at (file_size - window_size), thus THAT would be the factor in that formula, not just file_size.

for medium and big files, window_size is much smaller than file_size, so guess we can just say "approximately" for the general case.
 2022-01-16 20:39:29 +01:00
Reiko Asakura e38f0b26b0
Workaround for volume shadow copy in WSL1 2021-12-24 15:15:23 -05:00
TW 03ab4dc116
Merge pull request #6085 from hexagonrecursion/fix-build-man 
Fix exceptions thrown by `setup.py build_man`
 2021-12-10 18:15:20 +01:00
Andrey Bienkowski dbfef31783
borg serve: improve ssh forced commands docs (#6083) 
borg serve: improve ssh forced commands docs

Co-authored-by: Andrey Bienkowski <hexagon-recursion@posteo.net>
 2021-12-10 18:11:25 +01:00
Andrey Bienkowski 37e1ae4735 Fix exceptions thrown by `setup.py build_man` 
While doing some doc updates I needed a way to test them - to build
the documentation and inspect the output. I ran into an issue:
running python setup.py build_man was throwing exceptions:

1. The import-tar parser had a None description causing:

    File "/home/user/borg/setup_docs.py", line 451, in write_heading
      write(char * len(header))
    TypeError: object of type 'NoneType' has no len()

2. There was no docs/usage/import-tar.rst causing an exception too
 2021-12-10 10:51:26 +03:00
enkore 79cb4e43e5
docs/data-structures: tie CDC back into dedup rationale 2021-11-27 18:45:19 +00:00
enkore 5b297849d3
docs/data-structures: add content-defined chunking explainer 2021-11-27 14:41:24 +00:00
AJ Jordan 284b26f6cc
Fix manifest-timestamp path 2021-10-18 02:54:12 -04:00
ahtaarra 09730833ec
Fix broken link to .nix file 
Fix the link to .nix file which has been broken since this change: e570d93519
 2021-10-05 06:53:11 +06:00
Thomas Waldmann 59b6dc5442 require python 3.8+, fixes #5975 
if you do not have py38+ yet, just use borg 1.1.x.
 2021-09-16 02:21:29 +02:00
Jubjub 0393cfac6c
docs: document behavior for filesystems with inconsistent inodes, fixes borgbackup#5770 (#5965) 2021-08-25 21:43:47 +02:00
remyabel e25095364b
docs: clarify pattern usage with commands (#5959) 
docs: clarify pattern usage with commands, fixes #5176
 2021-08-21 16:02:11 +02:00
Tommy Nguyen 7639465ad4
docs: clarify pp pattern type 
Fixes: #5300

This incorporates the comments from `patterns.py` into the documentation
to clarify the difference between `pp` and `pf`.
 2021-08-07 07:38:04 -04:00
remyabel 79db0b0815
docs: update referenced freebsd version (#5945) 
docs: update referenced freebsd/macOS versions used for binary build

Fixes #5942.
 2021-08-05 22:56:02 +02:00
TW 1e7c1414b0 Merge pull request #5902 from ThomasWaldmann/pull-chroot-problematic-1.1 
docs: pull mode: add some warnings, fixes #5827
 2021-07-11 18:07:14 +02:00
Dmitry Astapov a35c7add95
docs: mention tar --compare (#5880) 
docs: mention tar --compare (compare archive to fs files)
 2021-07-03 17:10:19 +02:00
TW e6811748b1 Merge pull request #5873 from ThomasWaldmann/disable-selftest-1.1 
implement BORG_SELFTEST env variable, fixes #5871
 2021-07-03 12:31:13 +02:00
remyabel 1c7602f9e0
docs: add info on renaming repositories (#5866) 
docs: add info on renaming repositories, fixes #5240
 2021-06-23 00:08:49 +02:00
James Buren 4f9e30e980 resolve clarify borg check --verify-data (#5808) 2021-06-18 15:00:14 -05:00
James Buren 8394ae6932 add notice about defective hardware to check documentation (#5753) 2021-06-18 01:26:57 -05:00
Philip Kozeny 12c54db4d4
Update changes.rst 
fix typo in changes.rst
 2021-05-13 12:51:17 +02:00
lyh16 1f8a837303
It's 2021 2021-05-12 21:25:16 +09:00
Thomas Waldmann a99ae950c9 build_usage 2021-05-11 22:33:55 +02:00
Thomas Waldmann f301828241 build_man 2021-05-11 22:33:28 +02:00
Thomas Waldmann e79449157b set release version and date 
yet another beta - still too many changes and unmerged
low-level changes, so we cannot go to RCs yet.
 2021-05-11 22:28:59 +02:00
Thomas Waldmann 3e4169aade add a Change Log header that appears in TOC 2021-05-11 22:26:30 +02:00
Thomas Waldmann 7ac9e2efef update CHANGES 2021-05-11 22:22:36 +02:00
Thomas Waldmann 852bc7b0d9 update CHANGES 2021-05-01 23:06:48 +02:00
TW a9b1e1fe56
Merge pull request #5773 from ThomasWaldmann/attack-or-unsafe-docs-master 
docs: add unsafe workaround to use an old repo copy, fixes #5722
 2021-04-19 20:23:27 +02:00
Thomas Waldmann 06c6e7e79c docs: add unsafe workaround to use an old repo copy, fixes #5722 2021-04-19 20:11:37 +02:00
Thomas Waldmann c5ec6e78d2 update CHANGES (master) 2021-04-19 18:34:56 +02:00
Robert Blenis b2dea4422e add --json-lines option to diff command 2021-03-13 11:50:55 -05:00
Manu 2ad2c90d6b Use macFUSE instead of osxfuse 2021-02-18 21:36:14 +08:00
Manu 9d54507e22 Wording update, combine paras. 2021-02-17 22:06:46 +08:00
Manu 2729529ee2 Add note on macFUSE dependency. 2021-02-17 08:44:49 +08:00
Manu 0b5d332a89 Add short note on pointing setup.py to openssl on macOS 2021-02-15 11:54:21 +08:00
Matthew R. Trower 1e01aca301 docs: remove /var/cache exclusion in example commands 
This is generally a poor idea and shouldn't be promoted through examples.

Fixes #5625
 2021-02-12 14:32:33 -06:00
Manu f8d7b9c232
Recommend download via CLI on macOS (#5682) 
docs: recommend download via CLI on macOS

otherwise (browser) one has to remove the quarantine xattr.
 2021-02-11 21:31:40 +01:00
Manu 78b94adc06
Update macOS install instructions (#5677) 
update macOS install instructions. Fixes #5522, #5622.
 2021-02-08 20:09:37 +01:00
Thomas Waldmann ae5c5653a8 build_man 2021-02-06 01:32:54 +01:00
Thomas Waldmann e48289e8b7 build_usage 2021-02-06 01:32:02 +01:00
Thomas Waldmann 6561d7b478 update CHANGES 2021-02-06 01:24:14 +01:00
Thomas Waldmann b1fff5dd39 FAQ: project_name -> Borg 
see changeset 8d830d069f where this was
started.
 2021-02-06 01:24:14 +01:00
Thomas Waldmann c3df6fcca4 fix docs about blake2 requirements / origin 2021-01-28 18:00:00 +01:00
Ryan Polley 83116e58f2
add examples for --paths-from-stdin, --paths-from-command, --paths-separator (#5644) 
docs: add examples for --paths-from-stdin, --paths-from-command, --paths-separator
 2021-01-27 00:15:14 +01:00
TW b20c7229e6
Merge pull request #5642 from rpolley/fix-grammar-in-docs-5632 
fix grammar in faq
 2021-01-23 01:44:28 +01:00
Ryan Polley 1c5b57f1b3 recomend running tests only on installed versions for setup 2021-01-22 16:21:13 -06:00
Ryan Polley 974fd9eecb add link back to git-installation 2021-01-22 16:12:52 -06:00
Ryan Polley 921cac0177 fix grammar in faq 2021-01-22 14:35:45 -06:00
infectormp ab97bc20ed
Add badge with current status of package 2021-01-09 17:58:47 +03:00
TW 37d4aee122
Merge pull request #5597 from Gelma/typos_dec 
Fix typos
 2021-01-07 19:21:03 +01:00
Thomas Waldmann 0984e00d31 revert changes to autogenerated files 
this stuff will be auto-generated, regularly done at release time.
 2021-01-07 18:08:49 +01:00
Andrea Gelmini 72e7c46fa7 Fix typos 2021-01-07 17:54:33 +01:00
Jens Diemer 5a585c5c2e
"python-virtualenv" -> "python3-virtualenv" 2021-01-07 10:31:26 +01:00
Thomas Waldmann 4394fa45ba update CHANGES 2021-01-03 21:40:31 +01:00
axapaxa b291b91962
Add remote upload buffer (--remote-buffer) (#5574) 
add remote upload buffer (--remote-buffer)

- added new option --remote-buffer
- allow to_send to grow to selected size
- don't grow if wait is specified
- fill pipe on any command (including 'async_response')
- add new option to docs
- create EfficientBytesQueue to prevent recreation of buffer each time we send something
- add tests for EfficientBytesQueue
 2021-01-03 17:37:16 +01:00
Thomas Waldmann b8bb0494f6 create --sparse, file map support for the "fixed" chunker, see #14 
a file map can be:

- created internally inside chunkify by calling sparsemap, which uses
  SEEK_DATA / SEEK_HOLE to determine data and hole ranges inside a
  seekable sparse file.
  Usage: borg create --sparse --chunker-params=fixed,BLOCKSIZE ...
  BLOCKSIZE is the chunker blocksize here, not the filesystem blocksize!

- made by some other means and given to the chunkify function.
  this is not used yet, but in future this could be used to only read
  the changed parts and seek over the (known) unchanged parts of a file.

sparsemap: the generate range sizes are multiples of the fs block size.
           the tests assume 4kiB fs block size.
 2020-12-27 22:06:08 +01:00
Thomas Waldmann f75c561e07 docs: add another case of attempted hardlink usage 2020-12-26 00:04:24 +01:00
Thomas Waldmann 3a828bea0b docs: fix description of borg upgrade hardlink usage, fixes #5518 2020-12-26 00:03:34 +01:00
TW 2b992fe078
Merge pull request #5332 from amikula/keep-oldest-when-retention-target-not-met 
Keep oldest when retention target not met
 2020-12-25 19:00:19 +01:00
Robin Schneider fb38ba579f
Use HTTPS everywhere (mechanical edit using util from https-everywhere) 
Ref: https://github.com/EFForg/https-everywhere/tree/master/utils/rewriter

```Shell
~/src/EFForg/https-everywhere/utils/rewriter/rewriter.js .
```

A few changes were reset/fixed manually before the commit.
 2020-12-22 16:36:40 +01:00
Alf Mikula e208ba68bd Document retention of oldest archive, add to example and tests 2020-12-18 10:16:38 -08:00
Nehalenniæ Oudin 5017bc4d04
Add a --list switch to borg delete (#5503) 
add a --list switch to borg delete, fixes #5116
 2020-12-11 19:11:47 +01:00
Thomas Waldmann 2031494f23 build man 2020-12-06 20:45:41 +01:00
Thomas Waldmann 4f7aa1a92f build usage 2020-12-06 20:44:59 +01:00
Thomas Waldmann 77dd5e4d81 update CHANGES (master) 
set release date.
 2020-12-06 20:25:14 +01:00
Thomas Waldmann 938c2dc223 update CHANGES (master) 2020-12-06 18:04:50 +01:00
Nehalenniæ Oudin 810d82395d
Complete documentation on append-only remote repos (#5519) 
improve docs/FAQ about append-only remote repos, fixes #5497
 2020-12-06 15:53:39 +01:00
Thomas Waldmann 7831280aa4 update CHANGES (master) 2020-12-04 19:05:26 +01:00
Samuel fa331c3e3b
Change references of Travis to GitHub Actions (#5536) 
s/travis/github actions/g, fixes #5528
 2020-12-03 20:10:53 +01:00
Thomas Waldmann b45874bead ObfuscateSize compressor 2020-12-02 14:21:42 +01:00
Guinness 046acb882a
Add a hint on sleeping computer in the FAQ 
Now the FAQ warns that a sleeping computer can lead to a broken pipe
when backing up over ssh.

Fixes #5301
 2020-11-17 10:50:45 +01:00
TW ac77dd491d
Merge pull request #5433 from luke-jr/files_cache_suffix 
Allow appending the files cache filename with BORG_FILES_CACHE_SUFFIX env var
 2020-11-16 18:51:40 +01:00
Luke Dashjr 561fbb748c docs: Document BORG_FILES_CACHE_SUFFIX environment variable 2020-11-15 17:01:36 +00:00
Kurt Yoder f73555e5b2 Fix link for OSX security 2020-11-14 19:41:59 -05:00
Kurt Yoder 5d2c6e9eca Note requirement for full disk access on Catalina 2020-11-14 19:39:14 -05:00
TW e881ce3e93
Merge pull request #5505 from Gu1nness/1633-compression-algorithms 
Add some documentation for new compression algorithm
 2020-11-13 15:05:21 +01:00
Guinness 4212730e54
Add some documentation for new compression algorithm 2020-11-13 13:23:37 +01:00
Guinness 3278d253c5
Update the documentation on hacked backup client. 
Fixes #5480.
 2020-11-13 10:31:05 +01:00
TW 122dfce405
Merge pull request #5464 from Samuel-BF/patch-1 
Doc / Deployment with ansible: generic install
 2020-11-07 17:57:50 +01:00
Samuel BF 7e60a5e052 Rephrasing doc on deployement with ansible 2020-11-06 14:28:27 +01:00
Samuel-BF e18649d2d2 Doc / Deployment with ansible: pacman -> package 
Using "package" ansible module make the ansible playbook able to run
against most unix OSes. Pacman module only works with Arch and derivatives.

Also : changing state from "latest" to "present". Ansible should not be
a way to keep your system up-to-date : it's a configuration management
system and, as such, should not change anything if neither the playbook
nor the machine changed its state (idempotency).

Reference : https://github.com/ansible/ansible-lint/blob/master/lib/ansiblelint/rules/PackageIsNotLatestRule.py#L24
 2020-11-06 14:28:01 +01:00
TW 47e96bc261
Merge pull request #5475 from milkey-mouse/fp-5377 
docs: how to approach borg speed issues (forward port)
 2020-11-03 15:55:15 +01:00
Thomas Waldmann 60ee199a0f docs: how to approach borg speed issues, fixes #5371 
also: give a speed example for unchanged files

also: explicitly mention chmod/chown changing ctime

also: reformat one paragraph
 2020-11-02 17:36:08 -08:00
Thomas Waldmann 9d2cabc4d2 update travis-ci.org -> .com (master) 2020-11-02 23:06:15 +01:00
TW b05182260c
Merge pull request #5430 from ThomasWaldmann/pyfuse3 
add pyfuse3 as an alternative lowlevel fuse implementation
 2020-11-02 22:51:17 +01:00
Thomas Waldmann 49b1421682 FUSE: support pyfuse3 additionally to llfuse, fixes #5407 
FUSE implementation can be switched via env var BORG_FUSE_IMPL.
 2020-10-31 22:04:44 +01:00
Mher Kazandjian 5bcb52db77
add example for excluding content using the --pattern cmd line arg (#5456) 
add example for excluding content using the --pattern command line argument
 2020-10-28 23:32:40 +01:00
Guinness 61c92110e6 Change documentation inaccuracy on chunk size. 
We know use only "target chunk size" when speaking of the chunk size
that is expected to happen most of the time. This removes statistical
and mathematical inacurracies that could be troublesome for mathematical
people.

Fixes #5336
 2020-10-23 13:03:12 +02:00
jeroen tiebout ed5d3dfe24
fix small typo in quickstart docs 2020-10-12 19:33:45 +02:00
Thomas Waldmann 2e31c3fd21 remove duplicate homebrew label definition 
seems to be not used.
 2020-10-08 12:39:29 +02:00
Thomas Waldmann dc4ebb3822 fix install commands table markup 
bad indentation causing a sphinx warning.
 2020-10-08 12:33:15 +02:00
Thomas Waldmann 1562952ada build_man 2020-10-04 20:33:08 +02:00
Thomas Waldmann ab31dc476e build_usage 2020-10-04 20:32:38 +02:00
Thomas Waldmann 61ce9e1376 update CHANGES (master) 2020-10-04 20:31:15 +02:00
Thomas Waldmann 8d1ae6f0f7 Revert "add double force" 
This reverts commit 6fac203d86.

Fix was applied to an autogenerated file,
it needs to be applied to the builtin help of the borg code.
 2020-09-27 23:46:45 +02:00
TW d050b70130
Merge pull request #5345 from ThomasWaldmann/drop-py35 
drop python 3.5, fixes #5344
 2020-09-26 00:37:38 +02:00
Aleksey Korol aef5e89126
Add ssh-agent pull backup method to doc (#5288) 
deployment docs: add ssh-agent pull backup method

Co-authored-by: Король Алексей <a.korol@npp-crts.ru> (main work)
Co-authored-by: Thomas Waldmann <tw@waldmann-edv.de>
 2020-09-25 14:20:29 +02:00
Thomas Waldmann 1a8f5d27ab drop python 3.5, fixes #5344 
py35 is EOL.
 2020-09-25 02:13:43 +02:00
nod0n c8efc4a944
fix typo 2020-09-03 17:12:54 +02:00
Alex Vorona 6fac203d86 add double force 2020-08-25 21:27:18 +03:00
Manu e632f2659e Update Homebrew install instructions. See #5185 2020-08-18 23:55:37 +08:00
Thomas Waldmann 45780d87b1 it's 2020 2020-08-13 22:07:02 +02:00
viq e00ffabd10
Better description of how cache and rebuilds of it work 
and how the workaround applies to that
 2020-08-03 22:35:23 +02:00
Thalian 668a136794 docs: add security faq explaining AES-CTR crypto issues, fixes #5254 2020-07-25 12:12:32 +02:00
TW 303c11f245
rephrase some warnings, fixes #5164 (#5241) 
rephrase some warnings, fixes #5164

borg check --repair and borg recreate are now present in the code since rather long, so they are not experimental any more.

borg recreate might be used wrongly (e.g. accidentally excluding everything / not matching anything when recreating an archive). added some warning words in the docs, but it will not ask for confirmation any more.

borg check: there might be kinds of corruption borg check --repair can not fix and it might make things even worse while trying to fix. so this will still ask for confirmation, just with different wording.
 2020-07-10 19:26:18 +02:00
Thomas Portmann dfc5e915cc
Fixed locking, issue #4923 (#4928) 
locking: fix ExclusiveLock race condition bug, fixes #4923

- ExclusiveLock is now based on os.rename instead of os.mkdir.
- catch FileNotFoundError observed under race condition in ExclusiveLock.release()
  and .kill_stale_lock()
- added TestExclusiveLock.test_race_condition() which reveals issue #4923
- updated docs
- locking: use "raise LockTimeout from None" for prettier traceback

Co-authored-by: Thomas Portmann <thomas@portmann.org>
Co-authored-by: Thomas Waldmann <tw@waldmann-edv.de>
 2020-07-03 10:09:32 +02:00
TW 7033d5054f
Merge pull request #5226 from ThomasWaldmann/server-enforces-umask 
--umask is for the local borg process only, fixes #4947
 2020-06-28 14:58:41 +02:00
Benedikt Seidl 6a1f31bf29
[DOCS] Add socat pull mode (#5150) 
docs: describe socat pull mode, fixes #900

also: fix sphinx deprecation warning

borg/docs/conf.py:114: RemovedInSphinx40Warning: The app.add_stylesheet() is deprecated. Please use app.add_css_file() instead.
 2020-06-23 02:09:35 +02:00
TW e351eedd87
Merge pull request #5140 from fantasya-pbem/docs/2088_Move-resources 
[DOCS] Move content of resources doc page to community project, #2088
 2020-06-20 01:04:02 +02:00
TW 8e846935a2
Merge pull request #5201 from strager/import-to-key-file 
allow key-import+BORG_KEY_FILE to create key files
 2020-06-20 00:32:09 +02:00
Thomas Waldmann c531901763 --umask is for the local borg process only, fixes #4947 
The umask value is NOT transmitted from client to server any more,
so the borg client can not influence the borg server umask any more.

If one wants to have a specific umask on the server side, one needs to
use a ssh forced command in .ssh/authorized_keys file.

OTOH, as the default value is 077 (in general, for client as well as for
the server) and the server does not take the value from the client any more,
there usually should be no need to give it on the server side, IF you are
happy with the default value.
 2020-06-14 18:35:03 +02:00
Thomas Waldmann bfd80ee64a update CHANGES with 1.1.12 and 1.1.13 changelog 2020-06-14 15:08:37 +02:00
Thomas Waldmann fc669b387a update CHANGES 2020-06-14 14:57:42 +02:00
Matthew Glazar 5a32de918e allow key-import+BORG_KEY_FILE to create key files 
Running 'borg key import' on a keyfile repository with the BORG_KEY_FILE
environment variable set works correctly if the BORG_KEY_FILE file
already exists. However, the command crashes if the BORG_KEY_FILE file
does not exist:

    $ BORG_KEY_FILE=newborgkey borg key import /home/strager/borg-backups/straglum borgkey
    Local Exception
    Traceback (most recent call last):
      [snip]
      File "[snip]/borg/crypto/key.py", line 713, in sanity_check
        with open(filename, 'rb') as fd:
    FileNotFoundError: [Errno 2] No such file or directory: '[snip]/newborgkey'

    Platform: Linux straglum 5.0.0-25-generic #26~18.04.1-Ubuntu SMP Thu Aug 1 13:51:02 UTC 2019 x86_64
    Linux: debian buster/sid
    Borg: 1.1.11  Python: CPython 3.7.7 msgpack: 0.5.6
    PID: 15306  CWD: /home/strager/Projects/borg
    sys.argv: ['[snip]/borg', 'key', 'import', '/home/strager/borg-backups/straglum', 'borgkey']
    SSH_ORIGINAL_COMMAND: None

Make 'borg key import' not require the BORG_KEY_FILE file to already
exist.

This commit does not change the behavior of 'borg key import' without
BORG_KEY_FILE. This commit also does not change the behavior of 'borg
key import' on a repokey repository.
 2020-06-04 19:29:15 -07:00
Uriel 8b6f4a1afe
docs: explain hash collision (#5188) 
explain hash collision probability, fixes #4884
 2020-06-02 22:19:54 +02:00
Thomas Waldmann 1581c4f9c4 build_man 2020-04-21 22:59:27 +02:00
Thomas Waldmann 17220e09ab build_usage 2020-04-21 22:56:55 +02:00
Thomas Waldmann 95d10b84c4 update CHANGES, set release date 2020-04-21 22:52:54 +02:00
TW 27a41f5c1f
Merge pull request #5115 from ThomasWaldmann/redo-pr-4269 
docs: clarify borg init's encryption modes
 2020-04-21 11:45:40 +02:00
Thomas Waldmann b5ab795d6f update CHANGES (master) 2020-04-20 22:36:41 +02:00
Thalian bfbb1ca525 [DOCS] Move content of resources doc page to community project, #2088 2020-04-19 19:13:02 +02:00
Thalian 5cb8bd0dd0 [DOC] Add upgrade of tools to pip installation how-to 
fixes #5090
 2020-04-17 07:53:48 +02:00
Thomas Waldmann b5d6e23d84 docs: clarify borg init's encryption modes 2020-04-16 21:35:33 +02:00
Thomas Waldmann 6b3c7165aa build_man 2020-04-12 19:55:57 +02:00
Thomas Waldmann 56c599e6dc build_usage 2020-04-12 19:51:49 +02:00
TW c867ebfeb6
Merge pull request #5048 from finefoot/patch-8 
Option to bypass locking to use sensible borg commands with read-only repositories
 2020-04-11 22:18:37 +02:00
finefoot e49a17143d Add option to bypass locking mechanism 2020-04-11 17:04:52 +02:00
Thalian d0054f4482 [DOC] linked recommended restrictions to ssh public keys on borg servers in faq, #4946 
fixes #4946
 2020-04-08 03:02:50 +02:00
Thalian 25ab198d41
[DOCS] #4883 – Doc downplays severity of Nonce reuse issue (#5082) 
docs: Borg documentation downplays severity of Nonce reuse issue, fixes #4883
 2020-04-05 23:31:08 +02:00
TW 54df299604
Merge pull request #5034 from fantasya-pbem/docs/3428_Restore-after-corruption 
docs: borg repo restore instructions needed, fixes #3428
 2020-04-05 21:13:25 +02:00
Thomas Waldmann 7dc2a58a93 update CHANGES (master) 2020-04-05 21:00:39 +02:00
Thalian 1d9dadd6b7 [DOCS] #4883 – Borg documentation downplays severity of Nonce reuse issue 
Shorten the log info for deleting/keeping security info. Fix bad wording.
 2020-04-03 17:40:30 +02:00
Thomas Waldmann 888949c641 Improve description of path variables 
Original commit by @finefoot, re-applied due to merge conflict.
 2020-04-01 18:54:45 +02:00
Thalian 41ecd1ae30 [DOCS] #3428 – Borg repo restore instructions needed 
Adapt FAQ to the new delete option.
 2020-03-26 20:02:31 +01:00
Thalian df67b9ea11 [DOCS] #3428 – Borg repo restore instructions needed 
Add new FAQ: A repo is corrupt and must be replaced with an older repo.
 2020-03-25 19:56:51 +01:00
Thalian 08a7661e67 [FEATURE] #4489 – Deprecate --nobsdflags option 
Replaced by --noflags. In internal data structure the key 'bsdflags' is kept for backwards compatibility.
 2020-03-25 06:35:15 +01:00
TW e388fabd5b
Merge pull request #5057 from fantasya-pbem/docs/2929_Document-delete-data 
[DOCS] #2929 – Document how to completely delete data
 2020-03-22 22:01:50 +01:00
Thalian abd81b2ebe Fix broken indent of a list item 
This prevents Sphinx WARNING: Bullet list ends without a blank line; unexpected unindent.
 2020-03-22 15:17:21 +01:00
Thalian a08b058fa0 [DOCS] #2929 – Document how to completely delete data 
Add new FAQ entry that lists two ways how to really delete files from archives.

fixes #2929
 2020-03-20 21:28:40 +01:00
TW d832c6447c
Merge pull request #5045 from fantasya-pbem/docs/5000_Add-rendering-changes 
docs: add "rendering docs" to release todo, fixes #5000
 2020-03-20 17:02:13 +01:00
Thalian 19563b968e [DOCS] #4587 – Make Sphinx warnings break docs build 
Improve / clean up to trigger CI tests again.
 2020-03-20 12:01:52 +01:00
Thalian a8ecec24c2 [DOCS] #5000 – Add rendering docs to release todo 
Add a line regarding checking the markup.
 2020-03-18 19:54:03 +01:00
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 6990feadb6 [DOCS] #4587 – Make Sphinx warnings break docs build 
Remove blank line at top of file.
 2020-03-16 19:06:00 +01:00
Thalian 04a25ba108 [DOCS] #4587 – Make Sphinx warnings break docs build 
Add blank line to prevent Sphinx warning "WARNING: Explicit markup ends without a blank line; unexpected unindent.".
 2020-03-16 19:06:00 +01:00
Thalian 0359b97cce [DOCS] #4587 – Make Sphinx warnings break docs build 
Prevent warnings of type "checking consistency... WARNING: document isn't included in any toctree" by using the :orphan: directive.
 2020-03-16 19:06:00 +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
Thalian 0b5bb8dfec [DOCS] #4073 – PlaceholderError not printed as JSON 
Add a warning for --log-json option that parsing errors will always be printed as plain text.
 2020-03-15 20:37:28 +01:00
TW c140dc995f
Merge pull request #5025 from milkey-mouse/reflow-docs 
Reflow some really long lines in the docs
 2020-03-12 02:23:07 +01:00
Milkey Mouse f7f2493f75
docs: reflow some really long lines 
I used `grep -Pnr '.{100}' *.rst` to find lines >100 characters long and
reflowed them where reasonable. Line length in the docs isn't too important (it
doesn't matter once they're compiled), but it's nice not to have super-long
lines in one's editor.
 2020-03-11 16:27:57 -07:00
TW adf77e4f39
Merge pull request #5023 from milkey-mouse/fix-sphinx-warning 
Suppress Sphinx lexer warnings in frontends.rst
 2020-03-12 00:07:52 +01:00
Milkey Mouse 4e95ad6230
Add updating borgbackup.org/releases to release checklist (fixes #4999) 2020-03-11 15:51:29 -07:00
Milkey Mouse 1edf587bf3
Suppress Sphinx lexer warnings in frontends.rst 
Because some of the JSON blocks in frontends.rst included non-JSON
contents (user replies, etc.) the blocks didn't parse/highlight and
`make html` complained:

borg/docs/internals/frontends.rst:28: WARNING: Could not lex literal_block as "json".

There's no easy way to enable and disable highlighting just for
specific lines, but individually unsetting the highlight language per
block suppresses the warnings.
 2020-03-11 15:33:44 -07:00
Thomas Waldmann f74a3958e9 update changes.rst from 1.1-maint branch, fixes #5006 
pre-1.1.11 advisory
changelogs of 1.1.10 and 1.1.11
 2020-03-09 22:11:14 +01:00
Thomas Waldmann a8831f4978 fix ProgressIndicator msgids, fixes #4935 
add some to code, fix docs.
 2020-03-03 23:57:36 +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
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
Thomas Waldmann f8371898ae docs: mention pkg-config / pkgconfig requirement, fixes #4452 
both are required before invoking setup.py.

also mention libb2 requirement for pkgconfig being able to discover it.
 2019-03-19 23:17:15 +01:00
Thomas Waldmann e69b8996cc docs: remove zeromq requirement 
borg currently does not use zeromq.
 2019-03-19 23:06:24 +01:00
Thomas Waldmann 22e021a5ce docs: install libcrypt-devel on cygwin 
this is included into Python.h, thus needed when compiling stuff.
 2019-03-19 22:38:09 +01:00
Thomas Waldmann ad5fbd9485 update CHANGES (master) 
also: markup fixes
 2019-03-17 21:49:30 +01: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
Alexandr Kozlinskiy b780c36811 docs: fix spelling errors 2019-03-11 22:40:03 +01:00
Thomas Waldmann 39300d1fd0 docs: fix markup 2019-03-11 00:16:12 +01:00
Thomas Waldmann 1386c67513 build_man 2019-03-11 00:11:50 +01:00
Thomas Waldmann 9507856049 build_usage 2019-03-11 00:11:16 +01:00
Thomas Waldmann 621476b027 release date 2019-03-11 00:08:25 +01:00
TW 65bc71a192
update CHANGES (master) (#4429) 2019-03-11 00:06:43 +01:00
TW d7c6399396
Merge pull request #4384 from milkey-mouse/append-only-docs-3504 
Elaborate on append-only mode docs
 2019-03-10 15:04:23 +01:00
Thomas Waldmann 7ad5290501 redo stale lock handling, fixes #3986 
drop BORG_HOSTNAME_IS_UNIQUE (please use BORG_HOST_ID if needed)

borg now always assumes it has a unique hostid - either automatically
from fqdn plus uuid.getnode() or overridden via BORG_HOST_ID.
 2019-03-04 21:07:05 +01:00
Thomas Waldmann abdf5d0706 update CHANGES (master) 2019-03-03 14:16:52 +01:00
jminer74 a2c84215af docs/installation: added Alpine Linux to distribution list (#4414) 
docs/installation: added Alpine Linux to distribution list
 2019-03-01 22:11:48 +01:00
Thomas Waldmann 8b55bb1096 update CHANGES 2019-02-26 22:50:40 +01:00
Thomas Waldmann 032a4effd3 build_man 2019-02-24 20:40:07 +01:00
Thomas Waldmann bece7e8090 build_usage 2019-02-24 20:39:42 +01:00
Thomas Waldmann 34fa89b26c add release date 2019-02-24 20:34:44 +01:00
Thomas Waldmann 2e5e3a87e1 update CHANGES (master) 2019-02-24 19:23:47 +01:00
Thomas Waldmann 9637c3fbb3 update 1.1.6..1.1.9 sections of CHANGES (from 1.1-maint) 2019-02-24 15:53:02 +01:00
Thomas Waldmann 1344779113 update severe issues section of CHANGES (from 1.1-maint) 2019-02-24 15:50:37 +01:00
Milkey Mouse cb2b86274e
Elaborate on append-only mode docs 2019-02-22 19:05:29 -08:00
Thomas Waldmann 2713500983 remove -*- coding: ... lines, utf-8 is default for py3 2019-02-22 17:12:05 +01:00
Milkey Mouse 7ea2bd1389
Only modify window.location when redirecting (fixes #4133) 
window.location.pathname = window.location.pathname can trigger a redirect,
which created a refresh loop in usage.html.
 2019-02-20 11:12:45 -08:00
Milkey Mouse 453e4a4b92
Update copyright year 2019-02-19 20:20:13 -08:00
Thomas Waldmann 7f46eb99aa update docs about fixed chunker and chunker algo spec needed 2019-02-13 06:30:13 +01:00
Thomas Waldmann 305efb5b01 signing binaries with Qubes OS support, docs 2019-02-11 02:44:44 +01:00
anarcat 10a4e011c0 add warnings on repository copies to avoid future problem like #4272 (#4285) 
docs: add warnings about repo copies to avoid problems like #4272
 2019-02-10 20:23:59 +01:00
Thomas Waldmann f7525156c1 update release workflow using twine (docs, scripts), see #4213 2019-02-01 22:07:49 +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
Manuel Riel 7e7d74c1c1 Add new FAQ regarding change of compression settings. Fixes #4222 (#4282) 
FAQ regarding change of compression settings. Fixes #4222
 2019-01-31 05:58:33 +01:00
Manuel Riel 4ecc7ede8d Add note about BSD flags to changelog. Fixes #4246 (#4279) 
Add note about BSD flags to changelog. Fixes #4246
 2019-01-31 05:56:37 +01:00
Manu b37aceb469 Add FAQ regarding free disk space check. Fixes #3905 2019-01-31 12:45:41 +08:00
Manu d13ddb224a Update BORG_PASSCOMMAND example and clarify variable expansion. Fixes #4249 2019-01-30 10:12:47 +08:00
step21 a577a63313
Added vorta gui 2019-01-05 21:07:28 +01:00
Greg Grossmeier b311b62e0d Docs: Improve logging in example automation script (#4226) 
docs: improve logging in example automation script

* add an info entry for the compacting step
* add a final info entry for successful completion
 2018-12-21 18:54:58 +01:00
Thomas Waldmann 2864fb781c update changelog about removed deprecated stuff 2018-12-11 23:55:29 +01:00
Thomas Waldmann fc6e81c8bb docs: --format is required for some expensive-to-compute values 
borg list by default does not compute expensive values except when
they are needed. whether they are needed is determined by the format,
in standard mode as well as in --json mode.
 2018-12-07 01:18:32 +01:00
Thomas Waldmann 02f3c80d83 docs: tell that our binaries are amd/intel, bauerj has ARM 
(cherry picked from commit 13986a1a6a)
 2018-12-07 00:51:51 +01:00
James Vasile 806d937c2e 4081 - Add note about files changing during backup (#4116) 
Add note about files changing during backup
 2018-11-01 21:11:05 +01: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 8a09f26712 remove zeromq or python 3.5 references 2018-08-06 17:52:08 +02:00
Thomas Waldmann 90348c1de9 add BORG_HOST_ID, fixes #3985 2018-08-04 15:01:48 +02:00
James Rowell 34227430d4 Installation from source - setting python interpreter version (#3995) 
explicit instructions for setting python interpreter when installing from source via git
 2018-07-29 09:50:09 +01:00
Marvin Gaube 2a4ed3f0e8 Note regarding borg version (#3987) 
add a note regarding in-file checkpointing and borg versions
 2018-07-20 16:25:16 +02:00
Thomas Waldmann 318cfffde1 update CHANGES about compaction changes 2018-07-14 19:15:09 +02:00
Thomas Waldmann a8d52351bb update man pages / usage docs 2018-07-14 14:56:29 +02:00
Thomas Waldmann e6fcf4ea42 update docs about separated compaction 2018-07-14 14:53:23 +02:00
Thomas Waldmann 3fd6bd8ca7 update CHANGES: added 1.1 history (master) 2018-07-08 00:18:09 +02:00
Thomas Waldmann a89aadc9f2 update CHANGES (master) 2018-07-08 00:13:13 +02:00
Russell Davis 041f1baf4c
Update installation instructions for macOS 
- Updated `OS X` to the new `macOS` name
- Fuse 3.x is no longer just a prerelease
- Added instructions to install fuse via homebrew
 2018-07-06 18:46:18 -07: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
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
Thomas Waldmann 91ff2f81a6 docs: move bsdflags tuning comments to notes docs section 
the atime comments are already there.
 2017-11-25 20:08:33 +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
Thomas Waldmann f2a1539f25 docs: fix examples with problematic option placements, fixes #3356 
have options to the left OR to the right of all positional arguments,
but not on BOTH sides and not in between them.
 2017-11-25 19:29:34 +01:00
Thomas Waldmann ef8217afc9 build_man (master) 
also: git add borgfs.1
 2017-11-25 14:38:04 +01:00
Thomas Waldmann 73fac09dda build_usage (master) 
also: add new borgfs.rst.inc
 2017-11-25 14:35:52 +01:00
Michael Rupert 71fbac94fb Moved Support to .org (#3360) 
docs: moved support options to www.borgbackup.org
 2017-11-25 03:15:18 +01:00
TW c5dc75ae23
Merge pull request #3312 from milkey-mouse/borg-config-cmd 
Add borg config command
 2017-11-24 16:56:15 +01:00
Milkey Mouse 5b47cf6fa5
Add borg config command (fixes #3304) 
This command works similarly to "git config" - it parses repo and
cache configs to get, set, and delete values. It only works on local
repos so a malicious client can't e.g. override their storage quota
or reset the append_only flag.

Add tests for borg config

Add documentation for borg config

Change manual config edits -> borg config

There were a couple places in the documentation where it was advised
to edit the repository or cache config file, a process that is stream-
lined by borg config.
 2017-11-23 14:51:54 -08:00
TW 483d3e8a8b
Merge pull request #3292 from milkey-mouse/document-ntfsclone 
Add instructions for using ntfsclone
 2017-11-23 22:07:15 +01:00