mirror/borg
1
0
Fork 0
mirror of https://github.com/borgbackup/borg.git synced 2024-12-26 17:57:59 +00:00
Code Issues Releases Wiki Activity
8910 commits 9 branches 139 tags 61 MiB
Commit graph

1796 commits

Author SHA1 Message Date
Thomas Waldmann
b64f6e3335
scripts/gendocs.py: make it work 
remove unused html_write function

gendocs: update developer docs
 2024-02-09 17:37:38 +01:00
Thomas Waldmann
33393946b5
docs: how to run the testsuite using the dist package 2024-02-09 00:36:58 +01:00
Thomas Waldmann
25adac4fb4
update CHANGES 2024-02-08 23:28:22 +01:00
Thomas Waldmann
576ee3532c
docs: fix markup errors 2024-01-14 17:27:21 +01:00
Stephen
438f1ddef7
docs: add brew bundle instructions (macOS) 2024-01-14 17:14:42 +01:00
ebabcock93
73a416830a
docs: add typical PR workflow to development docs, fixes #7495 (#7656) 2024-01-10 00:56:18 +01:00
TW
812eb352f6
Merge pull request #7955 from ThomasWaldmann/improve-session-key-gen-master 
crypto: use a one-step kdf for session keys, fixes #7953
 2024-01-04 18:42:22 +01:00
AJ Jordan
f3ae0467b5
Fix typo 2023-12-17 01:13:43 -05:00
Thomas Waldmann
74c34ba7c6
docs: update security docs about new one-step KDF 2023-12-02 20:35:16 +01:00
Thomas Waldmann
0f074fa2b6
add 1.2.7 changes 2023-12-02 18:01:00 +01:00
Thomas Waldmann
fe17ce2bba
fix typos 
Thanks go to:
Author: Andrea Gelmini <andrea.gelmini@gelma.net>
 2023-12-01 21:58:26 +01:00
Kevin Yin
4f92f9462e
Port changes to master 2023-11-23 07:48:26 -08:00
zDEFz
c4decb4fff
make SERIAL backup method compatible to borg2 2023-11-13 20:23:52 +01:00
zDEFz
6bbd327dc2
Added backup by serial method documentation (#7932) 
docs: create disk/partition sector backup by disk serial number
 2023-11-13 13:45:19 +01:00
Sophie Herold
cdc6154200 docs: Add "check.rebuild_refcounts" message 2023-11-09 21:32:01 +01:00
Thomas Waldmann
62114466e4
CVE-2023-36811 upgrade docs: consider checkpoint archives, fixes #7802 
The traceback seen there came from borg not showing a .checkpoint archive
that didn't have a valid TAM and thus the user not see it / fix it:

https://github.com/borgbackup/borg/issues/7802#issuecomment-1793860606
 2023-11-06 14:34:15 +01:00
Thomas Waldmann
613fdcd6fa
copy 1.2.x changelog notes from 1.2-maint 2023-11-05 17:48:30 +01:00
Thomas Waldmann
8f7f836eff
copy 1.x upgrade notes from 1.2-maint 2023-11-05 17:46:14 +01:00
Thomas Waldmann
774c899b7e
update 1.x change log, cve notes 
fixes #7816
fixes #7813
 2023-11-05 17:43:24 +01:00
Thomas Waldmann
4325656f4c
docs: not only attack/unsafe, can also be a fs issue, fixes #7853 2023-11-05 17:36:31 +01:00
Łukasz Stelmach
c68a158ffb linux: use pkgconfig to find libacl 
Using pkgconfig gives a more meaningful error message in case libacl
development files are missing.
 2023-10-24 15:00:21 +02:00
Marc Kohaupt
a6b016f894
feat(docs): use virtualenv on Cygwin 
Hint for Cygwin users to make sure they use a virtual environment.
Not using a virtual environment will be likely troublesome if there is already a Python installed on Windows.
 2023-10-09 12:35:33 +02:00
Thomas Waldmann
bd1d734591
docs: removed TAMs, introduce typed repo objects 2023-09-24 20:11:00 +02:00
Thomas Waldmann
3f75950226
build_usage / build_man 2023-09-14 15:52:08 +02:00
Thomas Waldmann
7e15b6488a
update CHANGES 2023-09-14 15:48:18 +02:00
Thomas Waldmann
c883181609
update CHANGES 
also:: add a note about required TAMs.
 2023-09-05 13:50:59 +02:00
Thomas Waldmann
98796a2f0d
replace flake8 by ruff 2023-09-04 22:15:42 +02:00
Thomas Waldmann
aaafc36d97
update upgrade instruction in changes_1.x.rst 2023-09-03 17:27:44 +02:00
Thomas Waldmann
f334ef1b4d
fix CVE timeline, fix markup 2023-08-30 15:58:12 +02:00
Thomas Waldmann
449cd51b73
document vulnerability, repo upgrade procedure 2023-08-30 02:32:50 +02:00
Thomas Waldmann
760d01ee0c
update CHANGES 2023-08-27 20:41:40 +02:00
Thomas Waldmann
e9e74a1113
docs: fix borg delete examples, fixes #7759 2023-08-26 14:51:27 +02:00
Thomas Waldmann
3051473168
BORG_WORKAROUNDS=authenticated_no_key to extract from authenticated repos without key, fixes #7700 2023-07-20 17:17:28 +02:00
TW
56dfc6dc04
Merge pull request #7567 from azrdev/patch-1 
automated-local.rst: use GPT UUID for consistent udev rule
 2023-07-11 00:06:25 +02:00
Thomas Waldmann
8db8fd601b
docs: OS X -> macOS 2023-07-04 23:59:44 +02:00
Thomas Waldmann
be731334c3
docs: update macOS hint about full disk access 2023-07-04 23:55:06 +02:00
Thomas Waldmann
96c3c90230
docs: remove hint about item_keys in manifest 2023-07-04 23:46:53 +02:00
Thomas Waldmann
ddd93c5828
docs: remove --chunker-params hint to borg < 1.0 2023-07-04 23:41:17 +02:00
Thomas Waldmann
89cfd083ba
docs: minor fixes/update to notes 2023-07-04 23:36:41 +02:00
Thomas Waldmann
84b1ad6948
docs: remove info about borg 1.0 files per dir 2023-07-04 23:32:36 +02:00
Thomas Waldmann
5fb4cc3b4b
docs: no signature upload on pypi any more 
but we upload it on github releases,
so people can check it.
 2023-07-04 20:20:35 +02:00
Thomas Waldmann
15781efab3
docs: CI only on github actions now 2023-07-04 20:11:26 +02:00
Thomas Waldmann
80188d3bdf
remove coala (outdated) 
last coala release (0.11.0) is now over 6y old.

when using pip install coala, a ton of stuff gets installed (expected)
and a part of that downgrades some stuff we use to outdated, incompatible
versions.

when trying to run coala with python 3.11, it just crashes because the
last release was made for py35/py36 (as seen in their setup.py).

a lot of PRs and tickets pile up at the coala project on github,
but noone is maintaining it.
 2023-07-02 17:25:51 +02:00
Thomas Waldmann
e142776040
update CHANGES 2023-07-01 16:42:15 +02:00
Thomas Waldmann
53991f2e51
move upgrade / compat. notes to own section, see #7546 2023-07-01 16:28:17 +02:00
Thomas Waldmann
deed47824f
mount -olocal: how to show mount in finder's sidebar, fixes #5321 2023-07-01 16:07:31 +02:00
Tim Düsterhus
a6f452a050 Improve the documentation for --keep-within 
Move the explanation below the general explanation of the `--keep-*` option
behavior rephrase the last sentence to make it clear that it works like the
other options that were explained in the previous paragraph.

Resolves #7687
 2023-06-30 15:23:07 +02:00
Thomas Waldmann
81c3cb957e
list: fix --pattern examples, fixes #7611 
- pattern needs to start with + - !
- first match wins
- the default is to list everything, thus a 2nd pattern
  is needed to exclude everything not matched by 1st pattern.
 2023-06-29 23:04:21 +02:00
azrdev
27bcc0f05a
automated-local.rst: Partition table UUID match works for MBR too 
not only GPT
 2023-06-16 23:28:36 +02:00
Thomas Waldmann
4dca508848
build_man 2023-06-11 23:10:23 +02:00
Thomas Waldmann
70602bda52
build_usage 2023-06-11 23:09:20 +02:00
Thomas Waldmann
fbf463496b
docs: fix some markup / linking issues 2023-06-11 23:03:21 +02:00
Thomas Waldmann
82f180b3c4
update CHANGES, set release date 2023-06-11 22:53:11 +02:00
Thomas Waldmann
a347e01919
update CHANGES 2023-06-10 14:53:29 +02:00
Thomas Waldmann
57250d0c4b
update CHANGES 2023-06-07 17:46:02 +02:00
Thomas Waldmann
7878a34fd4
add get_runtime_dir / BORG_RUNTIME_DIR, tests, docs 2023-06-06 11:58:48 +02:00
Thomas Waldmann
989017a222
update CHANGES 2023-05-19 22:05:18 +02:00
Thomas Waldmann
c8996aaf12
BORG_DATA_DIR / BORG_SECURITY_DIR docs update 2023-05-18 12:48:47 +02:00
Thomas Waldmann
8e6c504654
docs: fix some -a / --match-archives issues 
at some places, the docs were not updated yet.

for borg 1.x, -a (aka --glob-archives) expected
sh: style glob patterns ONLY (but one must not
give sh: explicitly).

for borg 2, -a (aka --match-archives) defaults
to id: style (identical match), so one must give
sh: if one wants shell-style globbing.
 2023-05-16 00:50:50 +02:00
azrdev
843496dac9
automated-local.rst: use GPT UUID for consistent udev rule 2023-05-14 14:52:39 +02:00
Thomas Waldmann
7c7501acd8
update CHANGES 2023-05-10 20:50:36 +02:00
TW
e302fd9da6
Merge pull request #7488 from centic9/master 
Describe performing pull-backups via ssh remote forwarding
 2023-04-18 18:34:46 +02:00
Thomas Waldmann
9f4f2b42e3
implement BORG_<CMD>_FORMAT env vars, fixes #5166 
for now for: prune, list, rlist.
 2023-04-08 00:53:53 +02:00
Thomas Waldmann
7395e4684d
update CHANGES 2023-04-06 21:11:38 +02:00
Dominik Stadler
753419d506 Suggest to use forced command when using remote-fowarding via ssh 2023-04-02 22:58:37 +02:00
Dominik Stadler
d2ff0a3aab Adjust description some more, use back-quotes properly, add some links 2023-04-02 11:15:21 +02:00
Dominik Stadler
6ab281875e Adjust repository path 2023-04-02 11:05:31 +02:00
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