1
0
Fork 0
mirror of https://github.com/borgbackup/borg.git synced 2025-01-03 13:45:31 +00:00
Commit graph

1782 commits

Author SHA1 Message Date
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