changes.rst 53 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325
  1. .. _important_notes:
  2. Important notes 2.x
  3. ===================
  4. This section provides information about security and corruption issues.
  5. (nothing to see here yet)
  6. .. _upgradenotes2:
  7. Upgrade Notes
  8. =============
  9. borg 1.2.x/1.4.x to borg 2.0
  10. ----------------------------
  11. Compatibility notes:
  12. - This is a major "breaking" release that is not compatible with existing repositories.
  13. We tried to put all the necessary "breaking" changes into this release, so we
  14. hopefully do not need another breaking release in the near future. The changes
  15. were necessary for improved security, improved speed and parallelism,
  16. unblocking future improvements, getting rid of legacy crap and design
  17. limitations, having less and simpler code to maintain.
  18. You can use "borg transfer" to transfer archives from borg 1.2/1.4 repos to
  19. a new borg 2.0 repo, but it will need some time and space.
  20. Before using "borg transfer", you must have upgraded to borg >= 1.2.6 (or
  21. another borg version that was patched to fix CVE-2023-36811) and
  22. you must have followed the upgrade instructions at top of the change log
  23. relating to manifest and archive TAMs (borg2 just requires these TAMs now).
  24. - Command-line syntax was changed; scripts and wrappers will need changes:
  25. - You will usually either export BORG_REPO=<MYREPO> into your environment or
  26. call borg like: "borg -r <MYREPO> <COMMAND>".
  27. In the docs, we usually omit "-r ..." for brevity.
  28. - The scp-style REPO syntax was removed; please use ssh://..., #6697
  29. - ssh:// URLs: Removed support for /~otheruser/, /~/ and /./, #6855.
  30. New format:
  31. - ssh://user@host:port/relative/path
  32. - ssh://user@host:port//absolute/path
  33. - -P / --prefix option was removed; please use the similar -a / --match-archives.
  34. - Archive names don't need to be unique anymore. To the contrary:
  35. It is now strongly recommended to use the identical name for borg create
  36. within the same series of archives to make borg work more efficiently.
  37. The name now identifies a series of archives; to identify a single archive,
  38. please use aid:<archive-hash-prefix>, e.g., borg delete aid:d34db33f
  39. - In case you do NOT want to adopt the "series name" way of naming archives
  40. (like "myarchive") as we recommend, but keep using always-changing names
  41. (like "myserver-myarchive-20241231"), you can do that, but then you must
  42. make use of BORG_FILES_CACHE_SUFFIX and either set it to a constant suffix
  43. (like "all") or to a unique suffix per archive series (like
  44. "myserver-myarchive") so that borg can find the correct files cache.
  45. For the "all" variant, you must also set BORG_FILES_CACHE_TTL to a value
  46. greater than the count of different archives series you write to that repo.
  47. Usually borg uses a different files cache suffix per archive (series) name
  48. and defaults to BORG_FILES_CACHE_TTL=2 because that is sufficient for that.
  49. - The archive ID is always given separately from the repository.
  50. Unlike in borg 1.x, you must not give repo::archive.
  51. - The series name or archive ID is either given as a positional parameter,
  52. like:
  53. - borg create documents ~/Documents
  54. - borg diff aid:deadbeef aid:d34db33f
  55. - or, if the command makes sense for an arbitrary amount of archives, archives
  56. can be selected using a glob pattern, like:
  57. - borg delete -a 'sh:myarchive-2024-??-??'
  58. - borg recreate -a 'sh:myarchive-2024-??-??'
  59. - some borg 1.x commands that supported working on a repo AND on an archive
  60. were split into 2 commands, some others were renamed:
  61. - borg 2 repo commands:
  62. - borg repo-create # was: borg init
  63. - borg repo-list
  64. - borg repo-info
  65. - borg repo-delete
  66. - borg repo-compress
  67. - borg repo-space
  68. - borg 2 archive commands:
  69. - borg create NAME ...
  70. - borg list ID
  71. - borg extract ID ...
  72. - borg diff ID1 ID2
  73. - borg rename ID NEWNAME
  74. - borg info ID
  75. - borg delete ID
  76. - borg recreate ID ...
  77. - borg mount -a ID mountpoint ...
  78. For more details, please consult the docs or --help option output.
  79. - create/recreate/import-tar --timestamp: defaults to local timezone
  80. now (was: UTC)
  81. - some deprecated options were removed:
  82. - removed --remote-ratelimit (use --upload-ratelimit)
  83. - removed --numeric-owner (use --numeric-ids)
  84. - removed --nobsdflags (use --noflags)
  85. - removed --noatime (default now, see also --atime)
  86. - removed --save-space option (does not change behaviour)
  87. - removed --bypass-lock option
  88. - removed borg config command (only worked locally anyway)
  89. - compact command now requires access to the borg key if the repo is encrypted
  90. or authenticated
  91. - using --list together with --progress is now disallowed (except with --log-json), #7219
  92. - the --glob-archives option was renamed to --match-archives (the short option
  93. name -a is unchanged) and extended to support different pattern styles:
  94. - id: for identical string match (this is the new default!)
  95. - sh: for shell pattern / globbing match (this was used by --glob-archives)
  96. - re: for regular expression match
  97. So you might need to edit your scripts like e.g.::
  98. borg 1.x: --glob-archives 'myserver-2024-*'
  99. borg 2.0: --match-archives 'sh:myserver-2024-*'
  100. - use platformdirs 3.x.x instead of home-grown code. Due to that:
  101. - XDG_*_HOME is not honoured on macOS and on Windows.
  102. - BORG_BASE_DIR can still be used to enforce some base dir + .config/ or .cache/.
  103. - the default macOS config and cache dir will now be in ~/Library/Application Support/borg/.
  104. - create: different included/excluded status chars, #7321
  105. - dry-run: now uses "+" (was: "-") and "-" (was: "x") for included/excluded status
  106. - non-dry-run: now uses "-" (was: "x") for excluded files
  107. Option --filter=... might need an update, if you filter for the status chars
  108. that were changed.
  109. - borg is now more strict and disallows giving some options multiple times -
  110. if that makes no sense. Highlander options, see #6269. That might make scripts
  111. fail now that somehow "worked" before (but maybe didn't work as intended due to
  112. the contradicting options).
  113. .. _changelog:
  114. Change Log 2.x
  115. ==============
  116. Version 2.0.0b20 (not released yet)
  117. -----------------------------------
  118. Please note:
  119. Beta releases are only for testing on NEW repos - do not use for production.
  120. For upgrade and compatibility hints, please also read the section "Upgrade Notes"
  121. above.
  122. New features:
  123. - fat binary builds on GitHub (see assets on the GitHub releases page):
  124. - for Linux with glibc 2.35+ (Intel/AMD and ARM64)
  125. - for macOS 14+ (Apple Silicon/ARM64) and macOS 13+ (Intel)
  126. - export-tar/import-tar: support for POSIX ACLs (PAX format)
  127. - list --format: add "inode" placeholder
  128. - improved tty-less progress reporting (--progress), #9055
  129. - BORG_MSGPACK_VERSION_CHECK=no to optionally disable the msgpack version
  130. check; default is "yes", use at your own risk, #9109.
  131. Fixes:
  132. - transfer: fix borg transfer corrupting the source repo index, #9022
  133. - legacyrepository: remove auto_recover, #9022
  134. - fix reading borg 1.x repo index, #9022
  135. - enable S3 support of borgstore
  136. - mount --show-rc: display main process return code (rc), #8308
  137. - create: add exception handler for NODUMP-excluded directories, #9032
  138. Other changes:
  139. - support Python 3.14, msgpack 1.1.2, use Cython 3.1.4
  140. - require setuptools>=78.1.1, #9042
  141. - Brewfile: use openssl@3
  142. - GitHub Actions: use korthout/backport-action
  143. - tests:
  144. - add fuzzing tests for chunkers
  145. - add tests for diff output of archives with hard links
  146. - read_only CM: skip test if cmd_immutable is unsuccessful, fixes #9021
  147. - save space in test_create_* tests
  148. - CI/tests: add SFTP/rclone/S3 repo testing
  149. - CI: add local servers for S3 and SFTP testing
  150. - transfer: add test for unexpected src repo index change, #9022
  151. - pyproject.toml: correctly define test environments for FUSE testing
  152. - Vagrant:
  153. - add Debian testing/Trixie box
  154. - drop macOS 10.12 box
  155. - use Python 3.13.8 for binary building and tests
  156. - use PyInstaller 6.14.2 for binary building
  157. - docs:
  158. - update README for binaries
  159. - improve borg help patterns, #7144
  160. - patterns: clarify scope of default pattern style, #9004
  161. - extract: document how to use wildcards in PATHs, #8589
  162. - how to debug borg mount, #5461
  163. - document what happens when a new keyfile repo is created at the same path, #6230
  164. - update install docs to include `SETUPTOOLS_SCM_PRETEND_VERSION`
  165. - add Arch Linux to the 'Installing from source' docs
  166. - add systemd-inhibit and examples, #8989
  167. - code/docs: fix typos and grammar
  168. Version 2.0.0b19 (2025-07-02)
  169. -----------------------------
  170. Fixes:
  171. - reader: fix corruption issue "forgetting" all-zero bytestrings, #8963
  172. - import-tar: normalize the tarinfo name/linkname when used as hlm key.
  173. also: when printing the path, use the already normalized item.path.
  174. - import-tar: fix the dotslash issue, add test
  175. New features:
  176. - create --files-changed=MODE option, #8958.
  177. control how borg detects whether a file has changed while it was backed up,
  178. valid modes are ctime (default), mtime (2nd best) or disabled (not recommended).
  179. Other changes:
  180. - to_key_filename: raise length limit to 120, #8966.
  181. This works around a test failure on systems with deep build directories.
  182. Version 2.0.0b18 (2025-06-19)
  183. -----------------------------
  184. New features:
  185. - experimental new "buzhash64" chunker (later, after testing, this shall become
  186. the default chunker in borg2):
  187. - add own cryptographically secure pseudo-random number generator (CSPRNG)
  188. based on AES256-CTR to create deterministic random, based on a 256bit seed.
  189. - use that to deterministically create a perfectly balanced buzhash64 table.
  190. - "buzhash64" chunker computes 64bit hash values for the chunking decision.
  191. - performance is similar to "buzhash" (measured on Apple M3P cpu).
  192. That should also resolve these points of criticism about the old "buzhash"
  193. 32bit code:
  194. - table_base: that the bits are not randomly distributed enough
  195. - that an XORed seed cancels out for specific window sizes
  196. - that XORing the table with a seed is equivalent to XORing the computed hash
  197. value with another constant
  198. Please test the chunkers extensively (e.g. with borg create, borg transfer),
  199. we can hardly change them "in production", because chunking differently also
  200. means not deduplicating with old chunks. So, in case there are changes
  201. needed, we need to find and fix them now while borg is in beta.
  202. See also some other chunker changes listed below "Other changes".
  203. - serve: add --permissions option as an alternative to BORG_REPO_PERMISSIONS env var
  204. - create: auto-exclude items based on xattrs or NODUMP, see #4972
  205. no options yet, just hardcoded macOS and Linux xattrs.
  206. removed the --exclude-nodump option, it is also done automagically now.
  207. also: create: read stat attrs, xattrs, ACLs early, before file contents.
  208. Fixes:
  209. - compact: fix cleaning archives directory (catch correct exception, use
  210. logger.warning, improve error msg)
  211. Other changes:
  212. - support Python 3.14
  213. - msgpack: allow 1.1.1, version check: ignore "rc" or other version elements
  214. - add derive_key to derive new keys from existing key material
  215. - refactor the chunkers, #8882 #8883:
  216. - transform buzhash chunker C code to Cython
  217. - split concerns into FileFMAPReader, FileReader, Chunker*:
  218. - FileFMAPReader reads blocks from the input file, supporting sparse
  219. files and fmaps.
  220. - FileReader uses FileFMAPReader to fill its buffer and offers clients a
  221. `.read(size)` method so they can read pieces of the data.
  222. - all chunkers now use the FileReader/FileFMAPReader code
  223. - split code and test module into packages
  224. - "fixed" chunker: add fixed chunker tests to selftest
  225. - "fixed" chunker: do not assert on short header read
  226. - "buzhash*" chunker: use safe_fadvise
  227. - "buzhash" chunker: reject even window size, #8868
  228. - fish: fix archive name completion
  229. - refactor: modularize tests
  230. - refactor: use pathlib.Path
  231. - tests / CI:
  232. - CI: add bandit, a security-oriented static analysis tool
  233. - CI: disable windows as the file:// repo URLs are still broken on windows.
  234. - tests: tox: use native pyproject.toml configuration
  235. - more chunker-related tests
  236. - docs:
  237. - add docs for serve --permissions / BORG_REPO_PERMISSIONS
  238. - borg-serve: simplify example of env in authorized_keys, #8318
  239. - fix mistyped CVE number
  240. Version 2.0.0b17 (2025-05-23)
  241. -----------------------------
  242. New features:
  243. - transfer: implement --chunker-params to re-chunk while transferring, #8706
  244. - list --depth=N: list files up to N depth in path hierarchy, #8268
  245. - compact: also clean up files cache, #8852
  246. - `BORG_REPO_PERMISSIONS=all|no-delete|write-only|read-only`, #8823
  247. The posixfs borgstore backend implements permissions to make
  248. testing with differently permissive stores easier.
  249. The env var selects from pre-defined permission configurations
  250. within borg and gives the chosen permissions config to borgstore.
  251. borg uses borgstore's posixfs backend only for file: and ssh: repos.
  252. Fixes:
  253. - correct the signature of __set_name__ as cython 3.1 added support,
  254. fixing build on Cython 3.1, #6858
  255. - compact/check: fix bug not writing the complete index, #8813
  256. - compact: add --iec option, #8831
  257. - check/compact/analyze: show archive timestamp in local tz, #8814
  258. - repo-space: enable ssh: repo testing, fix AttributeError, #8815
  259. - repo-info: fix output formatting
  260. Other changes:
  261. - require borgstore 0.3.x
  262. - some updates and fixes for shell completions, needs more work
  263. - dir_is_tagged/_is_cachedir: add fd-based operations
  264. - cython: suppress compiler warning about CYTHON_FALLTHROUGH in unreachable code
  265. - source code: `pyupgrade --py310-plus ./**/*.py`
  266. - tests:
  267. - add/improve tests for repo-compress --stats, transfer, repo-space
  268. - split helpers tests from a single module into borg.testsuite.helpers package
  269. - save temp space (good for ramdisk users)
  270. - fix diff cmd test on macOS HFS+, #8860
  271. - test validity of shell completion files
  272. - CI: fix and enable windows CI, #8728
  273. - CI: upload coverage for windows tests
  274. - CI: install zsh and fish so we can test shell completions
  275. - docs:
  276. - must have the release tags in the local repo, #8582
  277. - remove outdated docs/man files about borg change-passphrase
  278. - add S3/B2 urls to documentation for repository urls, #8833
  279. Version 2.0.0b16 (2025-05-06)
  280. -----------------------------
  281. Fixes:
  282. - chunks cache: invalidate old chunk index cache, #8795
  283. - compact: always write updated chunkindex to repo, #8791
  284. - ChunksMixin: don't use self._chunks until it is demand-built, #8785
  285. - AdhocWithFilesCache: fix call to _maybe_write_chunks_cache
  286. - format_time: output date/time in local tz, #8802
  287. - check: ask for key passphrase early, #1931
  288. - only obfuscate the size of file content chunks, #7559
  289. - better support other repo by misc. passphrase env vars, #8457
  290. - passphrases now come from `BORG_[OTHER_]PASSPHRASE`, `BORG_[OTHER_]PASSCOMMAND`
  291. or `BORG_[OTHER_]PASSPHRASE_FD`.
  292. - `borg repo-create --repo B --other-repo A` does not silently copy the
  293. passphrase of key A to key B anymore, but either asks for the passphrase
  294. or reads it from env vars.
  295. Other changes:
  296. - remove support for / testing on Python 3.9
  297. - docs: borg serve --repo is not supported, #8591
  298. - remove remainders of append-only and quota support
  299. - remove cygwin < 2.8.0 bug workaround
  300. - fix remote api versioning
  301. Version 2.0.0b15 (2025-04-22)
  302. -----------------------------
  303. New features:
  304. - compact: without --stats, it will be faster by using the cached chunks index.
  305. with --stats it will be as slow as before, listing all repo objs.
  306. - compact: support --dry-run (do nothing), #8300
  307. - extract: --dry-run now displays +/- status flags (included/excluded), #8564
  308. - allow timespan to be specified with common time units, #8624
  309. - enhance passphrase handling, #8496.
  310. Setting `BORG_DEBUG_PASSPHRASE=YES` enables passphrase debug logging to
  311. stderr, showing passphrase, hex utf-8 byte sequence and related env vars if
  312. a wrong passphrase was encountered.
  313. Setting `BORG_DISPLAY_PASSPHRASE=YES` now always shows passphrase and its hex
  314. utf-8 byte sequence.
  315. - add {unixtime} placeholder, #8522
  316. - implement padme chunk size obfuscation (SPEC 250), #8705
  317. - macOS: retrieve birthtime in nanosecond precision via system call, #8724
  318. Bug fixes:
  319. - borg exits when assertions are disabled with Python optimizations, #8649
  320. - yes(): deal with UnicodeDecodeError in input(), #6984
  321. - fix remote repository exception handling / modern exit codes, #8631
  322. - freebsd: fix nfs4 acl processing, #8756.
  323. This issue only affected borg extract --numeric-ids when processing NFS4
  324. ACLs, it didn't affect POSIX ACL processing.
  325. Other changes:
  326. - adapt to and require borghash 0.1.0
  327. - adapt to and require borgstore 0.2.0 (new s3/b2 backend, fixes/improvements)
  328. - create: remove --make-parent-dirs option (borgstore now does this automatically), #8619
  329. - iter_items: decouple item iteration and content data chunks preloading
  330. - remote: simplify code, add debug logging
  331. - pyproject.toml: SPDX expression for license, add license-files, #8771
  332. - Item: remove .chunks_healthy, #8559
  333. - OpenBSD fixes:
  334. - support other OpenSSL versions on OpenBSD, #8553
  335. - vagrant: fix OpenBSD box, #8506
  336. - Filter test output with LibreSSL related warnings on OpenBSD
  337. - macOS: fix brew's broken pkg-config -> pkgconf transition
  338. - tests: ignore 'com.apple.provenance' xattr (macOS specific)
  339. - vagrant updates:
  340. - use pyinstaller 6.11.1 (also use this in msys2 build scripts)
  341. - use python 3.12.10
  342. - build binaries with borgstore[sftp], #8574
  343. - docs:
  344. - automated backup: append to SYSTEMD_WANTS rather than overwrite, #8641
  345. - fix udev rule priority in automated-local.rst, #8639
  346. - FAQ: Why backups are slow on a Linux server that is a member of a windows domain? #8636
  347. - within a shell, cli options with special characters may require quoting, #8578
  348. - update prune documentation for new --keep-within intervals, #8630
  349. - borg serve: recommend using a simple shell, #3818
  350. - update install docs (requirements, pkgconfig, fuse), #8342
  351. - libffi-dev is required for argon2-cffi-bindings
  352. - add undelete command to index
  353. - borg commands updated with --repo option, #8550
  354. - FAQ: add entry about pure-python msgpack warning, #8323
  355. - readthedocs theme fixes
  356. - bring back highlighted content preview in search results.
  357. - fix erroneous warning about missing javascript support.
  358. Version 2.0.0b14 (2024-11-17)
  359. -----------------------------
  360. New features:
  361. - delete: now only soft-deletes archives (same for prune)
  362. - repo-list: --deleted lists deleted archives
  363. - undelete: undelete soft-deleted archives, #8500
  364. Fixes:
  365. - chunks index cache:
  366. - enable partial/incremental updates (F_NEW flag).
  367. - write chunks index every 10mins, #8503.
  368. this makes sure progress is not totally lost when a backup is interrupted.
  369. - write to repo/cache/chunks.<HASH> to enable parallel updates.
  370. - mount: fix check_pending_archive to give correct root dir, #8528
  371. Other changes:
  372. - repo-compress: reduce memory consumption (F_COMPRESS flag)
  373. - files cache: reduce memory consumption, #5756
  374. - check: rename --undelete-archives to --find-lost-archives
  375. - check: rebuild_archives_directory: accelerate by only reading metadata
  376. - shell completions: adapt zsh for borg 2.0.0b13 - needs more work!
  377. - chunk index: rename .refcount to .flags, use it for user and system flags.
  378. - vagrant:
  379. - add bookworm32 box for 32bit platform testing
  380. - fix pythons on freebsd14
  381. - simplify openindiana box setup
  382. - docs:
  383. - remove --bypass-lock, small changes regarding compression
  384. - FAQ: clean up entries regarding SSH settings
  385. Version 2.0.0b13 (2024-10-31)
  386. -----------------------------
  387. New features:
  388. - implement special tags, @PROT tag for protecting archives, #953.
  389. borg won't delete/prune/recreate protected archives.
  390. - prune: add quarterly pruning strategy, #8337.
  391. - import-tar/export-tar: add xattr support for PAX format, #2521.
  392. Fixes:
  393. - simple error msgs for existing / non-existing repo, no tracebacks, #8475.
  394. - mount: create unique directory names, #8461.
  395. - diff: suppress modified changes for files which weren't actually modified.
  396. - diff: do not test for ctime difference on windows.
  397. - prune: fix exception when NAME is given, #8486
  398. - repo-create: build and cache an empty ChunkIndex.
  399. - work around missing size/nfiles archive metadata, #8491
  400. - lock after checking repo exists, #8485
  401. Other changes:
  402. - new file:, rclone:, ssh:, sftp: URLs, #8372, #8446.
  403. new way to deal with absolute vs. relative paths.
  404. - require borgstore ~= 0.1.0, require borghash ~= 0.0.1.
  405. - new hashtable code based on borghash project:
  406. - borghash replaces old / hard to maintain _hashindex.c code.
  407. - implement ChunkIndex, NSIndex1, FuseVersionsIndex using borghash.HashTableNT.
  408. - rewrite NSIndex1 (borg 1.x) on-disk format read/write methods in Cython.
  409. - remove NSIndex (early borg2) data structure / serialization code for repo index.
  410. - change xxh64 seed for ChunkIndex to invalidate old cache contents.
  411. - chunks index: show hashtable stats at debug log level, #506.
  412. - check (repository part): build and cache a ChunkIndex.
  413. check (archives part): use cached ChunkIndex from check (repository part).
  414. - export-tar: switch default to PAX format.
  415. - docs:
  416. - update URL docs
  417. - mount: document on-demand loading, perf tips, #7173.
  418. - borg/borgfs detects internally under which name it was invoked, #8207.
  419. - better link modern return codes, #8370.
  420. - binary: using the directory build is faster, #8008.
  421. - update "Running the tests (using the pypi package)", #6386.
  422. - github CI:
  423. - temporarily disabled windows CI, #8474.
  424. - msys2: use pyinstaller 6.10.0.
  425. - msys2: install rclone.
  426. - tests:
  427. - rename test files so that pytest default discovery finds them.
  428. - call register_assert_rewrite before importing borg.testsuite.
  429. - move conftest.py one directory level higher.
  430. - remove hashindex tests from selftests (borghash project has own tests).
  431. Version 2.0.0b12 (2024-10-03)
  432. -----------------------------
  433. New features:
  434. - tag: new command to set, add, remove tags.
  435. - repo-list: add tags/hostname/username/comment to default format, reorder, adjust.
  436. Idea: not putting these into the archive name, but keeping them separate.
  437. - repo-list --short: only print archive IDs (unique IDs, used for scripting).
  438. - implement --match-archives user:USERNAME host:HOSTNAME tags:TAG1,TAG2,...
  439. - allow -a / --match-archives multiple times (logical AND).
  440. E.g.: borg delete -a home -a user:kenny -a host:kenny-pc
  441. - analyze: list changed chunks' sizes per directory.
  442. Fixes:
  443. - locking: also refresh the lock in other repo methods. avoid repo lock
  444. getting stale when processing lots of unchanged files, #8442.
  445. - make sure the store gets closed in case of exceptions, #8413.
  446. - msgpack: increase max_buffer_size to ~4GiB, #8440.
  447. - Location.canonical_path: fix protocol and host display, #8446.
  448. Other changes:
  449. - give borgstore.Store a complete levels configuration, #8432.
  450. - add BORG_STORE_DATA_LEVELS=2 env var.
  451. - check: also display archive timestamp.
  452. - vagrant:
  453. - use python 3.12.6 for binary builds.
  454. - new testing box based on bento/ubuntu-24.04.
  455. - install Rust on BSD.
  456. Version 2.0.0b11 (2024-09-26)
  457. -----------------------------
  458. New features:
  459. - Support rclone:// URLs for borg repositories.
  460. This enables 70+ cloud storage products, including Amazon S3, Backblaze B2,
  461. Ceph, Dropbox, ftp(s), Google Cloud Storage, Google Drive, Microsoft Azure,
  462. Microsoft OneDrive, OpenStack Swift, pCloud, Seafile, sftp, SMB / CIFS and
  463. WebDAV!
  464. See https://rclone.org/ for more details.
  465. - Parallel operations in same repo from same client (same user/machine).
  466. - Archive series feature, #7930.
  467. TL;DR: a NAME now identifies a series of identically named archives,
  468. to identify a specific single archive, use aid:<archive hash>.
  469. in borg 1.x, we used to put a timestamp into the archive name, because borg1
  470. required unique archive names.
  471. borg2 does not require unique archive names, but it encourages you to even
  472. use a identical archive names within the same SERIES of archives, e.g. you
  473. could backup user files to archives named "user-files" and system files to
  474. archives named "system-files".
  475. that makes matching (e.g. for prune, for the files cache, ...) much simpler
  476. and borg now KNOWS which archives belong to the same series (because they all
  477. have the same name).
  478. - info/delete/prune: allow positional NAME argument, e.g.:
  479. - borg prune --keep-daily 30 <seriesname>
  480. - borg delete aid:<archive hash>
  481. - create: also archive inode number, #8362
  482. Borg can use this when using archive series to rebuild the local files cache
  483. from the previous archive (of the same series) in the repository.
  484. Fixes:
  485. - Remove superfluous repository.list() call. for high latency repos
  486. (like sftp, cloud), this improves performance of borg check and compact.
  487. - repository.list: refresh lock more frequently
  488. - misc. commands fixed for non-unique archive names
  489. - remote: allow get_manifest method
  490. - files cache: fix rare race condition with data loss potential, #3536
  491. - storelocking: misc. fixes / cleanups
  492. Other changes:
  493. - Cache the chunks index in the repository, #8397.
  494. Improves high latency repo performance for most commands compared to b10.
  495. - repo-compress: faster by using chunks index rather than repository.list().
  496. - Files cache entries now have both ctime AND mtime.
  497. - Borg updates the ctime and mtime of known and "unchanged" files, #4915.
  498. - Rebuild files cache from previous archive in same series, #8385.
  499. - Reduce RAM usage by splitting the files cache by archive series, #5658.
  500. - Remove AdHocCache, remove BORG_CACHE_IMPL (we only have one implementation).
  501. - Docs: user@ and :port are optional in sftp and ssh URLs.
  502. - CI: re-enable windows build after fixing it.
  503. - Upgrade pyinstaller to 6.10.0.
  504. - Increase IDS_PER_CHUNK, #6945.
  505. Version 2.0.0b10 (2024-09-09)
  506. -----------------------------
  507. New features:
  508. - borgstore based repository, file:, ssh: and sftp: for now, more possible.
  509. - repository stores objects separately now, not using segment files.
  510. this has more fs overhead, but needs much less I/O because no segment
  511. files compaction is required anymore. also, no repository index is
  512. needed anymore because we can directly find the objects by their ID.
  513. - locking: new borgstore based repository locking with automatic stale
  514. lock removal (if lock does not get refreshed, if lock owner process is dead).
  515. - simultaneous repository access for many borg commands except check/compact.
  516. the cache lock for adhocwithfiles is still exclusive though, so use
  517. BORG_CACHE_IMPL=adhoc if you want to try that out using only 1 machine
  518. and 1 user (that implementation doesn't use a cache lock). When using
  519. multiple client machines or users, it also works with the default cache.
  520. - delete/prune: much quicker now and can be undone.
  521. - check --repair --undelete-archives: bring archives back from the dead.
  522. - repo-space: manage reserved space in repository (avoid dead-end situation if
  523. repository filesystem runs full).
  524. Bugs/issues fixed:
  525. - a lot! all linked from PR #8332.
  526. Other changes:
  527. - repository: remove transactions, solved differently and much simpler now
  528. (convergence and write order primarily).
  529. - repository: replaced precise reference counting with "object exists in repo?"
  530. and "garbage collection of unused objects".
  531. - cache: remove transactions, remove chunks cache.
  532. removed LocalCache, BORG_CACHE_IMPL=local, solving all related issues.
  533. as in beta 9, adhowwithfiles is the default implementation.
  534. - compact: needs the borg key now (run it clientside), -v gives nice stats.
  535. - transfer: archive transfers from borg 1.x need the --from-borg1 option
  536. - check: reimplemented / bigger changes.
  537. - code: got rid of a metric ton of not needed complexity.
  538. when borg does not need to read borg 1.x repos/archives anymore, after
  539. users have transferred their archives, even much more can be removed.
  540. - docs: updated / removed outdated stuff
  541. - renamed r* commands to repo-*
  542. Version 2.0.0b9 (2024-07-20)
  543. ----------------------------
  544. New features:
  545. - add BORG_CACHE_IMPL, default is "adhocwithfiles" to test the new cache
  546. implementation, featuring an adhoc non-persistent chunks cache and a
  547. persistent files cache. See the docs for other values.
  548. Requires to run "borg check --repair --archives-only" to delete orphaned
  549. chunks before running "borg compact" to free space! These orphans are
  550. expected due to the simplified refcounting with the AdHocFilesCache.
  551. - make BORG_EXIT_CODES="modern" the default, #8110
  552. - add BORG_USE_CHUNKS_ARCHIVE env var, #8280
  553. - automatically rebuild cache on exception, #5213
  554. Bug fixes:
  555. - fix Ctrl-C / SIGINT behaviour for pyinstaller-made binaries, #8155
  556. - delete: fix error handling with Ctrl-C
  557. - rcompress: fix error handling with Ctrl-C
  558. - delete: fix error handling when no archive is specified, #8256
  559. - setup.py: fix import error reporting for cythonize import, see #8208
  560. - create: deal with EBUSY, #8123
  561. - benchmark: inherit options --rsh --remote-path, #8099
  562. - benchmark: fix return value, #8113
  563. - key export: fix crash when no path is given, fix exception handling
  564. Other changes:
  565. - setup.py: detect noexec build fs issue, see #8208
  566. - improve acl_get / acl_set error handling (forward port from 1.4-maint)
  567. - allow msgpack 1.1.0
  568. - vagrant: use pyinstaller 6.7.0
  569. - use Python 3.11.9 for binary builds
  570. - require Cython 3.0.3 at least, #8133
  571. - docs: add non-root deployment strategy
  572. Version 2.0.0b8 (2024-02-20)
  573. ----------------------------
  574. New features:
  575. - create: add the slashdot hack, update docs, #4685
  576. - BORG_EXIT_CODES=modern: optional more specific return codes (for errors and warnings).
  577. The default value of this new environment variable is "legacy", which should result in
  578. a behaviour similar to borg 1.2 and older (only using rc 0, 1 and 2).
  579. "modern" exit codes are much more specific (see the internals/frontends docs).
  580. - implement "borg version" (shows client and server version), #7829
  581. Fixes:
  582. - docs: CVE-2023-36811 upgrade steps: consider checkpoint archives, #7802
  583. - check/compact: fix spurious reappearance of orphan chunks since borg 1.2, #6687 -
  584. this consists of 2 fixes:
  585. - for existing chunks: check --repair: recreate shadow index, #7897 #6687
  586. - for newly created chunks: update shadow index when doing a double-put, #7896 #5661
  587. If you have experienced issue #6687, you may want to run borg check --repair
  588. after upgrading to borg 1.2.7 to recreate the shadow index and get rid of the
  589. issue for existing chunks.
  590. - check: fix return code for index entry value discrepancies
  591. - LockRoster.modify: no KeyError if element was already gone, #7937
  592. - create --X-from-command: run subcommands with a clean environment, #7916
  593. - list --sort-by: support "archive" as alias of "name", #7873
  594. - fix rc and msg if arg parsing throws an exception, #7885
  595. - PATH: do not accept empty strings, #4221
  596. - fix invalid pattern argument error msg
  597. - zlib legacy decompress fixes, #7883
  598. Other changes:
  599. - replace archive/manifest TAMs by typed repo objects (ro_type), docs, #7670
  600. - crypto: use a one-step kdf for session keys, #7953
  601. - remove recreate --recompress option, use the more efficient repo-wide "rcompress".
  602. - include unistd.h in _chunker.c (fix for Python 3.13)
  603. - allow msgpack 1.0.7
  604. - allow platformdirs 4, #7950
  605. - use and require cython3
  606. - move conftest.py to src/borg/testsuite, #6386
  607. - use less setup.py, use pip and build
  608. - linux: use pkgconfig to find libacl
  609. - borg.logger: use same method params as python logging
  610. - create and use Brewfile, document "brew bundle" install (macOS)
  611. - blacken master branch
  612. - prevent CLI argument issues in scripts/glibc_check.py
  613. - pyproject.toml: exclude source files which have been compiled, #7828
  614. - sdist: dynamically compute readme (long_description)
  615. - init: better borg key export instructions
  616. - scripts/make.py: move clean, build_man, build_usage to there,
  617. so we do not need to invoke setup.py directly, update docs
  618. - vagrant:
  619. - use openssl 3.0 on macOS
  620. - add script for fetching borg binaries from VMs, #7989
  621. - use generic/openbsd7 box
  622. - netbsd: test on py311 only
  623. - remove debian 9 "stretch" box
  624. - use freebsd 14, #6871
  625. - use python 3.9.4 for tests, latest python 3.11.7 for binary builds
  626. - use pyinstaller 6.3.0
  627. - docs:
  628. - add typical PR workflow to development docs, #7495
  629. - improve docs for borg with-lock, add example #8024
  630. - create disk/partition sector backup by disk serial number
  631. - Add "check.rebuild_refcounts" message
  632. - not only attack/unsafe, can also be a fs issue, #7853
  633. - use virtualenv on Cygwin
  634. - readthedocs: also build offline docs, #7835
  635. - do not refer to setup.py installation method
  636. - how to run the testsuite using the dist package
  637. - requirements are defined in pyproject.toml
  638. Version 2.0.0b7 (2023-09-14)
  639. ----------------------------
  640. New features:
  641. - BORG_WORKAROUNDS=authenticated_no_key to extract from authenticated repos
  642. without having the borg key, #7700
  643. Fixes:
  644. - archive tam verify security fix, fixes CVE-2023-36811
  645. - remote logging/progress: use callback to send queued records, #7662
  646. - make_path_safe: remove test for backslashes, #7651
  647. - benchmark cpu: use sanitized path, #7654
  648. - create: do not try to read parent dir of recursion root, #7746
  649. Other changes:
  650. - always implicitly require archive TAMs (all archives have TAMs since borg 1.2.6)
  651. - always implicitly require manifest TAMs (manifests have TAMs since borg 1.0.9)
  652. - rlist: remove support for {tam} placeholder, archives are now always TAM-authenticated.
  653. - support / test on Python 3.12
  654. - allow msgpack 1.0.6 (which has py312 wheels), #7810
  655. - manifest: move item_keys into config dict (manifest.version == 2 now), #7710
  656. - replace "datetime.utcfromtimestamp" to avoid deprecation warnings with Python 3.12
  657. - properly normalise paths on Windows (forward slashes, integrate drive letter into path)
  658. - Docs:
  659. - move upgrade / compat. notes to own section, see #7546
  660. - fix borg delete examples, #7759
  661. - improve rcreate / related repos docs
  662. - automated-local.rst: use UUID for consistent udev rule
  663. - rewrite `borg check` docs, #7578
  664. - misc. other docs updates
  665. - Tests / CI / Vagrant:
  666. - major testsuite refactoring: a lot more tests now use pytest, #7626
  667. - freebsd: add some ACL tests, #7745
  668. - fix test_disk_full, #7617
  669. - fix failing test_get_runtime_dir test on OpenBSD, #7719
  670. - CI: run on ubuntu 22.04
  671. - CI: test building the docs
  672. - simplify flake8 config, fix some complaints
  673. - use pyinstaller 5.13.1 to build the borg binaries
  674. Version 2.0.0b6 (2023-06-11)
  675. ----------------------------
  676. New features:
  677. - diff: include changes in ctime and mtime, #7248
  678. - diff: sort JSON output alphabetically
  679. - diff --content-only: option added to ignore metadata changes
  680. - diff: add --format option, #4634
  681. - import-tar --ignore-zeros: new option to support importing concatenated tars, #7432
  682. - debug id-hash / parse-obj / format-obj: new debug commands, #7406
  683. - transfer --compression=C --recompress=M: recompress while transferring, #7529
  684. - extract --continue: continue a previously interrupted extraction, #1356
  685. - prune --list-kept/--list-pruned: only list the kept (or pruned) archives, #7511
  686. - prune --short/--format: enable users to format the list output, #3238
  687. - implement BORG_<CMD>_FORMAT env vars for prune, list, rlist, #5166
  688. - rlist: size and nfiles format keys
  689. - implement unix domain (ipc) socket support, #6183::
  690. borg serve --socket # server side (not started automatically!)
  691. borg -r socket:///path/to/repo ... # client side
  692. - add get_runtime_dir / BORG_RUNTIME_DIR (contains e.g. .sock and .pid file)
  693. - support shell-style alternatives, like: sh:image.{png,jpg}, #7602
  694. Fixes:
  695. - do not retry on permission errors (pointless)
  696. - transfer: verify chunks we get using assert_id, #7383
  697. - fix config/cache dir compatibility issues, #7445
  698. - xattrs: fix namespace processing on FreeBSD, #6997
  699. - ProgressIndicatorPercent: fix space computation for wide chars, #3027
  700. - delete: remove --cache-only option, #7440.
  701. for deleting the cache only, use: borg rdelete --cache-only
  702. - borg debug get-obj/put-obj: fixed chunk id
  703. - create: ignore empty paths, print warning, #5637
  704. - extract: support extraction of atime/mtime on win32
  705. - benchmark crud: use TemporaryDirectory below given path, #4706
  706. - Ensure that cli options specified with action=Highlander can only be set once, even
  707. if the set value is a default value. Add tests for action=Highlander, #7500, #6269.
  708. - Fix argparse error messages from misc. validators (being more specific).
  709. - put security infos into data dir, add BORG_DATA_DIR env var, #5760
  710. - setup.cfg: remove setup_requires (we have a pyproject.toml for that), #7574
  711. - do not crash for empty archives list in borg rlist date based matching, #7522
  712. - sanitize paths during archive creation and extraction, #7108 #7099
  713. - make sure we do not get backslashes into item paths
  714. Other changes:
  715. - allow msgpack 1.0.5 also
  716. - development.lock.txt: upgrade cython to 0.29.35, misc. other upgrades
  717. - clarify platformdirs requirements, #7393.
  718. 3.0.0 is only required for macOS due to breaking changes.
  719. 2.6.0 was the last breaking change for Linux/UNIX.
  720. - mount: improve mountpoint error msgs, see #7496
  721. - more Highlander options, #6269
  722. - Windows: simplify building (just use pip)
  723. - refactor toplevel exception handling, #6018
  724. - remove nonce management, related repo methods (not needed for borg2)
  725. - borg.remote: remove support for borg < 1.1.0
  726. ($LOG, logging setup, exceptions, rpc tuple data format, version)
  727. - new remote and progress logging, #7604
  728. - borg.logger: add logging debugging functionality
  729. - add function to clear empty directories at end of compact process
  730. - unify scanning and listing of segment dirs / segment files, #7597
  731. - replace `LRUCache` internals with `OrderedDict`
  732. - docs:
  733. - add installation instructions for Windows
  734. - improve --one-file-system help and docs (macOS APFS), #5618 #4876
  735. - BORG_KEY_FILE: clarify docs, #7444
  736. - installation: add link to OS dependencies, #7356
  737. - update FAQ about locale/unicode issues, #6999
  738. - improve mount options rendering, #7359
  739. - make timestamps in manual pages reproducible.
  740. - describe performing pull-backups via ssh remote forwarding
  741. - suggest to use forced command when using remote-forwarding via ssh
  742. - fix some -a / --match-archives docs issues
  743. - incl./excl. options header, clarify --path-from-stdin exclusive control
  744. - add note about MAX_DATA_SIZE
  745. - update security support docs
  746. - improve patterns help
  747. - CI / tests / vagrant:
  748. - added pre-commit for linting purposes, #7476
  749. - resolved mode bug and added sleep clause for darwin systems, #7470
  750. - "auto" compressor tests: do not assume zlib is better than lz4, #7363
  751. - add stretch64 VM with deps built from source
  752. - misc. other CI / test fixes and updates
  753. - vagrant: add lunar64 VM, fix packages_netbsd
  754. - avoid long ids in pytest output
  755. - tox: package = editable-legacy, #7580
  756. - tox under fakeroot: fix finding setup_docs, #7391
  757. - check buzhash chunksize distribution, #7586
  758. - use debian/bookworm64 box
  759. Version 2.0.0b5 (2023-02-27)
  760. ----------------------------
  761. New features:
  762. - create: implement retries for individual fs files
  763. (e.g. if a file changed while we read it, if a file had an OSError)
  764. - info: add used storage quota, #7121
  765. - transfer: support --progress
  766. - create/recreate/import-tar: add --checkpoint-volume option
  767. - support date-based matching for archive selection,
  768. add --newer/--older/--newest/--oldest options, #7062 #7296
  769. Fixes:
  770. - disallow --list with --progress, #7219
  771. - create: fix --list --dry-run output for directories, #7209
  772. - do no assume hardlink_master=True if not present, #7175
  773. - fix item_ptrs orphaned chunks of checkpoint archives
  774. - avoid orphan content chunks on BackupOSError, #6709
  775. - transfer: fix bug in obfuscated data upgrade code
  776. - fs.py: fix bug in f-string (thanks mypy!)
  777. - recreate: when --target is given, do not detect "nothing to do", #7254
  778. - locking (win32): deal with os.rmdir/listdir PermissionErrors
  779. - locking: thread id must be parsed as hex from lock file name
  780. - extract: fix mtime when ResourceFork xattr is set (macOS specific), #7234
  781. - recreate: without --chunker-params borg shall not rechunk, #7336
  782. - allow mixing --progress and --list in log-json mode
  783. - add "files changed while reading" to Statistics class, #7354
  784. - fixed keys determination in Statistics.__add__(), #7355
  785. Other changes:
  786. - use local time / local timezone to output timestamps, #7283
  787. - update development.lock.txt, including a setuptools security fix, #7227
  788. - remove --save-space option (does not change behaviour)
  789. - remove part files from final archive
  790. - remove --consider-part-files, related stats code, update docs
  791. - transfer: drop part files
  792. - check: show id of orphaned chunks
  793. - ArchiveItem.cmdline list-of-str -> .command_line str, #7246
  794. - Item: symlinks: rename .source to .target, #7245
  795. - Item: make user/group/uid/gid optional
  796. - create: do not store user/group for stdin data by default, #7249
  797. - extract: chown only if we have u/g info in archived item, #7249
  798. - export-tar: for items w/o uid/gid, default to 0/0, #7249
  799. - fix some uid/gid lookup code / tests for win32
  800. - cache.py: be less verbose during cache sync
  801. - update bash completion script commands and options, #7273
  802. - require and use platformdirs 3.x.x package, tests
  803. - better included/excluded status chars, docs, #7321
  804. - undef NDEBUG for chunker and hashindex (make assert() work)
  805. - assert_id: better be paranoid (add back same crypto code as in old borg), #7362
  806. - check --verify_data: always decompress and call assert_id(), #7362
  807. - make hashindex_compact simpler and probably faster, minor fixes, cleanups, more tests
  808. - hashindex minor fixes, refactor, tweaks, tests
  809. - pyinstaller: remove icon
  810. - validation / placeholders / JSON:
  811. - implement (text|binary)_to_json: key (text), key_b64 (base64(binary))
  812. - remove bpath, barchive, bcomment placeholders / JSON keys
  813. - archive metadata: make sure hostname and username have no surrogate escapes
  814. - text attributes (like archive name, comment): validate more strictly, #2290
  815. - transfer: validate archive names and comment before transfer
  816. - json output: use text_to_json (path, target), #6151
  817. - docs:
  818. - docs and comments consistency, readability and spelling fixes
  819. - fix --progress display description, #7180
  820. - document how borg deals with non-unicode bytes in JSON output
  821. - document another way to get UTF-8 encoding on stdin/stdout/stderr, #2273
  822. - pruning interprets timestamps in the local timezone where borg prune runs
  823. - shellpattern: add license, use copyright/license markup
  824. - key change-passphrase: fix --encryption value in examples
  825. - remove BORG_LIBB2_PREFIX (not used any more)
  826. - Installation: Update Fedora in distribution list, #7357
  827. - add .readthedocs.yaml (use py311, use non-shallow clone)
  828. - tests:
  829. - fix archiver tests on Windows, add running the tests to Windows CI
  830. - fix tox4 passenv issue, #7199
  831. - github actions updates (fix deprecation warnings)
  832. - add tests for borg transfer/upgrade
  833. - fix test hanging reading FIFO when `borg create` failed
  834. - mypy inspired fixes / updates
  835. - fix prune tests, prune in localtime
  836. - do not look up uid 0 / gid 0, but current process uid/gid
  837. - safe_unlink tests: use os.link to support win32 also
  838. - fix test_size_on_disk_accurate for large st_blksize, #7250
  839. - relaxed timestamp comparisons, use same_ts_ns
  840. - add test for extracted directory mtime
  841. - use "fail" chunker to test erroneous input file skipping
  842. Version 2.0.0b4 (2022-11-27)
  843. ----------------------------
  844. Fixes:
  845. - transfer/upgrade: fix borg < 1.2 chunker_params, #7079
  846. - transfer/upgrade: do not access Item._dict, #7077
  847. - transfer/upgrade: fix crash in borg transfer, #7156
  848. - archive.save(): always use metadata from stats, #7072
  849. - benchmark: fixed TypeError in compression benchmarks, #7075
  850. - fix repository.scan api minimum requirement
  851. - fix args.paths related argparsing, #6994
  852. Other changes:
  853. - tar_filter: recognize .tar.zst as zstd, #7093
  854. - adding performance statistics to borg create, #6991
  855. - docs: add rcompress to usage index
  856. - tests:
  857. - use github and MSYS2 for Windows CI, #7097
  858. - win32 and cygwin: test fixes / skip hanging test
  859. - vagrant / github CI: use python 3.11.0 / 3.10.8
  860. - vagrant:
  861. - upgrade pyinstaller to 5.6.2 (supports python 3.11)
  862. - use python 3.11 to build the borg binary
  863. Version 2.0.0b3 (2022-10-02)
  864. ----------------------------
  865. Fixes:
  866. - transfer: fix user/group == None crash with borg1 archives
  867. - compressors: avoid memoryview related TypeError
  868. - check: fix uninitialised variable if repo is completely empty, #7034
  869. - do not use version_tuple placeholder in setuptools_scm template, #7024
  870. - get_chunker: fix missing sparse=False argument, #7056
  871. New features:
  872. - rcompress: do a repo-wide (re)compression, #7037
  873. - implement pattern support for --match-archives, #6504
  874. - BORG_LOCK_WAIT=n env var to set default for --lock-wait option, #5279
  875. Other:
  876. - repository.scan: misc. fixes / improvements
  877. - metadata: differentiate between empty/zero and unknown, #6908
  878. - CI: test pyfuse3 with python 3.11
  879. - use more relative imports
  880. - make borg.testsuite.archiver a package, split archiver tests into many modules
  881. - support reading new, improved hashindex header format, #6960.
  882. added version number and num_empty to the HashHeader, fixed alignment.
  883. - vagrant: upgrade pyinstaller 4.10 -> 5.4.1, use python 3.9.14 for binary build
  884. - item.pyx: use more Cython (faster, uses less memory), #5763
  885. Version 2.0.0b2 (2022-09-10)
  886. ----------------------------
  887. Bug fixes:
  888. - xattrs / extended stat: improve exception handling, #6988
  889. - fix and refactor replace_placeholders, #6966
  890. New features:
  891. - support archive timestamps with utc offsets, adapt them when using
  892. borg transfer to transfer from borg 1.x repos (append +00:00 for UTC).
  893. - create/recreate/import-tar --timestamp: accept giving timezone via
  894. its utc offset. defaults to local timezone, if no utc offset is given.
  895. Other changes:
  896. - chunks: have separate encrypted metadata (ctype, clevel, csize, size)
  897. chunk = enc_meta_len16 + encrypted(msgpacked(meta)) + encrypted(compressed(data)).
  898. this breaks repo format compatibility, you need to create fresh repos!
  899. - repository api: flags support, #6982
  900. - OpenBSD only - statically link OpenSSL, #6474.
  901. Avoid conflicting with shared libcrypto from the base OS pulled in via dependencies.
  902. - restructured source code
  903. - update diagrams to odg format, #6928
  904. Version 2.0.0b1 (2022-08-08)
  905. ----------------------------
  906. New features:
  907. - massively increase archive metadata stream size limit, #1473.
  908. currently rather testing the code, scalability will improve later, see #6945.
  909. - rcreate --copy-crypt-key: copy crypt_key from key of other repo, #6710.
  910. default: create new, random authenticated encryption key.
  911. - prune/delete --checkpoint-interval=1800 and ctrl-c/SIGINT support, #6284
  912. Fixes:
  913. - ctrl-c must not kill important subprocesses, #6912
  914. - transfer: check whether ID hash method and chunker secret are same.
  915. add PlaintextKey and AuthenticatedKey support to uses_same_id_hash function.
  916. - check: try harder to create the key, #5719
  917. - SaveFile: use a custom mkstemp with mode support, #6933, #6400
  918. - make setuptools happy, #6874
  919. - fix misc. compiler warnings
  920. - list: fix {flags:<WIDTH>} formatting, #6081
  921. Other changes:
  922. - new crypto does not need to call ._assert_id(), update code and docs.
  923. https://github.com/borgbackup/borg/pull/6463#discussion_r925436156
  924. - check: --verify-data does not need to decompress with new crypto modes
  925. - Key: crypt_key instead of enc_key + enc_hmac_key, #6611
  926. - misc. docs updates and improvements
  927. - CI: test on macOS 12 without fuse / fuse tests
  928. - repository: add debug logging for issue #6687
  929. - _version.py: remove trailing blank, add LF at EOF (make pep8 checker happy)
  930. Version 2.0.0a4 (2022-07-17)
  931. ----------------------------
  932. New features:
  933. - recreate: consider level for recompression, #6698, #3622
  934. Other changes:
  935. - stop using libdeflate
  936. - CI: add mypy (if we add type hints, it can do type checking)
  937. - big changes to the source code:
  938. - split up archiver module, transform it into a package
  939. - use Black for automated code formatting
  940. - remove some legacy code
  941. - adapt/fix code for mypy
  942. - use language_level = 3str for cython (this will be the default in cython 3)
  943. - docs: document HardLinkManager and hlid, #2388
  944. Version 2.0.0a3 (2022-07-04)
  945. ----------------------------
  946. Fixes:
  947. - check repo version, accept old repos only for --other-repo (e.g. rcreate/transfer).
  948. v2 is the default repo version for borg 2.0. v1 repos must only be used in a
  949. read-only way, e.g. for --other-repo=V1_REPO with borg init and borg transfer!
  950. New features:
  951. - transfer: --upgrader=NoOp is the default.
  952. This is to support general-purpose transfer of archives between related borg2
  953. repos.
  954. - transfer: --upgrader=From12To20 must be used to transfer (and convert) archives
  955. from borg 1.2 repos to borg 2.0 repos.
  956. Other changes:
  957. - removed some deprecated options
  958. - removed -P (aka --prefix) option, #6806. The option -a (aka --glob-archives)
  959. can be used for same purpose and is more powerful, e.g.: -a 'PREFIX*'
  960. - rcreate: always use argon2 kdf for new repos, #6820
  961. - rcreate: remove legacy encryption modes for new repos, #6490
  962. Version 2.0.0a2 (2022-06-26)
  963. ----------------------------
  964. Changes:
  965. - split repo and archive name into separate args, #948
  966. - use -r or --repo or BORG_REPO env var to give the repository
  967. - use --other-repo or BORG_OTHER_REPO to give another repo (e.g. borg transfer)
  968. - use positional argument for archive name or `-a ARCH_GLOB`
  969. - remove support for scp-style repo specification, use ssh://...
  970. - simplify stats output: repo ops -> repo stats, archive ops -> archive stats
  971. - repository index: add payload size (==csize) and flags to NSIndex entries
  972. - repository index: set/query flags, iteration over flagged items (NSIndex)
  973. - repository: sync write file in get_fd
  974. - stats: deduplicated size now, was deduplicated compressed size in borg 1.x
  975. - remove csize support at most places in the code (chunks index, stats, get_size,
  976. Item.chunks)
  977. - replace problematic/ugly hardlink_master approach of borg 1.x by:
  978. - symmetric hlid (all hardlinks pointing to same inode have same hlid)
  979. - all archived hardlinked regular files have a chunks list
  980. - borg rcreate --other-repo=OTHER_REPO: reuse key material from OTHER_REPO, #6554.
  981. This is useful if you want to use borg transfer to transfer archives from an
  982. existing borg 1.1/1.2 repo. If the chunker secret and the id key and algorithm
  983. stay the same, the deduplication will also work between past and future backups.
  984. - borg transfer:
  985. - efficiently copy archives from a borg 1.1/1.2 repo to a new repo.
  986. uses deduplication and does not decompress/recompress file content data.
  987. - does some cleanups / fixes / conversions:
  988. - disallow None value for .user/group/chunks/chunks_healthy
  989. - cleanup msgpack related str/bytes mess, use new msgpack spec, #968
  990. - obfuscation: fix byte order for size, #6701
  991. - compression: use the 2 bytes for type and level, #6698
  992. - use version 2 for new archives
  993. - convert timestamps int/bigint -> msgpack.Timestamp, see #2323
  994. - all hardlinks have chunks, maybe chunks_healthy, hlid
  995. - remove the zlib type bytes hack
  996. - make sure items with chunks have precomputed size
  997. - removes the csize element from the tuples in the Item.chunks list
  998. - clean item of attic 0.13 'acl' bug remnants
  999. - crypto: see 1.3.0a1 log entry
  1000. - removed "borg upgrade" command (not needed any more)
  1001. - compact: removed --cleanup-commits option
  1002. - docs: fixed quickstart and usage docs with new cli command syntax
  1003. - docs: removed the parts talking about potential AES-CTR mode issues
  1004. (we will not use that any more).
  1005. Version 1.3.0a1 (2022-04-15)
  1006. ----------------------------
  1007. Although this was released as 1.3.0a1, it can be also seen as 2.0.0a1 as it was
  1008. later decided to do breaking changes and thus the major release number had to
  1009. be increased (thus, there will not be a 1.3.0 release, but 2.0.0).
  1010. New features:
  1011. - init: new --encryption=(repokey|keyfile)-[blake2-](aes-ocb|chacha20-poly1305)
  1012. - New, better, faster crypto (see encryption-aead diagram in the docs), #6463.
  1013. - New AEAD cipher suites: AES-OCB and CHACHA20-POLY1305.
  1014. - Session keys are derived via HKDF from random session id and master key.
  1015. - Nonces/MessageIVs are counters starting from 0 for each session.
  1016. - AAD: chunk id, key type, messageIV, sessionID are now authenticated also.
  1017. - Solves the potential AES-CTR mode counter management issues of the legacy crypto.
  1018. - init: --key-algorithm=argon2 (new default KDF, older pbkdf2 also still available)
  1019. borg key change-passphrase / change-location keeps the key algorithm unchanged.
  1020. - key change-algorithm: to upgrade existing keys to argon2 or downgrade to pbkdf2.
  1021. We recommend you to upgrade unless you have to keep the key compatible with older versions of borg.
  1022. - key change-location: usable for repokey <-> keyfile location change
  1023. - benchmark cpu: display benchmarks of cpu bound stuff
  1024. - export-tar: new --tar-format=PAX (default: GNU)
  1025. - import-tar/export-tar: can use PAX format for ctime and atime support
  1026. - import-tar/export-tar: --tar-format=BORG: roundtrip ALL item metadata, #5830
  1027. - repository: create and use version 2 repos only for now
  1028. - repository: implement PUT2: header crc32, overall xxh64, #1704
  1029. Other changes:
  1030. - require python >= 3.9, #6315
  1031. - simplify libs setup, #6482
  1032. - unbundle most bundled 3rd party code, use libs, #6316
  1033. - use libdeflate.crc32 (Linux and all others) or zlib.crc32 (macOS)
  1034. - repository: code cleanups / simplifications
  1035. - internal crypto api: speedups / cleanups / refactorings / modernisation
  1036. - remove "borg upgrade" support for "attic backup" repos
  1037. - remove PassphraseKey code and borg key migrate-to-repokey command
  1038. - OpenBSD: build borg with OpenSSL (not: LibreSSL), #6474
  1039. - remove support for LibreSSL, #6474
  1040. - remove support for OpenSSL < 1.1.1