upstream/borgbackup
1
0
Fork 0
mirror of https://github.com/borgbackup/borg.git synced 2026-07-10 18:51:23 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 4
10222 commits 10 branches 151 tags 70 MiB
Commit graph

1979 commits

Author SHA1 Message Date
Dominik Stadler
8fab4e4152 Fix command and add more notes 2023-04-02 11:03:32 +02:00
Dominik Stadler
4216dfd12d Describe performing pull-backups via ssh remote forwarding 2023-04-02 10:52:36 +02:00
Michael Deyaso
98d1c65b40 Installed and configured pre-commit to lint and format code. Fixes #7476 2023-03-25 13:34:30 +03:00
Thomas Waldmann
d6e3d36ce1
BORG_KEY_FILE: clarify docs, fixes #7444 2023-03-22 18:17:29 +01:00
Rayyan Ansari
3174904ce3
docs: installation: Add instructions for Windows 
Remove the old Windows README while we're at it.
 2023-03-12 20:53:11 +00:00
Thomas Waldmann
506652d4b2
docs: remove OS directory from install docs 
- links did not work that way
- each OS has its own headline and can be discovered easily without
  that directory
 2023-03-11 18:50:22 +01:00
abebeos
f9f33044cc add link to OS dependencies 
The "Building a development environment" section links to the
"Using git" section. This can result in developers overseeing
the os dependencies necessity.

re #7356
 2023-03-10 16:44:01 +00:00
Thomas Waldmann
23dcc18bec
update FAQ about locale/unicode issues, fixes #6999 2023-03-04 16:30:24 +01:00
Thomas Waldmann
f06d3cc9c8
build_man 2023-02-26 21:32:44 +01:00
Thomas Waldmann
52b9f8e7e9
build_usage 2023-02-26 21:32:42 +01:00
Thomas Waldmann
1233b47878
sphinx: fix extlinks configuration 
otherwise sphinx crashes.
 2023-02-26 21:32:40 +01:00
Thomas Waldmann
03cb4d4124
update CHANGES, set release date 
also minor other changes.
 2023-02-26 21:32:32 +01:00
Thomas Waldmann
c8f5cab8b6
update CHANGES 2023-02-26 01:14:18 +01:00
Andreas Vögele
4b18980768 Installation: Update Fedora in distribution list 
Fixes #7357
 2023-02-16 18:27:48 +01:00
Thomas Waldmann
b42d2bf6dd
update CHANGES 2023-02-11 18:56:30 +01:00
Thomas Waldmann
55af2933fb
update CHANGES 2023-02-04 20:43:50 +01:00
TW
9b7647c89d
Merge pull request #7309 from ThomasWaldmann/no-part-files-in-final-archive 
remove part files from final archive
 2023-02-03 01:33:47 +01:00
Thomas Waldmann
856d98c72f
document another way to get UTF-8 encoding on stdin/stdout/stderr, fixes #2273 2023-02-01 15:32:29 +01:00
Thomas Waldmann
b92f4aa487
remove --consider-part-files, related stats code, update docs 
we now just treat that one .borg_part file we might have inside
checkpoint archives as a normal file.

people can recognize via the file name it is a partial file.

nobody cares for statistics of checkpoint files and the final
archive now does not contain any partial files any more, thus
no needs to maintain statistics about count and size of part
files.
 2023-02-01 13:04:18 +01:00
Thomas Waldmann
bf667170a7
ArchiveItem.cmdline list-of-str -> .command_line str, fixes #7246 
Same change for .recreate_cmdline -> .recreate_command_line .

JSON output key "command_line":
borg 1.x: sys.argv [list of str]
borg 2: shlex.join(sys.argv) [str]
 2023-01-20 00:19:00 +01:00
Thomas Waldmann
1672aee031
Item: symlinks: rename .source to .target, fixes #7245 
Also, in JSON:
- rename "linktarget" to "target" for symlinks
- remove "source" for symlinks
 2023-01-16 20:28:25 +01:00
TW
9b067fd1f7
Merge pull request #7275 from ThomasWaldmann/docs-key-change-passphrase 
key change-passphrase: fix --encryption value in examples
 2023-01-16 18:18:06 +01:00
Thomas Waldmann
54892f711d
key change-passphrase: fix --encryption value in examples 
"repokey" (as in borg < 2.0, referring to the AES-CTR mode)
does not exist any more and was superseded by other repokey-*
modes.
 2023-01-16 17:58:50 +01:00
Thomas Waldmann
8765e62bcd
document how borg deals with non-unicode bytes in JSON output 2023-01-16 17:45:46 +01:00
Helmut Grohne
e210c6c053 delete left over documentation for borg key change-algorithm 2023-01-13 13:20:49 +01:00
Josh Soref
0958d94791 spelling: vagrant 
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
 2023-01-12 11:24:05 -05:00
Josh Soref
f41cf1c25f spelling: requirements 
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
 2023-01-12 09:36:03 -05:00
Josh Soref
a26c1d99d9 spelling: new 
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
 2023-01-12 09:36:03 -05:00
Josh Soref
6e7f593b98 spelling: healthy 
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
 2023-01-12 09:36:03 -05:00
Thomas Waldmann
43cbe6d8b6
remove BORG_LIBB2_PREFIX (not used any more) 
the code now uses hashlib.blake2b from python stdlib.
 2023-01-10 14:10:34 +01:00
Thomas Waldmann
ac1df899aa
build_man 2023-01-03 00:37:04 +01:00
Thomas Waldmann
b5ff043ac1
build_usage 2023-01-03 00:36:59 +01:00
Thomas Waldmann
36f5e66df0
update CHANGES 2022-12-30 15:46:58 +01:00
Paul D
991b53ebea Misc fixes. 2022-12-29 22:26:55 +00:00
Paul D
949dc51156 Rewrite for quickstart 2022-12-29 22:26:55 +00:00
Paul D
8ada680c87 'Want' fixes 
aka who are you to presume what I want?
 2022-12-29 22:26:55 +00:00
Paul D
253d8e8d4e Docs grammar fixes 
joined split infinitives, and relocated adverbs appropriately.
 2022-12-29 22:26:54 +00:00
Paul D
a85b643866 Docs grammar fixes. 
One cannot "to not x", but one can "not to x".
Avoiding split infinitives gives the added bonus that machine
translation yields better results.

setup (n/adj) vs set(v) up. We don't "I setup it" but "I set it up".

Likewise for login(n/adj) and log(v) in, backup(n/adj) and back(v) up.
 2022-12-29 00:01:48 +00:00
Rayyan Ansari
66a407ff9f Use \n for the {NL} format specifier 
\n is automatically converted on write to the platform-dependent os.linesep.
Using os.linesep instead of \n means that on Windows, the line ending becomes "\r\r\n".
Also switches mentions of {LF} to {NL} in code and docs.
 2022-12-18 14:05:24 +00:00
Thomas Waldmann
af93136ca7
build_man 2022-11-26 22:23:46 +01:00
Thomas Waldmann
4d2eb06ed3
build_usage 2022-11-26 22:23:17 +01:00
Thomas Waldmann
3ab46c5f46
update release date of 2.0.0b4 2022-11-26 22:16:53 +01:00
Thomas Waldmann
82aaef12b0
update CHANGES 2022-11-26 19:35:30 +01:00
Thomas Waldmann
4b446dc146 update CHANGES 2022-10-12 22:49:58 +02:00
TW
16e8213716
Merge pull request #7071 from ThomasWaldmann/misc 
misc updates / fixes
 2022-10-03 21:59:19 +02:00
Thomas Waldmann
4574ae0178 update quickstart docs with --match-archives 2022-10-03 20:30:34 +02:00
Thomas Waldmann
8342f74d5c docs: add rcompress to usage index 2022-10-03 13:50:29 +02:00
Thomas Waldmann
3f159ca3bb build_man / build_usage 2022-10-02 15:51:17 +02:00
Thomas Waldmann
5d8d21df4d rcompress docs / examples / markup fixes 2022-10-02 15:50:41 +02:00
Thomas Waldmann
c6785c8f15 set release date 2022-10-02 15:01:16 +02:00
Thomas Waldmann
fa74247ecb update CHANGES 2022-10-02 14:51:34 +02:00
Thomas Waldmann
9315ecb89e update CHANGES 2022-09-28 15:20:15 +02:00
Thomas Waldmann
e57ff29f22 BORG_LOCK_WAIT=n env var to set default for --lock-wait option, fixes #5279 2022-09-27 17:09:19 +02:00
Thomas Waldmann
18ca2ab3ce build_usage build_man 2022-09-10 18:15:45 +02:00
Thomas Waldmann
c8964e92fd update CHANGES 2022-09-10 18:15:45 +02:00
Thomas Waldmann
057db79b44 update CHANGES 2022-09-10 01:06:42 +02:00
Thomas Waldmann
c8830cde44 update docs 2022-09-08 22:26:23 +02:00
Thomas Waldmann
e078337c7c update CHANGES 2022-08-14 00:08:51 +02:00
TW
c2bcecf2eb
Merge pull request #6942 from mh4ckt3mh4ckt1c4s/doc-shift-odg 
update diagrams to odg format, fixes #6928
 2022-08-09 22:03:09 +02:00
mh4ckt3mh4ckt1c4s
15a450c7e8 Fix transparency level 2022-08-09 21:20:44 +02:00
mh4ckt3mh4ckt1c4s
259d3fdc76 Tiny fix of transparency bug 2022-08-09 19:33:30 +02:00
mh4ckt3mh4ckt1c4s
be9e99e346 Fix size of images to match old ones 2022-08-09 19:21:16 +02:00
mh4ckt3mh4ckt1c4s
3e40f68409 Added the transparency thing to compaction schema 2022-08-09 19:15:09 +02:00
mh4ckt3mh4ckt1c4s
45663552bf Updated compaction to an odg file 2022-08-07 22:13:33 +02:00
Thomas Waldmann
f5b7ae5b30 build_usage build_man 2022-08-07 19:20:34 +02:00
Thomas Waldmann
8148d4e400 fix sphinx warnings 2022-08-07 19:14:03 +02:00
Thomas Waldmann
3556bcb0db set release date 2022-08-07 19:09:06 +02:00
Thomas Waldmann
97ec8a819d update CHANGES 2022-08-07 18:40:20 +02:00
mh4ckt3mh4ckt1c4s
cd27313693 Changed structure schema to odg format 2022-08-07 00:55:22 +02:00
mh4ckt3mh4ckt1c4s
085b244bb7 Removed object-graph.vdg and added 'simplified' mention in schema 2022-08-07 00:25:31 +02:00
Thomas Waldmann
fb74fdb710 massively increase per archive metadata stream size limit, fixes #1473 
implemented by introducing one level of indirection, the limit is now
very high, so it is not practically relevant any more.

we always use the indirection (storing the metadata stream chunk ids list not
directly into the archive item, but into some repo objects referenced by the new
ArchiveItem.item_ptrs list).

thus, the code behaves the same for all archive sizes.
 2022-08-06 19:01:41 +02:00
mh4ckt3mh4ckt1c4s
7ed3fad470 Updated object-graph to an odg file 2022-08-06 11:32:32 +02:00
mh4ckt3mh4ckt1c4s
2c29da2553 Fix duplicate object in borg-data-flow graph 2022-08-06 10:53:13 +02:00
mh4ckt3mh4ckt1c4s
1716502cff Some visual fixes 2022-08-06 02:28:51 +02:00
mh4ckt3mh4ckt1c4s
dcc7fba2e5 Updated borg-data-flow to an odg file 2022-08-06 02:18:38 +02:00
Thomas Waldmann
f621b21ec1 docs: update security.rst 2022-08-03 22:19:28 +02:00
Thomas Waldmann
c7c7690b26 build_man build_usage 2022-08-03 22:19:12 +02:00
Thomas Waldmann
c3345fe423 remove remainders of borg key migrate-to-repokey 2022-08-03 21:48:55 +02:00
Thomas Waldmann
78230dd299 docs: key: fix keyfile mode in example 2022-08-03 18:46:50 +02:00
Thomas Waldmann
bcd7ab3dec docs: rcreate: explain "related repo" 2022-08-03 18:20:10 +02:00
Thomas Waldmann
d5df53732d increase Key.version to 2 
Old borg (< 2.0) can not read/process the new keys that have crypt_key instead of enc_key and enc_hmac_key.
 2022-08-03 12:25:58 +02:00
Thomas Waldmann
89e4a52c56 docs: misc. updates 
- remove outdated stuff
- fix infos for borg 2.0
 2022-08-03 11:35:25 +02:00
Jonas Schäfer
33b846e292 docs: update encryption drawing for new compression bytes 
Since compression type identification has been split into type and
level, the graphic needed a slight update.

Unfortunately, I don't have access to Visio, so I converted this to odg.
 2022-07-30 19:24:26 +02:00
Jonas Schäfer
c8ab490017 docs: provide more details on object layout 
While writing my own out-of-band decoder, I had a hard time figuring out
how to unpack the manifest. From the description, I was only able to
read that the manifest is msgpack'd, but I had not been able to figure
out that it's also going through the same encryption+compression logic
as all other things do.

This should make it a little clearer and provide the necessary
information to understand how the compression works.
 2022-07-30 19:24:26 +02:00
Thomas Waldmann
ad7c7159b2 Merge branch 'master' into borg2 2022-07-27 13:49:50 +02:00
remyabel2
ddb805cd10
docs: add info on man page installation (#6888) 
docs: add info about man page installation, fixes #6661
 2022-07-27 12:48:27 +02:00
Thomas Waldmann
c7e719f209 docs: update archive_progress json description about "finished", see #6570 2022-07-25 13:05:16 +02:00
Thomas Waldmann
dfbf638a5b Merge branch 'master' into borg2 2022-07-23 21:21:41 +02:00
a1346054
160dd877ab
fix typos 2022-07-22 15:51:46 +00:00
Thomas Waldmann
9d6c98d9f9 docs: remove _assert_id() call for new crypto 2022-07-20 14:31:37 +02:00
Thomas Waldmann
357aa5241b build_usage / build_man 2022-07-17 09:23:06 +02:00
Thomas Waldmann
32a7896573 update CHANGES 2022-07-16 23:16:39 +02:00
Thomas Waldmann
47c2672a64 ssh:// URLs: remove support for /~otheruser/, see #6855 
If you used this, just replace it by:

ssh://user@host:port/home/otheruser/
 2022-07-15 16:02:45 +02:00
Thomas Waldmann
55a5c5867a update CHANGES 2022-07-09 15:34:15 +02:00
TW
2418795ed1
Merge pull request #6197 from hexagonrecursion/expect 
Automate asciinema screencasts
 2022-07-06 23:55:23 +02:00
Thomas Waldmann
45b3f6418d update ascinemacasts 2022-07-06 23:46:14 +02:00
Thomas Waldmann
0f5fb7d38d use borg 1.2.1 2022-07-06 23:34:35 +02:00
Andrey Bienkowski
1e83415c51 Screencasts/advanced: start where basic left off 2022-07-06 17:21:31 +02:00
Andrey Bienkowski
5e8e10a53c Screencasts/basic: use sample data 2022-07-06 17:19:10 +02:00
Andrey Bienkowski
6e197f66f5 Screencasts: add wallpaper download urls 
We need some sample data to propoerly demo the backup.

I have selected 30 random wallpapers form wikimedia commons
 2022-07-06 17:19:10 +02:00
Andrey Bienkowski
1c10eabc80 rm advanced.sh 2022-07-06 17:19:10 +02:00
Andrey Bienkowski
1cf184dfda Screencasts/advanced: type slowly 2022-07-06 17:19:10 +02:00
Andrey Bienkowski
828a969174 Screencasts/advanced: do not print "spawn /bin/sh" 2022-07-06 17:19:10 +02:00
Andrey Bienkowski
06a19dd87b Screencasts/advanced: fix the key export example 
The previous example had an incorrect sequence of arguments
in the --qr-html case. I have also updated --paper
for consistency
 2022-07-06 17:19:10 +02:00
Andrey Bienkowski
62d77454b2 Screencasts: do not start screencasts with "exit" 
vagrant is magic: sometimes it decides to type "exit" into stdin
 2022-07-06 17:19:10 +02:00
Andrey Bienkowski
aae1b439e4 Screencasts/install: do not timeout due to slow wget 2022-07-06 17:19:10 +02:00
Andrey Bienkowski
9b9294d940 Screencasts: do not redownload borg 2022-07-06 17:19:10 +02:00
Andrey Bienkowski
3391236d00 Update the screencasts 2022-07-06 17:19:10 +02:00
Andrey Bienkowski
df0e8599de Automate the advanced usage screencast 2022-07-06 17:19:10 +02:00
Andrey Bienkowski
bff922a9ba Screencasts: improve the README 2022-07-06 17:19:10 +02:00
Thomas Waldmann
2e063a9c44 docs: using black for code formatting 2022-07-06 16:35:31 +02:00
Thomas Waldmann
7957af562d blacken all the code 
https://black.readthedocs.io/
 2022-07-06 16:34:38 +02:00
TW
1905f6289d
Merge pull request #6839 from ThomasWaldmann/hlid-docs 
document hlid, fixes #2388
 2022-07-06 14:08:07 +02:00
Thomas Waldmann
5e0c4a8fd4 document hlid, fixes #2388 2022-07-05 22:27:08 +02:00
TW
dbb9f62afd
Merge pull request #6836 from ThomasWaldmann/cleanups 
Cleanups
 2022-07-05 02:46:43 +02:00
Thomas Waldmann
dbb63f874b docs: fix rst literal blocks 2022-07-05 00:38:37 +02:00
Thomas Waldmann
dbe62b8074 docs: replaced tabs by spaces 2022-07-05 00:32:57 +02:00
Thomas Waldmann
5c8a5f111f stop using libdeflate 
borg2's new repo format does not need computing crc32 over big amounts of
(content) data any more (we now use xxh64 for that).

thus, having a quick crc32 implementation via libdeflate is not important
enough any more to rectify having libdeflate as a requirement.
 2022-07-04 20:33:59 +02:00
Thomas Waldmann
6fa8d11ecc build_usage ; build_man 2022-07-04 14:09:19 +02:00
Thomas Waldmann
907ffbecfa update CHANGES 2022-07-04 14:09:19 +02:00
Thomas Waldmann
c7ed985ffd Merge branch 'master' into borg2 2022-07-02 23:28:39 +02:00
Thomas Waldmann
6888d5dcb2 remove -P (aka --prefix) option, fixes #6806 
-a (aka --glob-archives) can be used for same purpose and is more powerful.
 2022-07-02 20:52:41 +02:00
Thomas Waldmann
ea4ed6b98f docs: json progress_percent: some values are optional, fixes #4074 
in the finished == true message, these are missing:
- message
- current / total
- info

This is to be somewhat consistent with #6683 by only providing a
minimal set of values for the finished case.

The finished messages is primarily intended for cleanup purposes,
e.g. clearing the progress display.
 2022-07-01 14:35:44 +02:00
TW
e577ccb094
Merge pull request #6755 from fantasya-pbem/docs/5960_FAQ-quota-size 
[DOCS] #5960 - FAQ: Full quota / full disk
 2022-06-29 14:42:11 +02:00
Thomas Waldmann
0a7baa53c4 docs: fix borg transfer formatting / rendering, fixes #6800 2022-06-26 20:29:10 +02:00
Thomas Waldmann
e2f7087aa8 docs: remove reference to borg upgrade 2022-06-26 20:09:54 +02:00
Thomas Waldmann
9680538a70 fix rendering of list/rlist help 2022-06-26 20:08:38 +02:00
Thomas Waldmann
a98c6ba479 changes: init -> rcreate 2022-06-26 19:59:08 +02:00
Thomas Waldmann
ab25bf8175 build_usage build_man 2022-06-26 13:56:33 +02:00
Thomas Waldmann
20bf97a8a4 CHANGES: set release date, formatting 2022-06-26 13:52:47 +02:00
Thomas Waldmann
3232cb4a7e transfer: add a specific transfer example 2022-06-26 01:22:28 +02:00
Thomas Waldmann
391178e68e update CHANGES 2022-06-26 01:03:58 +02:00
Thomas Waldmann
dbae8e60eb remove borg upgrade 2022-06-26 00:25:44 +02:00
Thomas Waldmann
51cf85e627 build_usage / build_man / doc updates 2022-06-25 21:58:19 +02:00
Thomas Waldmann
7f99aa155e update CHANGES, split changelog by major version 2022-06-25 21:58:19 +02:00
Thalian
036eb97f03 [DOCS] #5960 - FAQ: Full quota / full disk 2022-06-24 17:55:14 +02:00
Thomas Waldmann
e0c64629d1 Merge branch 'master' into borg2 
strange conflicts, automated patches seemed to not have applied correctly.
also had to fix some stuff manually, tests were failing.
 2022-06-23 11:25:01 +02:00
Thomas Waldmann
1393e4f391 remove csize references from docs 2022-06-12 18:01:57 +02:00
targhs
35c031ed2c Correct shell syntax for installation using git 2022-06-12 20:19:31 +05:30
Maltimore
4902398554 [DOCS] Remove unnecessary/dangerous line continuation 2022-06-10 21:21:52 +03:00
Thomas Waldmann
421d4bdfb0 docs: fix bytes -> str in data-structures docs 2022-06-09 17:57:28 +02:00
TW
0e8c9941bb
Merge pull request #6747 from fantasya-pbem/docs/4776_FAW-swapped-targets 
[DOCS] #4776 - FAQ: How to swap backup media
 2022-06-05 18:20:36 +02:00
Thalian
c7c98ca0fd [DOCS] #4776 - FAQ: How to swap backup media 
fixes #4776
 2022-06-05 18:05:16 +02:00
Thomas Waldmann
7634426195 update CHANGES with 1.1.18 changelog 2022-06-05 17:47:41 +02:00
Thalian
b4d3859b9e #6407 - Document Borg 1.2 pattern behavior change 
Make clear that absolute paths always go into the matcher as if they are relative (without leading slash). Adapt all examples accordingly.

fixes #6407
 2022-05-27 14:13:12 +02:00
Thomas Waldmann
61299d23db Revert "Remove scp syntax for locations (#6697)" 
This reverts commit 1b4b84dfd8.
 2022-05-18 17:31:10 +02:00
Thomas Waldmann
6bfdb3f630 refactor hardlink_master processing globally 
borg now has the chunks list in every item with content.
due to the symmetric way how borg now deals with hardlinks using
item.hlid, processing gets much simpler.

but some places where borg deals with other "sources" of hardlinks
still need to do some hardlink management:
borg uses the HardLinkManager there now (which is not much more
than a dict, but keeps documentation at one place and avoids some
code duplication we had before).

item.hlid is computed via hardlink_id function.

support hardlinked symlinks, fixes #2379
as we use item.hlid now to group hardlinks together,
there is no conflict with the item.source usage for
symlink targets any more.

2nd+ hardlinks now add to the files count as did the 1st one.
for borg, now all hardlinks are created equal.
so any hardlink item with chunks now adds to the "file" count.

ItemFormatter: support {hlid} instead of {source} for hardlinks
 2022-05-18 14:20:01 +02:00
Emil M George
1b4b84dfd8
Remove scp syntax for locations (#6697) 
remove scp syntax support from cli and from Location parser, add note about converting scp-style URLs to ssh-style, fixes #6691
 2022-05-15 21:55:19 +02:00
Andrea Gelmini
c79fd61b5c
Fix typos (#6688) 
fix typos

Co-authored-by: Thomas Waldmann <tw@waldmann-edv.de>
 2022-05-15 21:23:48 +02:00
Christopher Klooz
594d83aad5
docs: authentication primitives: improved security and performance infos (master) (#6667) 
docs: authentication primitives: improved security and performance infos
 2022-05-14 22:57:22 +02:00
ReethuVinta
ac4666d7f4
documented workaround for getting help for sub-sub-commands (#6346) 
docs: how to get help for sub-sub-commands
 2022-05-13 18:29:43 +02:00
ReethuVinta
c85bcfd3ad
documented secret key usage against fingerprinting (#6345) 
docs: secret key usage against fingerprinting

Co-authored-by: Thomas Waldmann <tw@waldmann-edv.de>
 2022-05-10 21:18:40 +02:00
Thomas Waldmann
9f09a9e096 docs: mention BORG_FILES_CACHE_SUFFIX as alternative to BORG_FILES_CACHE_TTL, fixes #5602 2022-04-30 20:28:46 +02:00
Thomas Waldmann
c2ad118434 FAQ: add a hint about --debug-topic=files_cache 2022-04-20 13:00:02 +02:00
Thomas Waldmann
0cf97dc6db build_usage 2022-04-17 00:07:12 +02:00
Thomas Waldmann
9f86c375b4 python setup.py build_man 2022-04-14 21:25:12 +02:00
Thomas Waldmann
d7fe23c515 python setup.py build_usage 2022-04-14 21:25:12 +02:00
Thomas Waldmann
801751e44e set 1.3.0a1 release date 
also: cosmetic fixes in changelog
 2022-04-14 21:03:11 +02:00
TW
4c749eac2a
Merge pull request #6595 from ThomasWaldmann/update-changes3 
update CHANGES
 2022-04-14 20:47:48 +02:00
Thomas Waldmann
38a7a48d8e update CHANGES 2022-04-14 20:47:12 +02:00
Thomas Waldmann
c592b20262 use openssl on openbsd, fixes #6474 2022-04-14 19:31:55 +02:00
Thomas Waldmann
18c398e708 virtualisation speed tips 2022-04-13 22:48:27 +02:00
Andrey Andreyevich Bienkowski
08f82ee408
Argon2: documentation and changelog (#6560) 
docs: borg key change-algorithm
docs: borg init --key-algorithm
docs: "this is not a borg repo" can be due to argon2 and old borg
 2022-04-11 11:21:07 +02:00
Thomas Waldmann
83941d0b83 update CHANGES 2022-04-09 20:42:40 +02:00
TW
28fa9e0f0b
Merge pull request #6523 from ThomasWaldmann/pax-borg-item-master 
import/export-tar: --tar-format=BORG: roundtrip ALL item metadata
 2022-04-09 20:22:36 +02:00
Thomas Waldmann
85d4b98a16 docs: updated for repository version 2, PUT2 tag 2022-04-09 18:58:47 +02:00
Thomas Waldmann
6ffd11fc12 update CHANGES (master) 2022-04-08 19:40:20 +02:00
Jonathan Rascher
da07c36d6b
(docs) Recommend umask for passphrase file perms 
The previous sample for creating a ~/.borg-passphrase file creates it first and then chmod's it to 400 permissions. That's probably fine in practice, but means there's a tiny window where the passphrase file is sitting with default permissions (likely world readable, depending on the system umask).

It seems safer to first change the umask to remove all group & world bits (0077) _before_ creating the file. To be polite and avoid messing with the user's previous umask, we do this in a subshell. (Note that umask 0077 leads to a mode of 600 rather than the previous 400, because removing the owner write bit doesn't seem to buy much since the owner can just chmod the file anyway.)
 2022-04-03 00:34:33 -05:00
Thomas Waldmann
e8069a8f80 import/export-tar: --tar-format=BORG: roundtrip ALL item metadata, fixes #5830 
export-tar: just msgpack and b64encode all item metadata and
            put that into a BORG specific PAX header.
            this is *additional* to the standard tar metadata.

import-tar: when detecting the BORG specific PAX header, just get
            all metadata from there (and ignore the standard tar
            metadata).
 2022-04-02 22:25:44 +02:00
Thomas Waldmann
a91dd04d11 docs: usage: add benchmark cpu and key change-location 2022-03-26 23:40:03 +01:00
Thomas Waldmann
359a347fdd docs: update link to ubuntu packages, fixes #6485 2022-03-26 18:06:08 +01:00
Thomas Waldmann
b2ab823fea docs: update cygwin install notes to python 3.9 2022-03-26 17:56:54 +01:00
Thomas Waldmann
07cf06f9e1 docs: add libdeflate requirement to install docs, fixes #6446 
there was no change required due to argon2-cffi, because that will be automatically installed by pip.
 2022-03-26 17:52:46 +01:00
Thomas Waldmann
10cbdcc67e add encryption-aead diagram 2022-03-26 17:05:57 +01:00
Thomas Waldmann
ce247526c2 docs: update borg init examples 2022-03-26 17:05:57 +01:00
Thomas Waldmann
298c5ee539 docs: security infos only applying to legacy encryption 2022-03-26 17:05:57 +01:00
Thomas Waldmann
f4a6ad080b docs: add new AEAD modes to security docs 2022-03-26 17:05:57 +01:00
Michael Bauer
638774761c
use --numeric-ids in pull doc 
replace flag --numeric-owner with --numeric-ids
 2022-03-09 21:43:22 +01:00
Manu
af5103d833 Incorporate feedback by TW 2022-03-09 15:48:57 +04:00
Manu
dd1023df44 Add discussion and note on file attrs. 2022-03-09 14:06:40 +04:00
Thomas Waldmann
37f237d3e0 remove PassphraseKey code and borg key migrate-to-repokey command 
"passphrase" encryption mode repos can not be created since borg 1.0.
back then, users were advised to switch existing repos of that type
to repokey mode using the "borg key migrate-to-repokey" command.
that command is still available in borg 1.0, 1.1 and 1.2, but not
any more in borg >= 1.3.

while we still might see the PassphraseKey.TYPE byte in old repos,
it is handled by the RepoKey code since borg 1.0.
 2022-03-06 15:26:18 +01:00
Thomas Waldmann
cbeef56454 pyupgrade --py38-plus ./**/*.py 2022-02-27 20:11:56 +01:00
Thomas Waldmann
64e7ccd3fc require python >= 3.9, fixes #6315 2022-02-27 18:46:30 +01:00
Thomas Waldmann
80c21b2e23 remove docs of previously bundled blake2 code 2022-02-26 22:22:02 +01:00
Thomas Waldmann
96d93dcf0e do not support bundled 3rd party code any more, fixes #6316 2022-02-26 22:18:12 +01:00
Thomas Waldmann
ecd0865d9c unbundle zstd 3rd party code, see #6316 2022-02-26 21:36:30 +01:00
Thomas Waldmann
7c8f288a18 unbundle lz4 3rd party code, see #6316 2022-02-26 21:35:17 +01:00
Thomas Waldmann
d1d3d1dfa4 crypto: remove support for: OpenSSL < 1.1.1, LibreSSL < 2.7.0 
All these are unsupported since long.

Newer versions of LibreSSL have gained chacha20-poly1305 support,
but still lack aes256-ocb support.
Also they have the HMAC_CTX_new/free api now.

docs: openssl >= 1.1.1 is required now
anything older is out of support anyway.
 2022-02-26 00:55:19 +01:00
Julian Picht
091c48bc37
docs: Clarify on-disk order and size of log entry fields (#6357) 
docs: clarify on-disk order and size of log entry fields

The order of the fields of a log entry on disk is CRC32 first, the docs had the size first.

I tried to make this list similar to the HashIndex struct description.
 2022-02-25 12:53:58 +01:00
Thomas Waldmann
d6756d0070 docs: do not transform --/--- to unicode dashes 2022-02-24 08:44:51 +03:00
Andrey Bienkowski
f225d15093 Update the screencasts 2022-02-20 11:51:17 +03:00
Andrey Bienkowski
ccf48ade3d Screencasts: implement the remoteserver example 2022-02-20 11:51:07 +03:00
Andrey Bienkowski
904897bce1 Screencasts: echo the current borg version 2022-02-20 10:46:32 +03:00
Thomas Waldmann
7265f6adb8 quickstart docs: only borg compact frees disk space 2022-02-19 19:25:16 +01:00
Thomas Waldmann
6641a9629d build_man 2022-02-19 18:48:13 +01:00
Thomas Waldmann
9a8eec6af1 build_usage 2022-02-19 18:47:47 +01:00
Thomas Waldmann
7b36f001f6 fixup: set release date 2022-02-19 18:45:19 +01:00
Thomas Waldmann
0a5b329008 update CHANGES 2022-02-19 18:41:43 +01:00
Andrey Bienkowski
1b633c1ca1 Reimplement screencasts using Vagrant 2022-02-19 13:00:04 +03:00
Thomas Waldmann
ee32c1b63d update CHANGES 2022-02-14 18:55:59 +01:00
Andrey Bienkowski
e3a0b5fde8 Automate the installation asciinema screencast 2022-02-07 20:05:12 +03:00
Thomas Waldmann
634b1e5a1a docs: add borg 1.2 upgrade notes 2022-02-06 21:22:37 +01:00
Thomas Waldmann
ef8aac2e4c build_man 2022-02-05 17:52:25 +01:00
Thomas Waldmann
b430c8d15a build_usage 2022-02-05 17:52:25 +01:00
Thomas Waldmann
fa26d5f7c4 update CHANGES 2022-02-05 17:45:35 +01:00
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