changes.rst 82 KB

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