Commit graph

1726 commits

Author SHA1 Message Date
Stephan Herbers
599514a247 add non-root deployment strategy 2024-02-21 12:25:48 +01:00
Thomas Waldmann
9eec58bc18
update CHANGES 2024-02-13 18:03:14 +01:00
Thomas Waldmann
9057c7ba4d
development.rst: fix markup 2024-02-10 17:25:43 +01:00
Thomas Waldmann
79268ec951
docs: how to run the testsuite using the dist package 2024-02-08 17:23:52 +01:00
Thomas Waldmann
acebc0bb70
update CHANGES 2024-02-02 13:59:18 +01:00
Thomas Waldmann
8bf7ad575a
scripts: update docs about make.py 2024-01-30 23:21:04 +01:00
Thomas Waldmann
5b96d5acc3
create: add the slashdot hack, fixes #4685 2024-01-30 14:01:40 +01:00
Thomas Waldmann
e80d922730
requirements are defined in pyproject.toml 2024-01-29 20:44:37 +01:00
Thomas Waldmann
4a65f9c943
docs: do not refer to setup.py installation method
Invoking setup.py is deprecated.
2024-01-29 20:39:02 +01:00
Thomas Waldmann
6e228e371b
scripts/gendocs.py: make it work
remove unused html_write function

gendocs: update developer docs
2024-01-29 20:31:56 +01:00
Thomas Waldmann
bdacc84ceb
build_usage build_man 2024-01-20 19:25:08 +01:00
Thomas Waldmann
1445a2b3ff
update CHANGES 2024-01-20 19:13:40 +01:00
Thomas Waldmann
5d956b9655
add ConnectionBrokenWithHint for BrokenPipeErrors and similar, see #7016
no traceback, but error message and specific exit code.
2024-01-19 18:38:07 +01:00
Thomas Waldmann
45f65f7c57
check_can_create_repository: deal with PermissionErrors, see #7016
borg init calls this. If there is a PermissionError, it is
usually fs permission issue at path or its parent directory.

Don't give a traceback, but rather an error msg and a specific exit code.
2024-01-19 18:13:53 +01:00
Thomas Waldmann
9ec454727d
update CHANGES 2024-01-19 00:54:45 +01:00
TW
319441e75d
Merge pull request #8051 from ThomasWaldmann/corrupted-key-errmsg-1.4
better error msg for corrupted key data, fixes #8016
2024-01-19 00:45:59 +01:00
Thomas Waldmann
dbbccf9451
better error msg for corrupted key data, fixes #8016 2024-01-18 23:59:35 +01:00
Thomas Waldmann
2b7f3adec9
it's 2024 2024-01-18 20:02:56 +01:00
Stephen
e3ba364933
docs: add brew bundle instructions (macOS) 2024-01-14 19:54:30 +01:00
Thomas Waldmann
f6963df380
build_man 2024-01-01 21:16:56 +01:00
Thomas Waldmann
5eaabea647
build_usage 2024-01-01 21:16:30 +01:00
Thomas Waldmann
3426f91241
update release checklist 2024-01-01 21:13:27 +01:00
Thomas Waldmann
520870329f
update CHANGES 2024-01-01 21:11:07 +01:00
Thomas Waldmann
7e2a1c4ea7 update CHANGES 2024-01-01 20:21:15 +01:00
TW
de5bfdbd7a
Merge pull request #7976 from ThomasWaldmann/new-rc-1.4
optional more specific return codes
2024-01-01 19:53:25 +01:00
Thomas Waldmann
649537f951
update CHANGES 2023-12-27 19:22:04 +01:00
Thomas Waldmann
f81c6b5963
update frontends.rst error/warning list 2023-12-27 13:48:58 +01:00
Thomas Waldmann
83bf4d8c7d
raise BackupOSError subclasses 2023-12-27 13:48:52 +01:00
Thomas Waldmann
82f147f63f
add NotFoundWarning 2023-12-27 13:48:49 +01:00
Thomas Waldmann
775b9f5560
extend errorlist script to warnings, update docs 2023-12-27 13:48:41 +01:00
Thomas Waldmann
482ac47ed8
new warnings infrastructure to support modern exit codes
- implement updating exit code based on severity, including modern codes
- extend print_warning with kwargs wc (warning code) and wt (warning type)
- update a global warnings_list with warning_info elements
- create a class hierarchy below BorgWarning class similar to Error class
- diff: change harmless warnings about speed to rc == 0
- delete --force --force: change harmless warnings to rc == 0

Also:

- have BackupRaceConditionError as a more precise subclass of BackupError
2023-12-27 13:47:52 +01:00
Thomas Waldmann
770f4117a5
get rid of some rare error classes, use RTError instead 2023-12-27 13:46:15 +01:00
Thomas Waldmann
f6279eac9d
shorten TAMRequiredError error msg
Users using recently created repos (after borg 1.0.9) or
who followed the upgrade procedure of 1.0.9 or >1.2.4 will
never see this error msg.

So, have it as short as and similar to the ArchiveTAMRequiredError.
2023-12-27 13:46:13 +01:00
Thomas Waldmann
62ad0369ef
update "modern" error RCs (docs and code) 2023-12-27 13:45:48 +01:00
Thomas Waldmann
915e58653b
replace flake8 by ruff 2023-12-25 04:20:15 +01:00
Thomas Waldmann
d9061e9a07
update CHANGES 2023-12-25 02:13:05 +01:00
Thomas Waldmann
6b402896a6
require python >= 3.9, drop py38, fixes #6383 2023-12-24 03:01:21 +01:00
Marc Kohaupt
05fa6fcab2
typo: notes.rst 2023-12-23 18:58:47 +01:00
Thomas Waldmann
49d7e74f97
change log: more infos about #6687 fix 2023-12-23 18:58:20 +01:00
Thomas Waldmann
4c131059bc
build_man 2023-12-02 01:02:03 +01:00
Thomas Waldmann
46c1e01d29
build_usage 2023-12-02 01:01:46 +01:00
Thomas Waldmann
8b70bb36c6
update CHANGES 2023-12-02 00:59:58 +01:00
Sophie Herold
897f88dfaa
docs: Add "check.rebuild_refcounts" message 2023-12-02 00:01:12 +01:00
TW
b2929b4cee
Merge pull request #7952 from ThomasWaldmann/update-changes-1.2
update CHANGES (1.2-maint)
2023-11-29 16:48:38 +01:00
Kevin Yin
bcc8f74b56
Remove period that could be interpreted as part of the command (#7946)
CVE upgrade steps: remove period that could be interpreted as part of the command
2023-11-27 18:12:26 +01:00
Thomas Waldmann
4bdd404949
update CHANGES 2023-11-27 18:08:00 +01:00
zDEFz
2cefe8f53d
Add backup by SERIAL method (#7934)
docs: create disk/partition sector backup by disk serial number
2023-11-13 22:03:09 +01:00
Thomas Waldmann
9c886330d3
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 13:31:02 +01:00
Thomas Waldmann
d9a0deb227
update CHANGES 2023-11-03 18:43:22 +01:00
Thomas Waldmann
6b928dac93
docs: not only attack/unsafe, can also be a fs issue, fixes #7853 2023-11-01 18:04:24 +01:00
Thomas Waldmann
da4fcc5a66
docs: point to CVE-2023-36811 upgrade steps from borg 1.1 to 1.2 upgrade steps, fixes #7899
also: use 1.2.6 to refer to the fixed version

1.2.5 had issues and was superseded by 1.2.6 just 1 day later,
so we do not need to talk about that.

Also, the docs point out that:
"""
Below, if we speak of borg 1.2.6, we mean a borg version >= 1.2.6 **or** a
borg version that has the relevant security patches for this vulnerability applied
(could be also an older version in that case).
"""

So, it now just talks about "1.2.6" at the relevant places.
2023-11-01 18:04:22 +01:00
Thomas Waldmann
136e3ed1d6
docs: upgrade steps needed for all kinds of repos, fixes #7813
Repos with encryption=none of course can not do real authentication (because there is no secret key material to work with).

But the code always works the same way and such repos also use (and expect) TAMs, so the instructions should be followed in any case.
2023-11-01 18:04:20 +01:00
Thomas Waldmann
a19ebe5ecc
docs: consequences of borg check, fixes #7816 2023-11-01 17:18:32 +01:00
TW
fa7a6d7095
Merge pull request #7890 from ThomasWaldmann/doc-updates-1.2
doc updates (1.2-maint)
2023-10-27 22:25:59 +02:00
Thomas Waldmann
05cec8b3b0
docs: OS X -> macOS 2023-10-27 20:31:26 +02:00
Thomas Waldmann
7a4d53c2f5
docs: update macOS hint about full disk access 2023-10-27 20:28:57 +02:00
Thomas Waldmann
661e5cccd3
docs: minor fixes/update to notes 2023-10-27 20:27:51 +02:00
Thomas Waldmann
d13b5d5557
docs: remove info about borg 1.0 files per dir 2023-10-27 20:26:27 +02:00
Thomas Waldmann
e0f80812a5
docs: no signature upload on pypi any more
but we upload it on github releases,
so people can check it.
2023-10-27 20:25:29 +02:00
Thomas Waldmann
7640973d6b
docs: CI only on github actions now 2023-10-27 20:23:00 +02:00
azrdev
69d71d99bf
automated-local.rst: Partition table UUID match works for MBR too
not only GPT
2023-10-27 20:15:05 +02:00
azrdev
b61a565fbc
automated-local.rst: use GPT UUID for consistent udev rule 2023-10-27 20:14:50 +02:00
Thomas Waldmann
5195fb2dcf
update CHANGES 2023-09-25 17:07:28 +02:00
Thomas Waldmann
97b8eb2104
docs: minor fix to CVE-2023-36811 related upgrade instructions
while the main issue in the code has been fixed since 1.2.5,
let's better refer to 1.2.6, which has fixes in upgrade docs and code.
2023-09-02 15:47:13 +02:00
Thomas Waldmann
c133303243
update CHANGES, incl. upgrade instructions 2023-08-31 01:02:44 +02:00
Thomas Waldmann
d05d02f238
implement BORG_WORKAROUNDS=ignore_invalid_archive_tam, see #7791 2023-08-31 00:36:04 +02:00
Thomas Waldmann
447d0df1bb
fix changelog markup 2023-08-30 18:36:42 +02:00
Thomas Waldmann
ee33c22443
fix CVE timeline 2023-08-30 14:39:41 +02:00
Thomas Waldmann
509a5fd71c
build_usage / build_man 2023-08-30 03:49:47 +02:00
Thomas Waldmann
ed1ab84cc7
update CHANGES 2023-08-30 03:47:35 +02:00
Thomas Waldmann
9e63abb679
document vulnerability, repo upgrade procedure 2023-08-30 02:52:34 +02:00
Thomas Waldmann
62ca4f666b
build_man / build_usage 2023-08-29 18:48:41 +02:00
Thomas Waldmann
7f07f81e39
update CHANGES 2023-08-29 18:24:56 +02:00
Thomas Waldmann
276781081b
docs: fix borg init command in environment.rst.inc
It mentioned borg rcreate due to a bad backport from master.
Must be borg init in borg 1.2.x.
2023-08-24 11:49:17 +02:00
Thomas Waldmann
dedbd38844
1.1.x upgrade notes: more precise borg upgrade instructions, fixes #3396 2023-07-22 18:08:35 +02:00
Thomas Waldmann
b419b6ad03
build_man / build_usage 2023-07-20 18:57:22 +02:00
Thomas Waldmann
65a2fe8502
update CHANGES 2023-07-20 18:54:55 +02:00
TW
4721a35863
Merge pull request #7702 from ThomasWaldmann/authenticated-no-key-1.2
BORG_WORKAROUNDS=authenticated_no_key, fixes #7700
2023-07-07 01:02:41 +02:00
TW
e5cc2e16e3
Merge pull request #7709 from TimWolla/backport-doc-keep-within
Backport: Improve the documentation for `--keep-within`
2023-07-04 14:11:55 +02:00
Tim Düsterhus
b58c6ce3b1 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

(cherry picked from commit a6f452a050)
2023-07-04 09:16:39 +02:00
Thomas Waldmann
ae7fd9b101
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-03 18:40:52 +02:00
Thomas Waldmann
8ac7178ab9
BORG_WORKAROUNDS=authenticated_no_key to extract from authenticated repos without key, fixes #7700 2023-07-03 15:38:21 +02:00
Thomas Waldmann
d01852c100
update CHANGES 2023-07-01 14:49:28 +02:00
Thomas Waldmann
6d9e8e5483
docs: move upgrade notes to own section, see #7546 2023-07-01 14:43:44 +02:00
Thomas Waldmann
55af769b71
mount -olocal: how to show mount in finder's sidebar, fixes #5321 2023-07-01 14:43:35 +02:00
Thomas Waldmann
893530fdac
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-27 21:00:05 +02:00
Sasha Boginsky
5b5e9282e3 Remove black formatting from cherry-pick 2023-05-07 18:52:42 -04:00
Michael Deyaso
9e7b20660b Installed and configured pre-commit to lint and format code. Fixes #7476
(cherry picked from commit 98d1c65b40)
2023-05-05 23:51:09 -04:00
Thomas Waldmann
35d76f9a64
build_man 2023-03-23 22:11:46 +01:00
Thomas Waldmann
0d14f3b36f
build_usage 2023-03-23 22:11:45 +01:00
Thomas Waldmann
b81b1abdeb
it's 2023! 2023-03-23 22:11:44 +01:00
Thomas Waldmann
391e05a6c6
change log: set release date, remove outdated stuff 2023-03-23 22:11:41 +01:00
Thomas Waldmann
af16e19933
update CHANGES 2023-03-23 22:10:22 +01:00
Thomas Waldmann
e6b8e03e19
BORG_KEY_FILE: clarify docs, fixes #7444 2023-03-22 18:52:58 +01:00
Thomas Waldmann
3cffbbd3af
update CHANGES 2023-03-20 22:10:49 +01:00
TW
0a61c7b767
Merge pull request #7428 from ThomasWaldmann/update-changes-1.2
update CHANGES (1.2-maint)
2023-03-11 19:17:52 +01:00
Thomas Waldmann
f2825a96d2
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:52:58 +01:00
abebeos
9e464edb7c docs: installation: add link to OS dependencies 2023-03-10 22:39:30 +00:00
Thomas Waldmann
cd35e22d06
update CHANGES 2023-03-10 22:46:10 +01:00
Thomas Waldmann
e8573193e4
update FAQ about locale/unicode issues, fixes #6999 2023-03-04 16:32:48 +01:00
Andreas Vögele
007b73ac67 Installation: Update Fedora in distribution list
Fixes #7357
2023-02-17 14:45:17 +01:00
Thomas Waldmann
47e0f9bcb0
remove BORG_LIBB2_PREFIX (not used any more)
the code now uses hashlib.blake2b from python stdlib.
2023-01-10 14:09:28 +01:00
Thomas Waldmann
795a553675
build_man 2022-12-24 18:09:33 +01:00
Thomas Waldmann
ec49d60d1f
build_usage 2022-12-24 18:09:32 +01:00
Thomas Waldmann
e4cbd28bdd
update CHANGES 2022-12-24 18:09:30 +01:00
Thomas Waldmann
90a937e1ed
remove deprecated --prefix from docs, fixes #7109
also:

- rather mention --glob-archives
- rather test --glob-archives
2022-12-24 14:44:05 +01:00
Thomas Waldmann
9c8ac57399
update CHANGES 2022-12-17 18:04:03 +01:00
Emmanuel Tanimowo
f49133da04
update automating backups script (#7039)
update "automating backups" script: remove last backslash, use --glob-archives
2022-09-21 00:54:38 +02:00
Thomas Waldmann
e87c54a0a1 update CHANGES 2022-08-20 15:38:10 +02:00
Thomas Waldmann
92ca260fd8 build_usage ; build_man 2022-08-20 15:38:10 +02:00
Thomas Waldmann
b024379904 fix sphinx warnings 2022-08-20 15:38:10 +02:00
Thomas Waldmann
c4e552a1e5 update CHANGES 2022-08-06 10:41:58 +02:00
TW
4b54cfef45
Merge pull request #6914 from ThomasWaldmann/update-changes-1.2
update CHANGES
2022-07-30 18:32:58 +02:00
Thomas Waldmann
fe27be9f3e update CHANGES 2022-07-30 17:57:57 +02:00
TW
ade2241163
Merge pull request #6911 from horazont/docs/internal-details-1.2
docs(1.2): provide more details on object layout
2022-07-30 17:43:27 +02:00
Jonas Schäfer
bd89fb717e 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 17:32:36 +02:00
Thomas Waldmann
e7bd9e8442 update CHANGES 2022-07-29 11:48:18 +02:00
remyabel2
c56025000b
docs: add info on man page installation (#6894) 2022-07-27 13:46:48 +02:00
Thomas Waldmann
404fe33a8d docs: update archive_progress json description about "finished", see #6570 2022-07-25 13:06:06 +02:00
TW
8a42d88120 Merge pull request #6197 from hexagonrecursion/expect
Automate asciinema screencasts
2022-07-07 00:01:28 +02:00
Thomas Waldmann
bfae252593 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:31:23 +02:00
Thalian
6990aca7ac [DOCS] #5960 - FAQ: Full quota / full disk
Backport from master.
2022-06-29 17:56:23 +02:00
targhs
08629e4d83 Commit shell syntax for installation using git 2022-06-12 22:37:37 +05:30
Thomas Waldmann
9fad4ba1cb build_man 2022-06-05 20:14:26 +02:00
Thomas Waldmann
a7c1c1cb16 build_usage 2022-06-05 20:13:46 +02:00
Thomas Waldmann
6c0842ec42 update CHANGES 2022-06-05 20:09:06 +02:00
TW
7475e661bf
Merge pull request #6751 from ThomasWaldmann/update-changes-1.2
update CHANGES (1.2)
2022-06-05 18:36:37 +02:00
TW
eeb55c10c4
Merge pull request #6749 from fantasya-pbem/docs/4776_FAQ_swapped-targets_main
[DOCS] #4776 - FAQ: How to swap backup media
2022-06-05 18:33:50 +02:00
Thalian
cfcf99ccb5 [DOCS] #4776 - FAQ: How to swap backup media
Backport from master.
2022-06-05 18:22:23 +02:00
Thomas Waldmann
4ae08ee972 update CHANGES 2022-06-05 18:18:49 +02:00
Thomas Waldmann
677db66e9d update CHANGES with 1.1.18 changelog 2022-06-05 17:45:48 +02:00
Thomas Waldmann
b55bb4694d update CHANGES 2022-05-27 17:12:56 +02:00
Thalian
2694652e37 #6407 - Document Borg 1.2 pattern behavior change
Backport from master: Make clear that absolute paths always go into the matcher as if they are relative (without leading slash). Adapt all examples accordingly.
2022-05-27 15:14:01 +02:00
Andrea Gelmini
f4d7c32058 Fix typos (#6688)
fix typos

Co-authored-by: Thomas Waldmann <tw@waldmann-edv.de>
2022-05-15 23:43:50 +02:00
Christopher Klooz
c3bbb5e57a
docs: authentication primitives: improved security and performance infos (1.2) (#6692)
docs: authentication primitives: improved security and performance infos
2022-05-14 22:56:39 +02:00
Thomas Waldmann
6d6711768e docs: mention BORG_FILES_CACHE_SUFFIX as alternative to BORG_FILES_CACHE_TTL, fixes #5602 2022-05-07 18:47:41 +02:00
Andrey Bienkowski
622ec1a181 Add a troubleshooting note to the FAQ 2022-04-24 11:27:37 +03:00
Thomas Waldmann
56262b57bd FAQ: add a hint about --debug-topic=files_cache 2022-04-20 13:00:34 +02:00
TW
d6f7056d9d
Merge pull request #6589 from ThomasWaldmann/docs-virt-1.2
virtualisation speed tips
2022-04-13 23:24:59 +02:00
Thomas Waldmann
08ed786f6d virtualisation speed tips 2022-04-13 23:08:39 +02:00
Thomas Waldmann
bb6188da49 docs: fix values of TAG bytes, fixes #6515 2022-04-12 17:58:13 +02:00
Jonathan Rascher
4b58dafd31 (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-09 23:58:45 -05:00
Thomas Waldmann
c14bc52189 docs: update link to ubuntu packages, fixes #6485 2022-03-26 18:07:03 +01:00
Michael Bauer
1345f06f2b use --numeric-ids in pull doc
replace flag --numeric-owner with --numeric-ids
2022-03-10 08:34:27 +03:00
Thomas Waldmann
c4ed840c7b pyupgrade --py38-plus ./**/*.py 2022-02-27 21:12:44 +01:00
Thomas Waldmann
51a676cc6f remove blake2 docs, blake2 code not bundled any more, fixes #6371 2022-02-27 14:43:27 +01:00
Julian Picht
e49a1b5d9b 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 15:03:21 +03:00
Thomas Waldmann
f5116a7e67 docs: do not transform --/--- to unicode dashes 2022-02-23 20:08:27 +01: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
Thomas Waldmann
ee32c1b63d update CHANGES 2022-02-14 18:55:59 +01: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
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