changes.rst 81 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089
  1. Important notes
  2. ===============
  3. This section is used for infos about security and corruption issues.
  4. .. _tam_vuln:
  5. Pre-1.0.9 manifest spoofing vulnerability
  6. -----------------------------------------
  7. A flaw in the cryptographic authentication scheme in Borg allowed an attacker
  8. to spoof the manifest. The attack requires an attacker to be able to
  9. 1. insert files (with no additional headers) into backups
  10. 2. gain write access to the repository
  11. This vulnerability does not disclose plaintext to the attacker, nor does it
  12. affect the authenticity of existing archives.
  13. The vulnerability allows an attacker to create a spoofed manifest (the list of archives).
  14. Creating plausible fake archives may be feasible for small archives, but is unlikely
  15. for large archives.
  16. The fix adds a separate authentication tag to the manifest. For compatibility
  17. with prior versions this authentication tag is *not* required by default
  18. for existing repositories. Repositories created with 1.0.9 and later require it.
  19. Steps you should take:
  20. 1. Upgrade all clients to 1.0.9 or later.
  21. 2. Run ``borg upgrade --tam <repository>`` *on every client* for *each* repository.
  22. 3. This will list all archives, including archive IDs, for easy comparison with your logs.
  23. 4. Done.
  24. Prior versions can access and modify repositories with this measure enabled, however,
  25. to 1.0.9 or later their modifications are indiscernible from an attack and will
  26. raise an error until the below procedure is followed. We are aware that this can
  27. be be annoying in some circumstances, but don't see a way to fix the vulnerability
  28. otherwise.
  29. In case a version prior to 1.0.9 is used to modify a repository where above procedure
  30. was completed, and now you get an error message from other clients:
  31. 1. ``borg upgrade --tam --force <repository>`` once with *any* client suffices.
  32. This attack is mitigated by:
  33. - Noting/logging ``borg list``, ``borg info``, or ``borg create --stats``, which
  34. contain the archive IDs.
  35. We are not aware of others having discovered, disclosed or exploited this vulnerability.
  36. Vulnerability time line:
  37. * 2016-11-14: Vulnerability and fix discovered during review of cryptography by Marian Beermann (@enkore)
  38. * 2016-11-20: First patch
  39. * 2016-12-18: Released fixed versions: 1.0.9, 1.1.0b3
  40. .. _attic013_check_corruption:
  41. Pre-1.0.9 potential data loss
  42. -----------------------------
  43. If you have archives in your repository that were made with attic <= 0.13
  44. (and later migrated to borg), running borg check would report errors in these
  45. archives. See issue #1837.
  46. The reason for this is a invalid (and useless) metadata key that was
  47. always added due to a bug in these old attic versions.
  48. If you run borg check --repair, things escalate quickly: all archive items
  49. with invalid metadata will be killed. Due to that attic bug, that means all
  50. items in all archives made with these old attic versions.
  51. Pre-1.0.4 potential repo corruption
  52. -----------------------------------
  53. Some external errors (like network or disk I/O errors) could lead to
  54. corruption of the backup repository due to issue #1138.
  55. A sign that this happened is if "E" status was reported for a file that can
  56. not be explained by problems with the source file. If you still have logs from
  57. "borg create -v --list", you can check for "E" status.
  58. Here is what could cause corruption and what you can do now:
  59. 1) I/O errors (e.g. repo disk errors) while writing data to repo.
  60. This could lead to corrupted segment files.
  61. Fix::
  62. # check for corrupt chunks / segments:
  63. borg check -v --repository-only REPO
  64. # repair the repo:
  65. borg check -v --repository-only --repair REPO
  66. # make sure everything is fixed:
  67. borg check -v --repository-only REPO
  68. 2) Unreliable network / unreliable connection to the repo.
  69. This could lead to archive metadata corruption.
  70. Fix::
  71. # check for corrupt archives:
  72. borg check -v --archives-only REPO
  73. # delete the corrupt archives:
  74. borg delete --force REPO::CORRUPT_ARCHIVE
  75. # make sure everything is fixed:
  76. borg check -v --archives-only REPO
  77. 3) In case you want to do more intensive checking.
  78. The best check that everything is ok is to run a dry-run extraction::
  79. borg extract -v --dry-run REPO::ARCHIVE
  80. .. _changelog:
  81. Changelog
  82. =========
  83. Version 1.1.0b3 (not released yet)
  84. ----------------------------------
  85. Compatibility notes:
  86. - borg init: removed the default of "--encryption/-e", #1979
  87. Bug fixes:
  88. - borg recreate: don't rechunkify unless explicitly told so
  89. - borg info: fixed bug when called without arguments, #1914
  90. - borg init: fix free space check crashing if disk is full, #1821
  91. - borg debug delete/get obj: fix wrong reference to exception
  92. - fix processing of remote ~/ and ~user/ paths (regressed since 1.1.0b1), #1759
  93. New features:
  94. - new CRC32 implementations that are much faster than the zlib one used previously, #1970
  95. - add blake2b key modes (use blake2b as MAC). This links against system libb2,
  96. if possible, otherwise uses bundled code
  97. - automatically remove stale locks - set BORG_HOSTNAME_IS_UNIQUE env var
  98. to enable stale lock killing. If set, stale locks in both cache and
  99. repository are deleted. #562 #1253
  100. - borg info <repo>: print general repo information, #1680
  101. - borg check --first / --last / --sort / --prefix, #1663
  102. - borg mount --first / --last / --sort / --prefix, #1542
  103. - implement "health" item formatter key, #1749
  104. - BORG_SECURITY_DIR to remember security related infos outside the cache.
  105. Key type, location and manifest timestamp checks now survive cache
  106. deletion. This also means that you can now delete your cache and avoid
  107. previous warnings, since Borg can still tell it's safe.
  108. - implement BORG_NEW_PASSPHRASE, #1768
  109. Other changes:
  110. - borg recreate:
  111. - remove special-cased --dry-run
  112. - update --help
  113. - remove bloat: interruption blah, autocommit blah, resuming blah
  114. - re-use existing checkpoint functionality
  115. - archiver tests: add check_cache tool - lints refcounts
  116. - fixed cache sync performance regression from 1.1.0b1 onwards, #1940
  117. - syncing the cache without chunks.archive.d (see :ref:`disable_archive_chunks`)
  118. now avoids any merges and is thus faster, #1940
  119. - borg check --verify-data: faster due to linear on-disk-order scan
  120. - borg debug-xxx commands removed, we use "debug xxx" subcommands now, #1627
  121. - improve metadata handling speed
  122. - shortcut hashindex_set by having hashindex_lookup hint about address
  123. - improve / add progress displays, #1721
  124. - check for index vs. segment files object count mismatch
  125. - make RPC protocol more extensible: use named parameters.
  126. - RemoteRepository: misc. code cleanups / refactors
  127. - clarify cache/repository README file
  128. - docs:
  129. - quickstart: add a comment about other (remote) filesystems
  130. - quickstart: only give one possible ssh url syntax, all others are
  131. documented in usage chapter.
  132. - mention file://
  133. - document repo URLs / archive location
  134. - clarify borg diff help, #980
  135. - deployment: synthesize alternative --restrict-to-path example
  136. - improve cache / index docs, esp. files cache docs, #1825
  137. - document using "git merge 1.0-maint -s recursive -X rename-threshold=20%"
  138. for avoiding troubles when merging the 1.0-maint branch into master.
  139. - tests:
  140. - fuse tests: catch ENOTSUP on freebsd
  141. - fuse tests: test troublesome xattrs last
  142. - fix byte range error in test, #1740
  143. - use monkeypatch to set env vars, but only on pytest based tests.
  144. - point XDG_*_HOME to temp dirs for tests, #1714
  145. - remove all BORG_* env vars from the outer environment
  146. Version 1.0.10rc1 (not released yet)
  147. ------------------------------------
  148. Bug fixes:
  149. - borg serve: fix transmission data loss of pipe writes, #1268
  150. This affects only the cygwin platform (not Linux, *BSD, OS X).
  151. - Avoid triggering an ObjectiveFS bug in xattr retrieval, #1992
  152. - When running out of buffer memory when reading xattrs, only skip the
  153. current file, #1993
  154. - Fixed "borg upgrade --tam" crashing with unencrypted repositories. Since
  155. :ref:`the issue <tam_vuln>` is not relevant for unencrypted repositories,
  156. it now does nothing and prints an error, #1981.
  157. - Fixed change-passphrase crashing with unencrypted repositories, #1978
  158. - Fixed "borg check repo::archive" indicating success if "archive" does not exist, #1997
  159. - borg check: print non-exit-code warning if --last or --prefix aren't fulfilled
  160. Other changes:
  161. - xattr: ignore empty names returned by llistxattr(2) et al
  162. - Enable the fault handler: install handlers for the SIGSEGV, SIGFPE, SIGABRT,
  163. SIGBUS and SIGILL signals to dump the Python traceback.
  164. - Also print a traceback on SIGUSR2.
  165. - borg change-passphrase: print key location (simplify making a backup of it)
  166. - officially support Python 3.6 (setup.py: add Python 3.6 qualifier)
  167. - tests:
  168. - vagrant / travis / tox: add Python 3.6 based testing
  169. - vagrant: fix openbsd repo, fixes #2042
  170. - vagrant: fix the freebsd64 machine, #2037
  171. - travis: fix osxfuse install (fixes OS X testing on Travis CI)
  172. - travis: require succeeding OS X tests, #2028
  173. - travis: use latest pythons for OS X based testing
  174. - use pytest-xdist to parallelize testing
  175. - fix xattr test race condition, #2047
  176. - setup.cfg: fix pytest deprecation warning, #2050
  177. - docs:
  178. - language clarification - VM backup FAQ
  179. - borg create: document how to backup stdin, #2013
  180. - borg upgrade: fix incorrect title levels
  181. - fix typos (taken from Debian package patch)
  182. - remote: include data hexdump in "unexpected RPC data" error message
  183. - remote: log SSH command line at debug level
  184. - API_VERSION: use numberspaces, #2023
  185. - remove .github from pypi package, #2051
  186. - add pip and setuptools to requirements file, #2030
  187. Version 1.0.9 (2016-12-20)
  188. --------------------------
  189. Security fixes:
  190. - A flaw in the cryptographic authentication scheme in Borg allowed an attacker
  191. to spoof the manifest. See :ref:`tam_vuln` above for the steps you should
  192. take.
  193. - borg check: When rebuilding the manifest (which should only be needed very rarely)
  194. duplicate archive names would be handled on a "first come first serve" basis, allowing
  195. an attacker to apparently replace archives.
  196. Bug fixes:
  197. - borg check:
  198. - rebuild manifest if it's corrupted
  199. - skip corrupted chunks during manifest rebuild
  200. - fix TypeError in integrity error handler, #1903, #1894
  201. - fix location parser for archives with @ char (regression introduced in 1.0.8), #1930
  202. - fix wrong duration/timestamps if system clock jumped during a create
  203. - fix progress display not updating if system clock jumps backwards
  204. - fix checkpoint interval being incorrect if system clock jumps
  205. Other changes:
  206. - docs:
  207. - add python3-devel as a dependency for cygwin-based installation
  208. - clarify extract is relative to current directory
  209. - FAQ: fix link to changelog
  210. - markup fixes
  211. - tests:
  212. - test_get\_(cache|keys)_dir: clean env state, #1897
  213. - get back pytest's pretty assertion failures, #1938
  214. - setup.py build_usage:
  215. - fixed build_usage not processing all commands
  216. - fixed build_usage not generating includes for debug commands
  217. Version 1.0.9rc1 (2016-11-27)
  218. -----------------------------
  219. Bug fixes:
  220. - files cache: fix determination of newest mtime in backup set (which is
  221. used in cache cleanup and led to wrong "A" [added] status for unchanged
  222. files in next backup), #1860.
  223. - borg check:
  224. - fix incorrectly reporting attic 0.13 and earlier archives as corrupt
  225. - handle repo w/o objects gracefully and also bail out early if repo is
  226. *completely* empty, #1815.
  227. - fix tox/pybuild in 1.0-maint
  228. - at xattr module import time, loggers are not initialized yet
  229. New features:
  230. - borg umount <mountpoint>
  231. exposed already existing umount code via the CLI api, so users can use it,
  232. which is more consistent than using borg to mount and fusermount -u (or
  233. umount) to un-mount, #1855.
  234. - implement borg create --noatime --noctime, fixes #1853
  235. Other changes:
  236. - docs:
  237. - display README correctly on PyPI
  238. - improve cache / index docs, esp. files cache docs, fixes #1825
  239. - different pattern matching for --exclude, #1779
  240. - datetime formatting examples for {now} placeholder, #1822
  241. - clarify passphrase mode attic repo upgrade, #1854
  242. - clarify --umask usage, #1859
  243. - clarify how to choose PR target branch
  244. - clarify prune behavior for different archive contents, #1824
  245. - fix PDF issues, add logo, fix authors, headings, TOC
  246. - move security verification to support section
  247. - fix links in standalone README (:ref: tags)
  248. - add link to security contact in README
  249. - add FAQ about security
  250. - move fork differences to FAQ
  251. - add more details about resource usage
  252. - tests: skip remote tests on cygwin, #1268
  253. - travis:
  254. - allow OS X failures until the brew cask osxfuse issue is fixed
  255. - caskroom osxfuse-beta gone, it's osxfuse now (3.5.3)
  256. - vagrant:
  257. - upgrade OSXfuse / FUSE for macOS to 3.5.3
  258. - remove llfuse from tox.ini at a central place
  259. - do not try to install llfuse on centos6
  260. - fix fuse test for darwin, #1546
  261. - add windows virtual machine with cygwin
  262. - Vagrantfile cleanup / code deduplication
  263. Version 1.1.0b2 (2016-10-01)
  264. ----------------------------
  265. Bug fixes:
  266. - fix incorrect preservation of delete tags, leading to "object count mismatch"
  267. on borg check, #1598. This only occurred with 1.1.0b1 (not with 1.0.x) and is
  268. normally fixed by running another borg create/delete/prune.
  269. - fix broken --progress for double-cell paths (e.g. CJK), #1624
  270. - borg recreate: also catch SIGHUP
  271. - FUSE:
  272. - fix hardlinks in versions view, #1599
  273. - add parameter check to ItemCache.get to make potential failures more clear
  274. New features:
  275. - Archiver, RemoteRepository: add --remote-ratelimit (send data)
  276. - borg help compression, #1582
  277. - borg check: delete chunks with integrity errors, #1575, so they can be
  278. "repaired" immediately and maybe healed later.
  279. - archives filters concept (refactoring/unifying older code)
  280. - covers --first/--last/--prefix/--sort-by options
  281. - currently used for borg list/info/delete
  282. Other changes:
  283. - borg check --verify-data slightly tuned (use get_many())
  284. - change {utcnow} and {now} to ISO-8601 format ("T" date/time separator)
  285. - repo check: log transaction IDs, improve object count mismatch diagnostic
  286. - Vagrantfile: use TW's fresh-bootloader pyinstaller branch
  287. - fix module names in api.rst
  288. - hashindex: bump api_version
  289. Version 1.1.0b1 (2016-08-28)
  290. ----------------------------
  291. New features:
  292. - new commands:
  293. - borg recreate: re-create existing archives, #787 #686 #630 #70, also see
  294. #757, #770.
  295. - selectively remove files/dirs from old archives
  296. - re-compress data
  297. - re-chunkify data, e.g. to have upgraded Attic / Borg 0.xx archives
  298. deduplicate with Borg 1.x archives or to experiment with chunker-params.
  299. - borg diff: show differences between archives
  300. - borg with-lock: execute a command with the repository locked, #990
  301. - borg create:
  302. - Flexible compression with pattern matching on path/filename,
  303. and LZ4 heuristic for deciding compressibility, #810, #1007
  304. - visit files in inode order (better speed, esp. for large directories and rotating disks)
  305. - in-file checkpoints, #1217
  306. - increased default checkpoint interval to 30 minutes (was 5 minutes), #896
  307. - added uuid archive format tag, #1151
  308. - save mountpoint directories with --one-file-system, makes system restore easier, #1033
  309. - Linux: added support for some BSD flags, #1050
  310. - add 'x' status for excluded paths, #814
  311. - also means files excluded via UF_NODUMP, #1080
  312. - borg check:
  313. - will not produce the "Checking segments" output unless new --progress option is passed, #824.
  314. - --verify-data to verify data cryptographically on the client, #975
  315. - borg list, #751, #1179
  316. - removed {formatkeys}, see "borg list --help"
  317. - --list-format is deprecated, use --format instead
  318. - --format now also applies to listing archives, not only archive contents, #1179
  319. - now supports the usual [PATH [PATHS…]] syntax and excludes
  320. - new keys: csize, num_chunks, unique_chunks, NUL
  321. - supports guaranteed_available hashlib hashes
  322. (to avoid varying functionality depending on environment),
  323. which includes the SHA1 and SHA2 family as well as MD5
  324. - borg prune:
  325. - to better visualize the "thinning out", we now list all archives in
  326. reverse time order. rephrase and reorder help text.
  327. - implement --keep-last N via --keep-secondly N, also --keep-minutely.
  328. assuming that there is not more than 1 backup archive made in 1s,
  329. --keep-last N and --keep-secondly N are equivalent, #537
  330. - cleanup checkpoints except the latest, #1008
  331. - borg extract:
  332. - added --progress, #1449
  333. - Linux: limited support for BSD flags, #1050
  334. - borg info:
  335. - output is now more similar to borg create --stats, #977
  336. - borg mount:
  337. - provide "borgfs" wrapper for borg mount, enables usage via fstab, #743
  338. - "versions" mount option - when used with a repository mount, this gives
  339. a merged, versioned view of the files in all archives, #729
  340. - repository:
  341. - added progress information to commit/compaction phase (often takes some time when deleting/pruning), #1519
  342. - automatic recovery for some forms of repository inconsistency, #858
  343. - check free space before going forward with a commit, #1336
  344. - improved write performance (esp. for rotating media), #985
  345. - new IO code for Linux
  346. - raised default segment size to approx 512 MiB
  347. - improved compaction performance, #1041
  348. - reduced client CPU load and improved performance for remote repositories, #940
  349. - options that imply output (--show-rc, --show-version, --list, --stats,
  350. --progress) don't need -v/--info to have that output displayed, #865
  351. - add archive comments (via borg (re)create --comment), #842
  352. - borg list/prune/delete: also output archive id, #731
  353. - --show-version: shows/logs the borg version, #725
  354. - added --debug-topic for granular debug logging, #1447
  355. - use atomic file writing/updating for configuration and key files, #1377
  356. - BORG_KEY_FILE environment variable, #1001
  357. - self-testing module, #970
  358. Bug fixes:
  359. - list: fixed default output being produced if --format is given with empty parameter, #1489
  360. - create: fixed overflowing progress line with CJK and similar characters, #1051
  361. - prune: fixed crash if --prefix resulted in no matches, #1029
  362. - init: clean up partial repo if passphrase input is aborted, #850
  363. - info: quote cmdline arguments that have spaces in them
  364. - fix hardlinks failing in some cases for extracting subtrees, #761
  365. Other changes:
  366. - replace stdlib hmac with OpenSSL, zero-copy decrypt (10-15% increase in
  367. performance of hash-lists and extract).
  368. - improved chunker performance, #1021
  369. - open repository segment files in exclusive mode (fail-safe), #1134
  370. - improved error logging, #1440
  371. - Source:
  372. - pass meta-data around, #765
  373. - move some constants to new constants module
  374. - better readability and less errors with namedtuples, #823
  375. - moved source tree into src/ subdirectory, #1016
  376. - made borg.platform a package, #1113
  377. - removed dead crypto code, #1032
  378. - improved and ported parts of the test suite to py.test, #912
  379. - created data classes instead of passing dictionaries around, #981, #1158, #1161
  380. - cleaned up imports, #1112
  381. - Docs:
  382. - better help texts and sphinx reproduction of usage help:
  383. - Group options
  384. - Nicer list of options in Sphinx
  385. - Deduplicate 'Common options' (including --help)
  386. - chunker: added some insights by "Voltara", #903
  387. - clarify what "deduplicated size" means
  388. - fix / update / add package list entries
  389. - added a SaltStack usage example, #956
  390. - expanded FAQ
  391. - new contributors in AUTHORS!
  392. - Tests:
  393. - vagrant: add ubuntu/xenial 64bit - this box has still some issues
  394. - ChunkBuffer: add test for leaving partial chunk in buffer, fixes #945
  395. Version 1.0.8 (2016-10-29)
  396. --------------------------
  397. Bug fixes:
  398. - RemoteRepository: Fix busy wait in call_many, #940
  399. New features:
  400. - implement borgmajor/borgminor/borgpatch placeholders, #1694
  401. {borgversion} was already there (full version string). With the new
  402. placeholders you can now also get e.g. 1 or 1.0 or 1.0.8.
  403. Other changes:
  404. - avoid previous_location mismatch, #1741
  405. due to the changed canonicalization for relative pathes in PR #1711 / #1655
  406. (implement /./ relpath hack), there would be a changed repo location warning
  407. and the user would be asked if this is ok. this would break automation and
  408. require manual intervention, which is unwanted.
  409. thus, we automatically fix the previous_location config entry, if it only
  410. changed in the expected way, but still means the same location.
  411. - docs:
  412. - deployment.rst: do not use bare variables in ansible snippet
  413. - add clarification about append-only mode, #1689
  414. - setup.py: add comment about requiring llfuse, #1726
  415. - update usage.rst / api.rst
  416. - repo url / archive location docs + typo fix
  417. - quickstart: add a comment about other (remote) filesystems
  418. - vagrant / tests:
  419. - no chown when rsyncing (fixes boxes w/o vagrant group)
  420. - fix fuse permission issues on linux/freebsd, #1544
  421. - skip fuse test for borg binary + fakeroot
  422. - ignore security.selinux xattrs, fixes tests on centos, #1735
  423. Version 1.0.8rc1 (2016-10-17)
  424. -----------------------------
  425. Bug fixes:
  426. - fix signal handling (SIGINT, SIGTERM, SIGHUP), #1620 #1593
  427. Fixes e.g. leftover lock files for quickly repeated signals (e.g. Ctrl-C
  428. Ctrl-C) or lost connections or systemd sending SIGHUP.
  429. - progress display: adapt formatting to narrow screens, do not crash, #1628
  430. - borg create --read-special - fix crash on broken symlink, #1584.
  431. also correctly processes broken symlinks. before this regressed to a crash
  432. (5b45385) a broken symlink would've been skipped.
  433. - process_symlink: fix missing backup_io()
  434. Fixes a chmod/chown/chgrp/unlink/rename/... crash race between getting
  435. dirents and dispatching to process_symlink.
  436. - yes(): abort on wrong answers, saying so, #1622
  437. - fixed exception borg serve raised when connection was closed before reposiory
  438. was openend. add an error message for this.
  439. - fix read-from-closed-FD issue, #1551
  440. (this seems not to get triggered in 1.0.x, but was discovered in master)
  441. - hashindex: fix iterators (always raise StopIteration when exhausted)
  442. (this seems not to get triggered in 1.0.x, but was discovered in master)
  443. - enable relative pathes in ssh:// repo URLs, via /./relpath hack, #1655
  444. - allow repo pathes with colons, #1705
  445. - update changed repo location immediately after acceptance, #1524
  446. - fix debug get-obj / delete-obj crash if object not found and remote repo,
  447. #1684
  448. - pyinstaller: use a spec file to build borg.exe binary, exclude osxfuse dylib
  449. on Mac OS X (avoids mismatch lib <-> driver), #1619
  450. New features:
  451. - add "borg key export" / "borg key import" commands, #1555, so users are able
  452. to backup / restore their encryption keys more easily.
  453. Supported formats are the keyfile format used by borg internally and a
  454. special "paper" format with by line checksums for printed backups. For the
  455. paper format, the import is an interactive process which checks each line as
  456. soon as it is input.
  457. - add "borg debug-refcount-obj" to determine a repo objects' referrer counts,
  458. #1352
  459. Other changes:
  460. - add "borg debug ..." subcommands
  461. (borg debug-* still works, but will be removed in borg 1.1)
  462. - setup.py: Add subcommand support to build_usage.
  463. - remote: change exception message for unexpected RPC data format to indicate
  464. dataflow direction.
  465. - improved messages / error reporting:
  466. - IntegrityError: add placeholder for message, so that the message we give
  467. appears not only in the traceback, but also in the (short) error message,
  468. #1572
  469. - borg.key: include chunk id in exception msgs, #1571
  470. - better messages for cache newer than repo, #1700
  471. - vagrant (testing/build VMs):
  472. - upgrade OSXfuse / FUSE for macOS to 3.5.2
  473. - update Debian Wheezy boxes, #1686
  474. - openbsd / netbsd: use own boxes, fixes misc rsync installation and
  475. fuse/llfuse related testing issues, #1695 #1696 #1670 #1671 #1728
  476. - docs:
  477. - add docs for "key export" and "key import" commands, #1641
  478. - fix inconsistency in FAQ (pv-wrapper).
  479. - fix second block in "Easy to use" section not showing on GitHub, #1576
  480. - add bestpractices badge
  481. - link reference docs and faq about BORG_FILES_CACHE_TTL, #1561
  482. - improve borg info --help, explain size infos, #1532
  483. - add release signing key / security contact to README, #1560
  484. - add contribution guidelines for developers
  485. - development.rst: add sphinx_rtd_theme to the sphinx install command
  486. - adjust border color in borg.css
  487. - add debug-info usage help file
  488. - internals.rst: fix typos
  489. - setup.py: fix build_usage to always process all commands
  490. - added docs explaining multiple --restrict-to-path flags, #1602
  491. - add more specific warning about write-access debug commands, #1587
  492. - clarify FAQ regarding backup of virtual machines, #1672
  493. - tests:
  494. - work around fuse xattr test issue with recent fakeroot
  495. - simplify repo/hashindex tests
  496. - travis: test fuse-enabled borg, use trusty to have a recent FUSE
  497. - re-enable fuse tests for RemoteArchiver (no deadlocks any more)
  498. - clean env for pytest based tests, #1714
  499. - fuse_mount contextmanager: accept any options
  500. Version 1.0.7 (2016-08-19)
  501. --------------------------
  502. Security fixes:
  503. - borg serve: fix security issue with remote repository access, #1428
  504. If you used e.g. --restrict-to-path /path/client1/ (with or without trailing
  505. slash does not make a difference), it acted like a path prefix match using
  506. /path/client1 (note the missing trailing slash) - the code then also allowed
  507. working in e.g. /path/client13 or /path/client1000.
  508. As this could accidentally lead to major security/privacy issues depending on
  509. the pathes you use, the behaviour was changed to be a strict directory match.
  510. That means --restrict-to-path /path/client1 (with or without trailing slash
  511. does not make a difference) now uses /path/client1/ internally (note the
  512. trailing slash here!) for matching and allows precisely that path AND any
  513. path below it. So, /path/client1 is allowed, /path/client1/repo1 is allowed,
  514. but not /path/client13 or /path/client1000.
  515. If you willingly used the undocumented (dangerous) previous behaviour, you
  516. may need to rearrange your --restrict-to-path pathes now. We are sorry if
  517. that causes work for you, but we did not want a potentially dangerous
  518. behaviour in the software (not even using a for-backwards-compat option).
  519. Bug fixes:
  520. - fixed repeated LockTimeout exceptions when borg serve tried to write into
  521. a already write-locked repo (e.g. by a borg mount), #502 part b)
  522. This was solved by the fix for #1220 in 1.0.7rc1 already.
  523. - fix cosmetics + file leftover for "not a valid borg repository", #1490
  524. - Cache: release lock if cache is invalid, #1501
  525. - borg extract --strip-components: fix leak of preloaded chunk contents
  526. - Repository, when a InvalidRepository exception happens:
  527. - fix spurious, empty lock.roster
  528. - fix repo not closed cleanly
  529. New features:
  530. - implement borg debug-info, fixes #1122
  531. (just calls already existing code via cli, same output as below tracebacks)
  532. Other changes:
  533. - skip the O_NOATIME test on GNU Hurd, fixes #1315
  534. (this is a very minor issue and the GNU Hurd project knows the bug)
  535. - document using a clean repo to test / build the release
  536. Version 1.0.7rc2 (2016-08-13)
  537. -----------------------------
  538. Bug fixes:
  539. - do not write objects to repository that are bigger than the allowed size,
  540. borg will reject reading them, #1451.
  541. Important: if you created archives with many millions of files or
  542. directories, please verify if you can open them successfully,
  543. e.g. try a "borg list REPO::ARCHIVE".
  544. - lz4 compression: dynamically enlarge the (de)compression buffer, the static
  545. buffer was not big enough for archives with extremely many items, #1453
  546. - larger item metadata stream chunks, raise archive item limit by 8x, #1452
  547. - fix untracked segments made by moved DELETEs, #1442
  548. Impact: Previously (metadata) segments could become untracked when deleting data,
  549. these would never be cleaned up.
  550. - extended attributes (xattrs) related fixes:
  551. - fixed a race condition in xattrs querying that led to the entire file not
  552. being backed up (while logging the error, exit code = 1), #1469
  553. - fixed a race condition in xattrs querying that led to a crash, #1462
  554. - raise OSError including the error message derived from errno, deal with
  555. path being a integer FD
  556. Other changes:
  557. - print active env var override by default, #1467
  558. - xattr module: refactor code, deduplicate, clean up
  559. - repository: split object size check into too small and too big
  560. - add a transaction_id assertion, so borg init on a broken (inconsistent)
  561. filesystem does not look like a coding error in borg, but points to the
  562. real problem.
  563. - explain confusing TypeError caused by compat support for old servers, #1456
  564. - add forgotten usage help file from build_usage
  565. - refactor/unify buffer code into helpers.Buffer class, add tests
  566. - docs:
  567. - document archive limitation, #1452
  568. - improve prune examples
  569. Version 1.0.7rc1 (2016-08-05)
  570. -----------------------------
  571. Bug fixes:
  572. - fix repo lock deadlocks (related to lock upgrade), #1220
  573. - catch unpacker exceptions, resync, #1351
  574. - fix borg break-lock ignoring BORG_REPO env var, #1324
  575. - files cache performance fixes (fixes unneccessary re-reading/chunking/
  576. hashing of unmodified files for some use cases):
  577. - fix unintended file cache eviction, #1430
  578. - implement BORG_FILES_CACHE_TTL, update FAQ, raise default TTL from 10
  579. to 20, #1338
  580. - FUSE:
  581. - cache partially read data chunks (performance), #965, #966
  582. - always create a root dir, #1125
  583. - use an OrderedDict for helptext, making the build reproducible, #1346
  584. - RemoteRepository init: always call close on exceptions, #1370 (cosmetic)
  585. - ignore stdout/stderr broken pipe errors (cosmetic), #1116
  586. New features:
  587. - better borg versions management support (useful esp. for borg servers
  588. wanting to offer multiple borg versions and for clients wanting to choose
  589. a specific server borg version), #1392:
  590. - add BORG_VERSION environment variable before executing "borg serve" via ssh
  591. - add new placeholder {borgversion}
  592. - substitute placeholders in --remote-path
  593. - borg init --append-only option (makes using the more secure append-only mode
  594. more convenient. when used remotely, this requires 1.0.7+ also on the borg
  595. server), #1291.
  596. Other changes:
  597. - Vagrantfile:
  598. - darwin64: upgrade to FUSE for macOS 3.4.1 (aka osxfuse), #1378
  599. - xenial64: use user "ubuntu", not "vagrant" (as usual), #1331
  600. - tests:
  601. - fix fuse tests on OS X, #1433
  602. - docs:
  603. - FAQ: add backup using stable filesystem names recommendation
  604. - FAQ about glibc compatibility added, #491, glibc-check improved
  605. - FAQ: 'A' unchanged file; remove ambiguous entry age sentence.
  606. - OS X: install pkg-config to build with FUSE support, fixes #1400
  607. - add notes about shell/sudo pitfalls with env. vars, #1380
  608. - added platform feature matrix
  609. - implement borg debug-dump-repo-objs
  610. Version 1.0.6 (2016-07-12)
  611. --------------------------
  612. Bug fixes:
  613. - Linux: handle multiple LD_PRELOAD entries correctly, #1314, #1111
  614. - Fix crash with unclear message if the libc is not found, #1314, #1111
  615. Other changes:
  616. - tests:
  617. - Fixed O_NOATIME tests for Solaris and GNU Hurd, #1315
  618. - Fixed sparse file tests for (file) systems not supporting it, #1310
  619. - docs:
  620. - Fixed syntax highlighting, #1313
  621. - misc docs: added data processing overview picture
  622. Version 1.0.6rc1 (2016-07-10)
  623. -----------------------------
  624. New features:
  625. - borg check --repair: heal damaged files if missing chunks re-appear (e.g. if
  626. the previously missing chunk was added again in a later backup archive),
  627. #148. (*) Also improved logging.
  628. Bug fixes:
  629. - sync_dir: silence fsync() failing with EINVAL, #1287
  630. Some network filesystems (like smbfs) don't support this and we use this in
  631. repository code.
  632. - borg mount (FUSE):
  633. - fix directories being shadowed when contained paths were also specified,
  634. #1295
  635. - raise I/O Error (EIO) on damaged files (unless -o allow_damaged_files is
  636. used), #1302. (*)
  637. - borg extract: warn if a damaged file is extracted, #1299. (*)
  638. - Added some missing return code checks (ChunkIndex._add, hashindex_resize).
  639. - borg check: fix/optimize initial hash table size, avoids resize of the table.
  640. Other changes:
  641. - tests:
  642. - add more FUSE tests, #1284
  643. - deduplicate fuse (u)mount code
  644. - fix borg binary test issues, #862
  645. - docs:
  646. - changelog: added release dates to older borg releases
  647. - fix some sphinx (docs generator) warnings, #881
  648. Notes:
  649. (*) Some features depend on information (chunks_healthy list) added to item
  650. metadata when a file with missing chunks was "repaired" using all-zero
  651. replacement chunks. The chunks_healthy list is generated since borg 1.0.4,
  652. thus borg can't recognize such "repaired" (but content-damaged) files if the
  653. repair was done with an older borg version.
  654. Version 1.0.5 (2016-07-07)
  655. --------------------------
  656. Bug fixes:
  657. - borg mount: fix FUSE crash in xattr code on Linux introduced in 1.0.4, #1282
  658. Other changes:
  659. - backport some FAQ entries from master branch
  660. - add release helper scripts
  661. - Vagrantfile:
  662. - centos6: no FUSE, don't build binary
  663. - add xz for redhat-like dists
  664. Version 1.0.4 (2016-07-07)
  665. --------------------------
  666. New features:
  667. - borg serve --append-only, #1168
  668. This was included because it was a simple change (append-only functionality
  669. was already present via repository config file) and makes better security now
  670. practically usable.
  671. - BORG_REMOTE_PATH environment variable, #1258
  672. This was included because it was a simple change (--remote-path cli option
  673. was already present) and makes borg much easier to use if you need it.
  674. - Repository: cleanup incomplete transaction on "no space left" condition.
  675. In many cases, this can avoid a 100% full repo filesystem (which is very
  676. problematic as borg always needs free space - even to delete archives).
  677. Bug fixes:
  678. - Fix wrong handling and reporting of OSErrors in borg create, #1138.
  679. This was a serious issue: in the context of "borg create", errors like
  680. repository I/O errors (e.g. disk I/O errors, ssh repo connection errors)
  681. were handled badly and did not lead to a crash (which would be good for this
  682. case, because the repo transaction would be incomplete and trigger a
  683. transaction rollback to clean up).
  684. Now, error handling for source files is cleanly separated from every other
  685. error handling, so only problematic input files are logged and skipped.
  686. - Implement fail-safe error handling for borg extract.
  687. Note that this isn't nearly as critical as the borg create error handling
  688. bug, since nothing is written to the repo. So this was "merely" misleading
  689. error reporting.
  690. - Add missing error handler in directory attr restore loop.
  691. - repo: make sure write data hits disk before the commit tag (#1236) and also
  692. sync the containing directory.
  693. - FUSE: getxattr fail must use errno.ENOATTR, #1126
  694. (fixes Mac OS X Finder malfunction: "zero bytes" file length, access denied)
  695. - borg check --repair: do not lose information about the good/original chunks.
  696. If we do not lose the original chunk IDs list when "repairing" a file
  697. (replacing missing chunks with all-zero chunks), we have a chance to "heal"
  698. the file back into its original state later, in case the chunks re-appear
  699. (e.g. in a fresh backup). Healing is not implemented yet, see #148.
  700. - fixes for --read-special mode:
  701. - ignore known files cache, #1241
  702. - fake regular file mode, #1214
  703. - improve symlinks handling, #1215
  704. - remove passphrase from subprocess environment, #1105
  705. - Ignore empty index file (will trigger index rebuild), #1195
  706. - add missing placeholder support for --prefix, #1027
  707. - improve exception handling for placeholder replacement
  708. - catch and format exceptions in arg parsing
  709. - helpers: fix "undefined name 'e'" in exception handler
  710. - better error handling for missing repo manifest, #1043
  711. - borg delete:
  712. - make it possible to delete a repo without manifest
  713. - borg delete --forced allows to delete corrupted archives, #1139
  714. - borg check:
  715. - make borg check work for empty repo
  716. - fix resync and msgpacked item qualifier, #1135
  717. - rebuild_manifest: fix crash if 'name' or 'time' key were missing.
  718. - better validation of item metadata dicts, #1130
  719. - better validation of archive metadata dicts
  720. - close the repo on exit - even if rollback did not work, #1197.
  721. This is rather cosmetic, it avoids repo closing in the destructor.
  722. - tests:
  723. - fix sparse file test, #1170
  724. - flake8: ignore new F405, #1185
  725. - catch "invalid argument" on cygwin, #257
  726. - fix sparseness assertion in test prep, #1264
  727. Other changes:
  728. - make borg build/work on OpenSSL 1.0 and 1.1, #1187
  729. - docs / help:
  730. - fix / clarify prune help, #1143
  731. - fix "patterns" help formatting
  732. - add missing docs / help about placeholders
  733. - resources: rename atticmatic to borgmatic
  734. - document sshd settings, #545
  735. - more details about checkpoints, add split trick, #1171
  736. - support docs: add freenode web chat link, #1175
  737. - add prune visualization / example, #723
  738. - add note that Fnmatch is default, #1247
  739. - make clear that lzma levels > 6 are a waste of cpu cycles
  740. - add a "do not edit" note to auto-generated files, #1250
  741. - update cygwin installation docs
  742. - repository interoperability with borg master (1.1dev) branch:
  743. - borg check: read item metadata keys from manifest, #1147
  744. - read v2 hints files, #1235
  745. - fix hints file "unknown version" error handling bug
  746. - tests: add tests for format_line
  747. - llfuse: update version requirement for freebsd
  748. - Vagrantfile:
  749. - use openbsd 5.9, #716
  750. - do not install llfuse on netbsd (broken)
  751. - update OSXfuse to version 3.3.3
  752. - use Python 3.5.2 to build the binaries
  753. - glibc compatibility checker: scripts/glibc_check.py
  754. - add .eggs to .gitignore
  755. Version 1.0.3 (2016-05-20)
  756. --------------------------
  757. Bug fixes:
  758. - prune: avoid that checkpoints are kept and completed archives are deleted in
  759. a prune run), #997
  760. - prune: fix commandline argument validation - some valid command lines were
  761. considered invalid (annoying, but harmless), #942
  762. - fix capabilities extraction on Linux (set xattrs last, after chown()), #1069
  763. - repository: fix commit tags being seen in data
  764. - when probing key files, do binary reads. avoids crash when non-borg binary
  765. files are located in borg's key files directory.
  766. - handle SIGTERM and make a clean exit - avoids orphan lock files.
  767. - repository cache: don't cache large objects (avoid using lots of temp. disk
  768. space), #1063
  769. Other changes:
  770. - Vagrantfile: OS X: update osxfuse / install lzma package, #933
  771. - setup.py: add check for platform_darwin.c
  772. - setup.py: on freebsd, use a llfuse release that builds ok
  773. - docs / help:
  774. - update readthedocs URLs, #991
  775. - add missing docs for "borg break-lock", #992
  776. - borg create help: add some words to about the archive name
  777. - borg create help: document format tags, #894
  778. Version 1.0.2 (2016-04-16)
  779. --------------------------
  780. Bug fixes:
  781. - fix malfunction and potential corruption on (nowadays rather rare) big-endian
  782. architectures or bi-endian archs in (rare) BE mode. #886, #889
  783. cache resync / index merge was malfunctioning due to this, potentially
  784. leading to data loss. borg info had cosmetic issues (displayed wrong values).
  785. note: all (widespread) little-endian archs (like x86/x64) or bi-endian archs
  786. in (widespread) LE mode (like ARMEL, MIPSEL, ...) were NOT affected.
  787. - add overflow and range checks for 1st (special) uint32 of the hashindex
  788. values, switch from int32 to uint32.
  789. - fix so that refcount will never overflow, but just stick to max. value after
  790. a overflow would have occured.
  791. - borg delete: fix --cache-only for broken caches, #874
  792. Makes --cache-only idempotent: it won't fail if the cache is already deleted.
  793. - fixed borg create --one-file-system erroneously traversing into other
  794. filesystems (if starting fs device number was 0), #873
  795. - workround a bug in Linux fadvise FADV_DONTNEED, #907
  796. Other changes:
  797. - better test coverage for hashindex, incl. overflow testing, checking correct
  798. computations so endianness issues would be discovered.
  799. - reproducible doc for ProgressIndicator*, make the build reproducible.
  800. - use latest llfuse for vagrant machines
  801. - docs:
  802. - use /path/to/repo in examples, fixes #901
  803. - fix confusing usage of "repo" as archive name (use "arch")
  804. Version 1.0.1 (2016-04-08)
  805. --------------------------
  806. New features:
  807. Usually there are no new features in a bugfix release, but these were added
  808. due to their high impact on security/safety/speed or because they are fixes
  809. also:
  810. - append-only mode for repositories, #809, #36 (see docs)
  811. - borg create: add --ignore-inode option to make borg detect unmodified files
  812. even if your filesystem does not have stable inode numbers (like sshfs and
  813. possibly CIFS).
  814. - add options --warning, --error, --critical for missing log levels, #826.
  815. it's not recommended to suppress warnings or errors, but the user may decide
  816. this on his own.
  817. note: --warning is not given to borg serve so a <= 1.0.0 borg will still
  818. work as server (it is not needed as it is the default).
  819. do not use --error or --critical when using a <= 1.0.0 borg server.
  820. Bug fixes:
  821. - fix silently skipping EIO, #748
  822. - add context manager for Repository (avoid orphan repository locks), #285
  823. - do not sleep for >60s while waiting for lock, #773
  824. - unpack file stats before passing to FUSE
  825. - fix build on illumos
  826. - don't try to backup doors or event ports (Solaris and derivates)
  827. - remove useless/misleading libc version display, #738
  828. - test suite: reset exit code of persistent archiver, #844
  829. - RemoteRepository: clean up pipe if remote open() fails
  830. - Remote: don't print tracebacks for Error exceptions handled downstream, #792
  831. - if BORG_PASSPHRASE is present but wrong, don't prompt for password, but fail
  832. instead, #791
  833. - ArchiveChecker: move "orphaned objects check skipped" to INFO log level, #826
  834. - fix capitalization, add ellipses, change log level to debug for 2 messages,
  835. #798
  836. Other changes:
  837. - update llfuse requirement, llfuse 1.0 works
  838. - update OS / dist packages on build machines, #717
  839. - prefer showing --info over -v in usage help, #859
  840. - docs:
  841. - fix cygwin requirements (gcc-g++)
  842. - document how to debug / file filesystem issues, #664
  843. - fix reproducible build of api docs
  844. - RTD theme: CSS !important overwrite, #727
  845. - Document logo font. Recreate logo png. Remove GIMP logo file.
  846. Version 1.0.0 (2016-03-05)
  847. --------------------------
  848. The major release number change (0.x -> 1.x) indicates bigger incompatible
  849. changes, please read the compatibility notes, adapt / test your scripts and
  850. check your backup logs.
  851. Compatibility notes:
  852. - drop support for python 3.2 and 3.3, require 3.4 or 3.5, #221 #65 #490
  853. note: we provide binaries that include python 3.5.1 and everything else
  854. needed. they are an option in case you are stuck with < 3.4 otherwise.
  855. - change encryption to be on by default (using "repokey" mode)
  856. - moved keyfile keys from ~/.borg/keys to ~/.config/borg/keys,
  857. you can either move them manually or run "borg upgrade <REPO>"
  858. - remove support for --encryption=passphrase,
  859. use borg migrate-to-repokey to switch to repokey mode, #97
  860. - remove deprecated --compression <number>,
  861. use --compression zlib,<number> instead
  862. in case of 0, you could also use --compression none
  863. - remove deprecated --hourly/daily/weekly/monthly/yearly
  864. use --keep-hourly/daily/weekly/monthly/yearly instead
  865. - remove deprecated --do-not-cross-mountpoints,
  866. use --one-file-system instead
  867. - disambiguate -p option, #563:
  868. - -p now is same as --progress
  869. - -P now is same as --prefix
  870. - remove deprecated "borg verify",
  871. use "borg extract --dry-run" instead
  872. - cleanup environment variable semantics, #355
  873. the environment variables used to be "yes sayers" when set, this was
  874. conceptually generalized to "automatic answerers" and they just give their
  875. value as answer (as if you typed in that value when being asked).
  876. See the "usage" / "Environment Variables" section of the docs for details.
  877. - change the builtin default for --chunker-params, create 2MiB chunks, #343
  878. --chunker-params new default: 19,23,21,4095 - old default: 10,23,16,4095
  879. one of the biggest issues with borg < 1.0 (and also attic) was that it had a
  880. default target chunk size of 64kiB, thus it created a lot of chunks and thus
  881. also a huge chunk management overhead (high RAM and disk usage).
  882. please note that the new default won't change the chunks that you already
  883. have in your repository. the new big chunks do not deduplicate with the old
  884. small chunks, so expect your repo to grow at least by the size of every
  885. changed file and in the worst case (e.g. if your files cache was lost / is
  886. not used) by the size of every file (minus any compression you might use).
  887. in case you want to immediately see a much lower resource usage (RAM / disk)
  888. for chunks management, it might be better to start with a new repo than
  889. continuing in the existing repo (with an existing repo, you'ld have to wait
  890. until all archives with small chunks got pruned to see a lower resource
  891. usage).
  892. if you used the old --chunker-params default value (or if you did not use
  893. --chunker-params option at all) and you'ld like to continue using small
  894. chunks (and you accept the huge resource usage that comes with that), just
  895. explicitly use borg create --chunker-params=10,23,16,4095.
  896. - archive timestamps: the 'time' timestamp now refers to archive creation
  897. start time (was: end time), the new 'time_end' timestamp refers to archive
  898. creation end time. This might affect prune if your backups take rather long.
  899. if you give a timestamp via cli this is stored into 'time', therefore it now
  900. needs to mean archive creation start time.
  901. New features:
  902. - implement password roundtrip, #695
  903. Bug fixes:
  904. - remote end does not need cache nor keys directories, do not create them, #701
  905. - added retry counter for passwords, #703
  906. Other changes:
  907. - fix compiler warnings, #697
  908. - docs:
  909. - update README.rst to new changelog location in docs/changes.rst
  910. - add Teemu to AUTHORS
  911. - changes.rst: fix old chunker params, #698
  912. - FAQ: how to limit bandwidth
  913. Version 1.0.0rc2 (2016-02-28)
  914. -----------------------------
  915. New features:
  916. - format options for location: user, pid, fqdn, hostname, now, utcnow, user
  917. - borg list --list-format
  918. - borg prune -v --list enables the keep/prune list output, #658
  919. Bug fixes:
  920. - fix _open_rb noatime handling, #657
  921. - add a simple archivename validator, #680
  922. - borg create --stats: show timestamps in localtime, use same labels/formatting
  923. as borg info, #651
  924. - llfuse compatibility fixes (now compatible with: 0.40, 0.41, 0.42)
  925. Other changes:
  926. - it is now possible to use "pip install borgbackup[fuse]" to automatically
  927. install the llfuse dependency using the correct version requirement
  928. for it. you still need to care about having installed the FUSE / build
  929. related OS package first, though, so that building llfuse can succeed.
  930. - Vagrant: drop Ubuntu Precise (12.04) - does not have Python >= 3.4
  931. - Vagrant: use pyinstaller v3.1.1 to build binaries
  932. - docs:
  933. - borg upgrade: add to docs that only LOCAL repos are supported
  934. - borg upgrade also handles borg 0.xx -> 1.0
  935. - use pip extras or requirements file to install llfuse
  936. - fix order in release process
  937. - updated usage docs and other minor / cosmetic fixes
  938. - verified borg examples in docs, #644
  939. - freebsd dependency installation and fuse configuration, #649
  940. - add example how to restore a raw device, #671
  941. - add a hint about the dev headers needed when installing from source
  942. - add examples for delete (and handle delete after list, before prune), #656
  943. - update example for borg create -v --stats (use iso datetime format), #663
  944. - added example to BORG_RSH docs
  945. - "connection closed by remote": add FAQ entry and point to issue #636
  946. Version 1.0.0rc1 (2016-02-07)
  947. -----------------------------
  948. New features:
  949. - borg migrate-to-repokey ("passphrase" -> "repokey" encryption key mode)
  950. - implement --short for borg list REPO, #611
  951. - implement --list for borg extract (consistency with borg create)
  952. - borg serve: overwrite client's --restrict-to-path with ssh forced command's
  953. option value (but keep everything else from the client commandline), #544
  954. - use $XDG_CONFIG_HOME/keys for keyfile keys (~/.config/borg/keys), #515
  955. - "borg upgrade" moves the keyfile keys to the new location
  956. - display both archive creation start and end time in "borg info", #627
  957. Bug fixes:
  958. - normalize trailing slashes for the repository path, #606
  959. - Cache: fix exception handling in __init__, release lock, #610
  960. Other changes:
  961. - suppress unneeded exception context (PEP 409), simpler tracebacks
  962. - removed special code needed to deal with imperfections / incompatibilities /
  963. missing stuff in py 3.2/3.3, simplify code that can be done simpler in 3.4
  964. - removed some version requirements that were kept on old versions because
  965. newer did not support py 3.2 any more
  966. - use some py 3.4+ stdlib code instead of own/openssl/pypi code:
  967. - use os.urandom instead of own cython openssl RAND_bytes wrapper, #493
  968. - use hashlib.pbkdf2_hmac from py stdlib instead of own openssl wrapper
  969. - use hmac.compare_digest instead of == operator (constant time comparison)
  970. - use stat.filemode instead of homegrown code
  971. - use "mock" library from stdlib, #145
  972. - remove borg.support (with non-broken argparse copy), it is ok in 3.4+, #358
  973. - Vagrant: copy CHANGES.rst as symlink, #592
  974. - cosmetic code cleanups, add flake8 to tox/travis, #4
  975. - docs / help:
  976. - make "borg -h" output prettier, #591
  977. - slightly rephrase prune help
  978. - add missing example for --list option of borg create
  979. - quote exclude line that includes an asterisk to prevent shell expansion
  980. - fix dead link to license
  981. - delete Ubuntu Vivid, it is not supported anymore (EOL)
  982. - OS X binary does not work for older OS X releases, #629
  983. - borg serve's special support for forced/original ssh commands, #544
  984. - misc. updates and fixes
  985. Version 0.30.0 (2016-01-23)
  986. ---------------------------
  987. Compatibility notes:
  988. - you may need to use -v (or --info) more often to actually see output emitted
  989. at INFO log level (because it is suppressed at the default WARNING log level).
  990. See the "general" section in the usage docs.
  991. - for borg create, you need --list (additionally to -v) to see the long file
  992. list (was needed so you can have e.g. --stats alone without the long list)
  993. - see below about BORG_DELETE_I_KNOW_WHAT_I_AM_DOING (was:
  994. BORG_CHECK_I_KNOW_WHAT_I_AM_DOING)
  995. Bug fixes:
  996. - fix crash when using borg create --dry-run --keep-tag-files, #570
  997. - make sure teardown with cleanup happens for Cache and RepositoryCache,
  998. avoiding leftover locks and TEMP dir contents, #285 (partially), #548
  999. - fix locking KeyError, partial fix for #502
  1000. - log stats consistently, #526
  1001. - add abbreviated weekday to timestamp format, fixes #496
  1002. - strip whitespace when loading exclusions from file
  1003. - unset LD_LIBRARY_PATH before invoking ssh, fixes strange OpenSSL library
  1004. version warning when using the borg binary, #514
  1005. - add some error handling/fallback for C library loading, #494
  1006. - added BORG_DELETE_I_KNOW_WHAT_I_AM_DOING for check in "borg delete", #503
  1007. - remove unused "repair" rpc method name
  1008. New features:
  1009. - borg create: implement exclusions using regular expression patterns.
  1010. - borg create: implement inclusions using patterns.
  1011. - borg extract: support patterns, #361
  1012. - support different styles for patterns:
  1013. - fnmatch (`fm:` prefix, default when omitted), like borg <= 0.29.
  1014. - shell (`sh:` prefix) with `*` not matching directory separators and
  1015. `**/` matching 0..n directories
  1016. - path prefix (`pp:` prefix, for unifying borg create pp1 pp2 into the
  1017. patterns system), semantics like in borg <= 0.29
  1018. - regular expression (`re:`), new!
  1019. - --progress option for borg upgrade (#291) and borg delete <archive>
  1020. - update progress indication more often (e.g. for borg create within big
  1021. files or for borg check repo), #500
  1022. - finer chunker granularity for items metadata stream, #547, #487
  1023. - borg create --list now used (additionally to -v) to enable the verbose
  1024. file list output
  1025. - display borg version below tracebacks, #532
  1026. Other changes:
  1027. - hashtable size (and thus: RAM and disk consumption) follows a growth policy:
  1028. grows fast while small, grows slower when getting bigger, #527
  1029. - Vagrantfile: use pyinstaller 3.1 to build binaries, freebsd sqlite3 fix,
  1030. fixes #569
  1031. - no separate binaries for centos6 any more because the generic linux binaries
  1032. also work on centos6 (or in general: on systems with a slightly older glibc
  1033. than debian7
  1034. - dev environment: require virtualenv<14.0 so we get a py32 compatible pip
  1035. - docs:
  1036. - add space-saving chunks.archive.d trick to FAQ
  1037. - important: clarify -v and log levels in usage -> general, please read!
  1038. - sphinx configuration: create a simple man page from usage docs
  1039. - add a repo server setup example
  1040. - disable unneeded SSH features in authorized_keys examples for security.
  1041. - borg prune only knows "--keep-within" and not "--within"
  1042. - add gource video to resources docs, #507
  1043. - add netbsd install instructions
  1044. - authors: make it more clear what refers to borg and what to attic
  1045. - document standalone binary requirements, #499
  1046. - rephrase the mailing list section
  1047. - development docs: run build_api and build_usage before tagging release
  1048. - internals docs: hash table max. load factor is 0.75 now
  1049. - markup, typo, grammar, phrasing, clarifications and other fixes.
  1050. - add gcc gcc-c++ to redhat/fedora/corora install docs, fixes #583
  1051. Version 0.29.0 (2015-12-13)
  1052. ---------------------------
  1053. Compatibility notes:
  1054. - when upgrading to 0.29.0 you need to upgrade client as well as server
  1055. installations due to the locking and commandline interface changes otherwise
  1056. you'll get an error msg about a RPC protocol mismatch or a wrong commandline
  1057. option.
  1058. if you run a server that needs to support both old and new clients, it is
  1059. suggested that you have a "borg-0.28.2" and a "borg-0.29.0" command.
  1060. clients then can choose via e.g. "borg --remote-path=borg-0.29.0 ...".
  1061. - the default waiting time for a lock changed from infinity to 1 second for a
  1062. better interactive user experience. if the repo you want to access is
  1063. currently locked, borg will now terminate after 1s with an error message.
  1064. if you have scripts that shall wait for the lock for a longer time, use
  1065. --lock-wait N (with N being the maximum wait time in seconds).
  1066. Bug fixes:
  1067. - hash table tuning (better chosen hashtable load factor 0.75 and prime initial
  1068. size of 1031 gave ~1000x speedup in some scenarios)
  1069. - avoid creation of an orphan lock for one case, #285
  1070. - --keep-tag-files: fix file mode and multiple tag files in one directory, #432
  1071. - fixes for "borg upgrade" (attic repo converter), #466
  1072. - remove --progress isatty magic (and also --no-progress option) again, #476
  1073. - borg init: display proper repo URL
  1074. - fix format of umask in help pages, #463
  1075. New features:
  1076. - implement --lock-wait, support timeout for UpgradableLock, #210
  1077. - implement borg break-lock command, #157
  1078. - include system info below traceback, #324
  1079. - sane remote logging, remote stderr, #461:
  1080. - remote log output: intercept it and log it via local logging system,
  1081. with "Remote: " prefixed to message. log remote tracebacks.
  1082. - remote stderr: output it to local stderr with "Remote: " prefixed.
  1083. - add --debug and --info (same as --verbose) to set the log level of the
  1084. builtin logging configuration (which otherwise defaults to warning), #426
  1085. note: there are few messages emitted at DEBUG level currently.
  1086. - optionally configure logging via env var BORG_LOGGING_CONF
  1087. - add --filter option for status characters: e.g. to show only the added
  1088. or modified files (and also errors), use "borg create -v --filter=AME ...".
  1089. - more progress indicators, #394
  1090. - use ISO-8601 date and time format, #375
  1091. - "borg check --prefix" to restrict archive checking to that name prefix, #206
  1092. Other changes:
  1093. - hashindex_add C implementation (speed up cache re-sync for new archives)
  1094. - increase FUSE read_size to 1024 (speed up metadata operations)
  1095. - check/delete/prune --save-space: free unused segments quickly, #239
  1096. - increase rpc protocol version to 2 (see also Compatibility notes), #458
  1097. - silence borg by default (via default log level WARNING)
  1098. - get rid of C compiler warnings, #391
  1099. - upgrade OS X FUSE to 3.0.9 on the OS X binary build system
  1100. - use python 3.5.1 to build binaries
  1101. - docs:
  1102. - new mailing list borgbackup@python.org, #468
  1103. - readthedocs: color and logo improvements
  1104. - load coverage icons over SSL (avoids mixed content)
  1105. - more precise binary installation steps
  1106. - update release procedure docs about OS X FUSE
  1107. - FAQ entry about unexpected 'A' status for unchanged file(s), #403
  1108. - add docs about 'E' file status
  1109. - add "borg upgrade" docs, #464
  1110. - add developer docs about output and logging
  1111. - clarify encryption, add note about client-side encryption
  1112. - add resources section, with videos, talks, presentations, #149
  1113. - Borg moved to Arch Linux [community]
  1114. - fix wrong installation instructions for archlinux
  1115. Version 0.28.2 (2015-11-15)
  1116. ---------------------------
  1117. New features:
  1118. - borg create --exclude-if-present TAGFILE - exclude directories that have the
  1119. given file from the backup. You can additionally give --keep-tag-files to
  1120. preserve just the directory roots and the tag-files (but not backup other
  1121. directory contents), #395, attic #128, attic #142
  1122. Other changes:
  1123. - do not create docs sources at build time (just have them in the repo),
  1124. completely remove have_cython() hack, do not use the "mock" library at build
  1125. time, #384
  1126. - avoid hidden import, make it easier for PyInstaller, easier fix for #218
  1127. - docs:
  1128. - add description of item flags / status output, fixes #402
  1129. - explain how to regenerate usage and API files (build_api or
  1130. build_usage) and when to commit usage files directly into git, #384
  1131. - minor install docs improvements
  1132. Version 0.28.1 (2015-11-08)
  1133. ---------------------------
  1134. Bug fixes:
  1135. - do not try to build api / usage docs for production install,
  1136. fixes unexpected "mock" build dependency, #384
  1137. Other changes:
  1138. - avoid using msgpack.packb at import time
  1139. - fix formatting issue in changes.rst
  1140. - fix build on readthedocs
  1141. Version 0.28.0 (2015-11-08)
  1142. ---------------------------
  1143. Compatibility notes:
  1144. - changed return codes (exit codes), see docs. in short:
  1145. old: 0 = ok, 1 = error. now: 0 = ok, 1 = warning, 2 = error
  1146. New features:
  1147. - refactor return codes (exit codes), fixes #61
  1148. - add --show-rc option enable "terminating with X status, rc N" output, fixes 58, #351
  1149. - borg create backups atime and ctime additionally to mtime, fixes #317
  1150. - extract: support atime additionally to mtime
  1151. - FUSE: support ctime and atime additionally to mtime
  1152. - support borg --version
  1153. - emit a warning if we have a slow msgpack installed
  1154. - borg list --prefix=thishostname- REPO, fixes #205
  1155. - Debug commands (do not use except if you know what you do: debug-get-obj,
  1156. debug-put-obj, debug-delete-obj, debug-dump-archive-items.
  1157. Bug fixes:
  1158. - setup.py: fix bug related to BORG_LZ4_PREFIX processing
  1159. - fix "check" for repos that have incomplete chunks, fixes #364
  1160. - borg mount: fix unlocking of repository at umount time, fixes #331
  1161. - fix reading files without touching their atime, #334
  1162. - non-ascii ACL fixes for Linux, FreeBSD and OS X, #277
  1163. - fix acl_use_local_uid_gid() and add a test for it, attic #359
  1164. - borg upgrade: do not upgrade repositories in place by default, #299
  1165. - fix cascading failure with the index conversion code, #269
  1166. - borg check: implement 'cmdline' archive metadata value decoding, #311
  1167. - fix RobustUnpacker, it missed some metadata keys (new atime and ctime keys
  1168. were missing, but also bsdflags). add check for unknown metadata keys.
  1169. - create from stdin: also save atime, ctime (cosmetic)
  1170. - use default_notty=False for confirmations, fixes #345
  1171. - vagrant: fix msgpack installation on centos, fixes #342
  1172. - deal with unicode errors for symlinks in same way as for regular files and
  1173. have a helpful warning message about how to fix wrong locale setup, fixes #382
  1174. - add ACL keys the RobustUnpacker must know about
  1175. Other changes:
  1176. - improve file size displays, more flexible size formatters
  1177. - explicitly commit to the units standard, #289
  1178. - archiver: add E status (means that an error occurred when processing this
  1179. (single) item
  1180. - do binary releases via "github releases", closes #214
  1181. - create: use -x and --one-file-system (was: --do-not-cross-mountpoints), #296
  1182. - a lot of changes related to using "logging" module and screen output, #233
  1183. - show progress display if on a tty, output more progress information, #303
  1184. - factor out status output so it is consistent, fix surrogates removal,
  1185. maybe fixes #309
  1186. - move away from RawConfigParser to ConfigParser
  1187. - archive checker: better error logging, give chunk_id and sequence numbers
  1188. (can be used together with borg debug-dump-archive-items).
  1189. - do not mention the deprecated passphrase mode
  1190. - emit a deprecation warning for --compression N (giving a just a number)
  1191. - misc .coverragerc fixes (and coverage measurement improvements), fixes #319
  1192. - refactor confirmation code, reduce code duplication, add tests
  1193. - prettier error messages, fixes #307, #57
  1194. - tests:
  1195. - add a test to find disk-full issues, #327
  1196. - travis: also run tests on Python 3.5
  1197. - travis: use tox -r so it rebuilds the tox environments
  1198. - test the generated pyinstaller-based binary by archiver unit tests, #215
  1199. - vagrant: tests: announce whether fakeroot is used or not
  1200. - vagrant: add vagrant user to fuse group for debianoid systems also
  1201. - vagrant: llfuse install on darwin needs pkgconfig installed
  1202. - vagrant: use pyinstaller from develop branch, fixes #336
  1203. - benchmarks: test create, extract, list, delete, info, check, help, fixes #146
  1204. - benchmarks: test with both the binary and the python code
  1205. - archiver tests: test with both the binary and the python code, fixes #215
  1206. - make basic test more robust
  1207. - docs:
  1208. - moved docs to borgbackup.readthedocs.org, #155
  1209. - a lot of fixes and improvements, use mobile-friendly RTD standard theme
  1210. - use zlib,6 compression in some examples, fixes #275
  1211. - add missing rename usage to docs, closes #279
  1212. - include the help offered by borg help <topic> in the usage docs, fixes #293
  1213. - include a list of major changes compared to attic into README, fixes #224
  1214. - add OS X install instructions, #197
  1215. - more details about the release process, #260
  1216. - fix linux glibc requirement (binaries built on debian7 now)
  1217. - build: move usage and API generation to setup.py
  1218. - update docs about return codes, #61
  1219. - remove api docs (too much breakage on rtd)
  1220. - borgbackup install + basics presentation (asciinema)
  1221. - describe the current style guide in documentation
  1222. - add section about debug commands
  1223. - warn about not running out of space
  1224. - add example for rename
  1225. - improve chunker params docs, fixes #362
  1226. - minor development docs update
  1227. Version 0.27.0 (2015-10-07)
  1228. ---------------------------
  1229. New features:
  1230. - "borg upgrade" command - attic -> borg one time converter / migration, #21
  1231. - temporary hack to avoid using lots of disk space for chunks.archive.d, #235:
  1232. To use it: rm -rf chunks.archive.d ; touch chunks.archive.d
  1233. - respect XDG_CACHE_HOME, attic #181
  1234. - add support for arbitrary SSH commands, attic #99
  1235. - borg delete --cache-only REPO (only delete cache, not REPO), attic #123
  1236. Bug fixes:
  1237. - use Debian 7 (wheezy) to build pyinstaller borgbackup binaries, fixes slow
  1238. down observed when running the Centos6-built binary on Ubuntu, #222
  1239. - do not crash on empty lock.roster, fixes #232
  1240. - fix multiple issues with the cache config version check, #234
  1241. - fix segment entry header size check, attic #352
  1242. plus other error handling improvements / code deduplication there.
  1243. - always give segment and offset in repo IntegrityErrors
  1244. Other changes:
  1245. - stop producing binary wheels, remove docs about it, #147
  1246. - docs:
  1247. - add warning about prune
  1248. - generate usage include files only as needed
  1249. - development docs: add Vagrant section
  1250. - update / improve / reformat FAQ
  1251. - hint to single-file pyinstaller binaries from README
  1252. Version 0.26.1 (2015-09-28)
  1253. ---------------------------
  1254. This is a minor update, just docs and new pyinstaller binaries.
  1255. - docs update about python and binary requirements
  1256. - better docs for --read-special, fix #220
  1257. - re-built the binaries, fix #218 and #213 (glibc version issue)
  1258. - update web site about single-file pyinstaller binaries
  1259. Note: if you did a python-based installation, there is no need to upgrade.
  1260. Version 0.26.0 (2015-09-19)
  1261. ---------------------------
  1262. New features:
  1263. - Faster cache sync (do all in one pass, remove tar/compression stuff), #163
  1264. - BORG_REPO env var to specify the default repo, #168
  1265. - read special files as if they were regular files, #79
  1266. - implement borg create --dry-run, attic issue #267
  1267. - Normalize paths before pattern matching on OS X, #143
  1268. - support OpenBSD and NetBSD (except xattrs/ACLs)
  1269. - support / run tests on Python 3.5
  1270. Bug fixes:
  1271. - borg mount repo: use absolute path, attic #200, attic #137
  1272. - chunker: use off_t to get 64bit on 32bit platform, #178
  1273. - initialize chunker fd to -1, so it's not equal to STDIN_FILENO (0)
  1274. - fix reaction to "no" answer at delete repo prompt, #182
  1275. - setup.py: detect lz4.h header file location
  1276. - to support python < 3.2.4, add less buggy argparse lib from 3.2.6 (#194)
  1277. - fix for obtaining ``char *`` from temporary Python value (old code causes
  1278. a compile error on Mint 17.2)
  1279. - llfuse 0.41 install troubles on some platforms, require < 0.41
  1280. (UnicodeDecodeError exception due to non-ascii llfuse setup.py)
  1281. - cython code: add some int types to get rid of unspecific python add /
  1282. subtract operations (avoid ``undefined symbol FPE_``... error on some platforms)
  1283. - fix verbose mode display of stdin backup
  1284. - extract: warn if a include pattern never matched, fixes #209,
  1285. implement counters for Include/ExcludePatterns
  1286. - archive names with slashes are invalid, attic issue #180
  1287. - chunker: add a check whether the POSIX_FADV_DONTNEED constant is defined -
  1288. fixes building on OpenBSD.
  1289. Other changes:
  1290. - detect inconsistency / corruption / hash collision, #170
  1291. - replace versioneer with setuptools_scm, #106
  1292. - docs:
  1293. - pkg-config is needed for llfuse installation
  1294. - be more clear about pruning, attic issue #132
  1295. - unit tests:
  1296. - xattr: ignore security.selinux attribute showing up
  1297. - ext3 seems to need a bit more space for a sparse file
  1298. - do not test lzma level 9 compression (avoid MemoryError)
  1299. - work around strange mtime granularity issue on netbsd, fixes #204
  1300. - ignore st_rdev if file is not a block/char device, fixes #203
  1301. - stay away from the setgid and sticky mode bits
  1302. - use Vagrant to do easy cross-platform testing (#196), currently:
  1303. - Debian 7 "wheezy" 32bit, Debian 8 "jessie" 64bit
  1304. - Ubuntu 12.04 32bit, Ubuntu 14.04 64bit
  1305. - Centos 7 64bit
  1306. - FreeBSD 10.2 64bit
  1307. - OpenBSD 5.7 64bit
  1308. - NetBSD 6.1.5 64bit
  1309. - Darwin (OS X Yosemite)
  1310. Version 0.25.0 (2015-08-29)
  1311. ---------------------------
  1312. Compatibility notes:
  1313. - lz4 compression library (liblz4) is a new requirement (#156)
  1314. - the new compression code is very compatible: as long as you stay with zlib
  1315. compression, older borg releases will still be able to read data from a
  1316. repo/archive made with the new code (note: this is not the case for the
  1317. default "none" compression, use "zlib,0" if you want a "no compression" mode
  1318. that can be read by older borg). Also the new code is able to read repos and
  1319. archives made with older borg versions (for all zlib levels 0..9).
  1320. Deprecations:
  1321. - --compression N (with N being a number, as in 0.24) is deprecated.
  1322. We keep the --compression 0..9 for now to not break scripts, but it is
  1323. deprecated and will be removed later, so better fix your scripts now:
  1324. --compression 0 (as in 0.24) is the same as --compression zlib,0 (now).
  1325. BUT: if you do not want compression, you rather want --compression none
  1326. (which is the default).
  1327. --compression 1 (in 0.24) is the same as --compression zlib,1 (now)
  1328. --compression 9 (in 0.24) is the same as --compression zlib,9 (now)
  1329. New features:
  1330. - create --compression none (default, means: do not compress, just pass through
  1331. data "as is". this is more efficient than zlib level 0 as used in borg 0.24)
  1332. - create --compression lz4 (super-fast, but not very high compression)
  1333. - create --compression zlib,N (slower, higher compression, default for N is 6)
  1334. - create --compression lzma,N (slowest, highest compression, default N is 6)
  1335. - honor the nodump flag (UF_NODUMP) and do not backup such items
  1336. - list --short just outputs a simple list of the files/directories in an archive
  1337. Bug fixes:
  1338. - fixed --chunker-params parameter order confusion / malfunction, fixes #154
  1339. - close fds of segments we delete (during compaction)
  1340. - close files which fell out the lrucache
  1341. - fadvise DONTNEED now is only called for the byte range actually read, not for
  1342. the whole file, fixes #158.
  1343. - fix issue with negative "all archives" size, fixes #165
  1344. - restore_xattrs: ignore if setxattr fails with EACCES, fixes #162
  1345. Other changes:
  1346. - remove fakeroot requirement for tests, tests run faster without fakeroot
  1347. (test setup does not fail any more without fakeroot, so you can run with or
  1348. without fakeroot), fixes #151 and #91.
  1349. - more tests for archiver
  1350. - recover_segment(): don't assume we have an fd for segment
  1351. - lrucache refactoring / cleanup, add dispose function, py.test tests
  1352. - generalize hashindex code for any key length (less hardcoding)
  1353. - lock roster: catch file not found in remove() method and ignore it
  1354. - travis CI: use requirements file
  1355. - improved docs:
  1356. - replace hack for llfuse with proper solution (install libfuse-dev)
  1357. - update docs about compression
  1358. - update development docs about fakeroot
  1359. - internals: add some words about lock files / locking system
  1360. - support: mention BountySource and for what it can be used
  1361. - theme: use a lighter green
  1362. - add pypi, wheel, dist package based install docs
  1363. - split install docs into system-specific preparations and generic instructions
  1364. Version 0.24.0 (2015-08-09)
  1365. ---------------------------
  1366. Incompatible changes (compared to 0.23):
  1367. - borg now always issues --umask NNN option when invoking another borg via ssh
  1368. on the repository server. By that, it's making sure it uses the same umask
  1369. for remote repos as for local ones. Because of this, you must upgrade both
  1370. server and client(s) to 0.24.
  1371. - the default umask is 077 now (if you do not specify via --umask) which might
  1372. be a different one as you used previously. The default umask avoids that
  1373. you accidentally give access permissions for group and/or others to files
  1374. created by borg (e.g. the repository).
  1375. Deprecations:
  1376. - "--encryption passphrase" mode is deprecated, see #85 and #97.
  1377. See the new "--encryption repokey" mode for a replacement.
  1378. New features:
  1379. - borg create --chunker-params ... to configure the chunker, fixes #16
  1380. (attic #302, attic #300, and somehow also #41).
  1381. This can be used to reduce memory usage caused by chunk management overhead,
  1382. so borg does not create a huge chunks index/repo index and eats all your RAM
  1383. if you back up lots of data in huge files (like VM disk images).
  1384. See docs/misc/create_chunker-params.txt for more information.
  1385. - borg info now reports chunk counts in the chunk index.
  1386. - borg create --compression 0..9 to select zlib compression level, fixes #66
  1387. (attic #295).
  1388. - borg init --encryption repokey (to store the encryption key into the repo),
  1389. fixes #85
  1390. - improve at-end error logging, always log exceptions and set exit_code=1
  1391. - LoggedIO: better error checks / exceptions / exception handling
  1392. - implement --remote-path to allow non-default-path borg locations, #125
  1393. - implement --umask M and use 077 as default umask for better security, #117
  1394. - borg check: give a named single archive to it, fixes #139
  1395. - cache sync: show progress indication
  1396. - cache sync: reimplement the chunk index merging in C
  1397. Bug fixes:
  1398. - fix segfault that happened for unreadable files (chunker: n needs to be a
  1399. signed size_t), #116
  1400. - fix the repair mode, #144
  1401. - repo delete: add destroy to allowed rpc methods, fixes issue #114
  1402. - more compatible repository locking code (based on mkdir), maybe fixes #92
  1403. (attic #317, attic #201).
  1404. - better Exception msg if no Borg is installed on the remote repo server, #56
  1405. - create a RepositoryCache implementation that can cope with >2GiB,
  1406. fixes attic #326.
  1407. - fix Traceback when running check --repair, attic #232
  1408. - clarify help text, fixes #73.
  1409. - add help string for --no-files-cache, fixes #140
  1410. Other changes:
  1411. - improved docs:
  1412. - added docs/misc directory for misc. writeups that won't be included
  1413. "as is" into the html docs.
  1414. - document environment variables and return codes (attic #324, attic #52)
  1415. - web site: add related projects, fix web site url, IRC #borgbackup
  1416. - Fedora/Fedora-based install instructions added to docs
  1417. - Cygwin-based install instructions added to docs
  1418. - updated AUTHORS
  1419. - add FAQ entries about redundancy / integrity
  1420. - clarify that borg extract uses the cwd as extraction target
  1421. - update internals doc about chunker params, memory usage and compression
  1422. - added docs about development
  1423. - add some words about resource usage in general
  1424. - document how to backup a raw disk
  1425. - add note about how to run borg from virtual env
  1426. - add solutions for (ll)fuse installation problems
  1427. - document what borg check does, fixes #138
  1428. - reorganize borgbackup.github.io sidebar, prev/next at top
  1429. - deduplicate and refactor the docs / README.rst
  1430. - use borg-tmp as prefix for temporary files / directories
  1431. - short prune options without "keep-" are deprecated, do not suggest them
  1432. - improved tox configuration
  1433. - remove usage of unittest.mock, always use mock from pypi
  1434. - use entrypoints instead of scripts, for better use of the wheel format and
  1435. modern installs
  1436. - add requirements.d/development.txt and modify tox.ini
  1437. - use travis-ci for testing based on Linux and (new) OS X
  1438. - use coverage.py, pytest-cov and codecov.io for test coverage support
  1439. I forgot to list some stuff already implemented in 0.23.0, here they are:
  1440. New features:
  1441. - efficient archive list from manifest, meaning a big speedup for slow
  1442. repo connections and "list <repo>", "delete <repo>", "prune" (attic #242,
  1443. attic #167)
  1444. - big speedup for chunks cache sync (esp. for slow repo connections), fixes #18
  1445. - hashindex: improve error messages
  1446. Other changes:
  1447. - explicitly specify binary mode to open binary files
  1448. - some easy micro optimizations
  1449. Version 0.23.0 (2015-06-11)
  1450. ---------------------------
  1451. Incompatible changes (compared to attic, fork related):
  1452. - changed sw name and cli command to "borg", updated docs
  1453. - package name (and name in urls) uses "borgbackup" to have less collisions
  1454. - changed repo / cache internal magic strings from ATTIC* to BORG*,
  1455. changed cache location to .cache/borg/ - this means that it currently won't
  1456. accept attic repos (see issue #21 about improving that)
  1457. Bug fixes:
  1458. - avoid defect python-msgpack releases, fixes attic #171, fixes attic #185
  1459. - fix traceback when trying to do unsupported passphrase change, fixes attic #189
  1460. - datetime does not like the year 10.000, fixes attic #139
  1461. - fix "info" all archives stats, fixes attic #183
  1462. - fix parsing with missing microseconds, fixes attic #282
  1463. - fix misleading hint the fuse ImportError handler gave, fixes attic #237
  1464. - check unpacked data from RPC for tuple type and correct length, fixes attic #127
  1465. - fix Repository._active_txn state when lock upgrade fails
  1466. - give specific path to xattr.is_enabled(), disable symlink setattr call that
  1467. always fails
  1468. - fix test setup for 32bit platforms, partial fix for attic #196
  1469. - upgraded versioneer, PEP440 compliance, fixes attic #257
  1470. New features:
  1471. - less memory usage: add global option --no-cache-files
  1472. - check --last N (only check the last N archives)
  1473. - check: sort archives in reverse time order
  1474. - rename repo::oldname newname (rename repository)
  1475. - create -v output more informative
  1476. - create --progress (backup progress indicator)
  1477. - create --timestamp (utc string or reference file/dir)
  1478. - create: if "-" is given as path, read binary from stdin
  1479. - extract: if --stdout is given, write all extracted binary data to stdout
  1480. - extract --sparse (simple sparse file support)
  1481. - extra debug information for 'fread failed'
  1482. - delete <repo> (deletes whole repo + local cache)
  1483. - FUSE: reflect deduplication in allocated blocks
  1484. - only allow whitelisted RPC calls in server mode
  1485. - normalize source/exclude paths before matching
  1486. - use posix_fadvise to not spoil the OS cache, fixes attic #252
  1487. - toplevel error handler: show tracebacks for better error analysis
  1488. - sigusr1 / sigint handler to print current file infos - attic PR #286
  1489. - RPCError: include the exception args we get from remote
  1490. Other changes:
  1491. - source: misc. cleanups, pep8, style
  1492. - docs and faq improvements, fixes, updates
  1493. - cleanup crypto.pyx, make it easier to adapt to other AES modes
  1494. - do os.fsync like recommended in the python docs
  1495. - source: Let chunker optionally work with os-level file descriptor.
  1496. - source: Linux: remove duplicate os.fsencode calls
  1497. - source: refactor _open_rb code a bit, so it is more consistent / regular
  1498. - source: refactor indicator (status) and item processing
  1499. - source: use py.test for better testing, flake8 for code style checks
  1500. - source: fix tox >=2.0 compatibility (test runner)
  1501. - pypi package: add python version classifiers, add FreeBSD to platforms
  1502. Attic Changelog
  1503. ---------------
  1504. Here you can see the full list of changes between each Attic release until Borg
  1505. forked from Attic:
  1506. Version 0.17
  1507. ~~~~~~~~~~~~
  1508. (bugfix release, released on X)
  1509. - Fix hashindex ARM memory alignment issue (#309)
  1510. - Improve hashindex error messages (#298)
  1511. Version 0.16
  1512. ~~~~~~~~~~~~
  1513. (bugfix release, released on May 16, 2015)
  1514. - Fix typo preventing the security confirmation prompt from working (#303)
  1515. - Improve handling of systems with improperly configured file system encoding (#289)
  1516. - Fix "All archives" output for attic info. (#183)
  1517. - More user friendly error message when repository key file is not found (#236)
  1518. - Fix parsing of iso 8601 timestamps with zero microseconds (#282)
  1519. Version 0.15
  1520. ~~~~~~~~~~~~
  1521. (bugfix release, released on Apr 15, 2015)
  1522. - xattr: Be less strict about unknown/unsupported platforms (#239)
  1523. - Reduce repository listing memory usage (#163).
  1524. - Fix BrokenPipeError for remote repositories (#233)
  1525. - Fix incorrect behavior with two character directory names (#265, #268)
  1526. - Require approval before accessing relocated/moved repository (#271)
  1527. - Require approval before accessing previously unknown unencrypted repositories (#271)
  1528. - Fix issue with hash index files larger than 2GB.
  1529. - Fix Python 3.2 compatibility issue with noatime open() (#164)
  1530. - Include missing pyx files in dist files (#168)
  1531. Version 0.14
  1532. ~~~~~~~~~~~~
  1533. (feature release, released on Dec 17, 2014)
  1534. - Added support for stripping leading path segments (#95)
  1535. "attic extract --strip-segments X"
  1536. - Add workaround for old Linux systems without acl_extended_file_no_follow (#96)
  1537. - Add MacPorts' path to the default openssl search path (#101)
  1538. - HashIndex improvements, eliminates unnecessary IO on low memory systems.
  1539. - Fix "Number of files" output for attic info. (#124)
  1540. - limit create file permissions so files aren't read while restoring
  1541. - Fix issue with empty xattr values (#106)
  1542. Version 0.13
  1543. ~~~~~~~~~~~~
  1544. (feature release, released on Jun 29, 2014)
  1545. - Fix sporadic "Resource temporarily unavailable" when using remote repositories
  1546. - Reduce file cache memory usage (#90)
  1547. - Faster AES encryption (utilizing AES-NI when available)
  1548. - Experimental Linux, OS X and FreeBSD ACL support (#66)
  1549. - Added support for backup and restore of BSDFlags (OSX, FreeBSD) (#56)
  1550. - Fix bug where xattrs on symlinks were not correctly restored
  1551. - Added cachedir support. CACHEDIR.TAG compatible cache directories
  1552. can now be excluded using ``--exclude-caches`` (#74)
  1553. - Fix crash on extreme mtime timestamps (year 2400+) (#81)
  1554. - Fix Python 3.2 specific lockf issue (EDEADLK)
  1555. Version 0.12
  1556. ~~~~~~~~~~~~
  1557. (feature release, released on April 7, 2014)
  1558. - Python 3.4 support (#62)
  1559. - Various documentation improvements a new style
  1560. - ``attic mount`` now supports mounting an entire repository not only
  1561. individual archives (#59)
  1562. - Added option to restrict remote repository access to specific path(s):
  1563. ``attic serve --restrict-to-path X`` (#51)
  1564. - Include "all archives" size information in "--stats" output. (#54)
  1565. - Added ``--stats`` option to ``attic delete`` and ``attic prune``
  1566. - Fixed bug where ``attic prune`` used UTC instead of the local time zone
  1567. when determining which archives to keep.
  1568. - Switch to SI units (Power of 1000 instead 1024) when printing file sizes
  1569. Version 0.11
  1570. ~~~~~~~~~~~~
  1571. (feature release, released on March 7, 2014)
  1572. - New "check" command for repository consistency checking (#24)
  1573. - Documentation improvements
  1574. - Fix exception during "attic create" with repeated files (#39)
  1575. - New "--exclude-from" option for attic create/extract/verify.
  1576. - Improved archive metadata deduplication.
  1577. - "attic verify" has been deprecated. Use "attic extract --dry-run" instead.
  1578. - "attic prune --hourly|daily|..." has been deprecated.
  1579. Use "attic prune --keep-hourly|daily|..." instead.
  1580. - Ignore xattr errors during "extract" if not supported by the filesystem. (#46)
  1581. Version 0.10
  1582. ~~~~~~~~~~~~
  1583. (bugfix release, released on Jan 30, 2014)
  1584. - Fix deadlock when extracting 0 sized files from remote repositories
  1585. - "--exclude" wildcard patterns are now properly applied to the full path
  1586. not just the file name part (#5).
  1587. - Make source code endianness agnostic (#1)
  1588. Version 0.9
  1589. ~~~~~~~~~~~
  1590. (feature release, released on Jan 23, 2014)
  1591. - Remote repository speed and reliability improvements.
  1592. - Fix sorting of segment names to ignore NFS left over files. (#17)
  1593. - Fix incorrect display of time (#13)
  1594. - Improved error handling / reporting. (#12)
  1595. - Use fcntl() instead of flock() when locking repository/cache. (#15)
  1596. - Let ssh figure out port/user if not specified so we don't override .ssh/config (#9)
  1597. - Improved libcrypto path detection (#23).
  1598. Version 0.8.1
  1599. ~~~~~~~~~~~~~
  1600. (bugfix release, released on Oct 4, 2013)
  1601. - Fix segmentation fault issue.
  1602. Version 0.8
  1603. ~~~~~~~~~~~
  1604. (feature release, released on Oct 3, 2013)
  1605. - Fix xattr issue when backing up sshfs filesystems (#4)
  1606. - Fix issue with excessive index file size (#6)
  1607. - Support access of read only repositories.
  1608. - New syntax to enable repository encryption:
  1609. attic init --encryption="none|passphrase|keyfile".
  1610. - Detect and abort if repository is older than the cache.
  1611. Version 0.7
  1612. ~~~~~~~~~~~
  1613. (feature release, released on Aug 5, 2013)
  1614. - Ported to FreeBSD
  1615. - Improved documentation
  1616. - Experimental: Archives mountable as fuse filesystems.
  1617. - The "user." prefix is no longer stripped from xattrs on Linux
  1618. Version 0.6.1
  1619. ~~~~~~~~~~~~~
  1620. (bugfix release, released on July 19, 2013)
  1621. - Fixed an issue where mtime was not always correctly restored.
  1622. Version 0.6
  1623. ~~~~~~~~~~~
  1624. First public release on July 9, 2013