changes.rst 83 KB

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