changes.rst 59 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517
  1. Changelog
  2. =========
  3. Important note about pre-1.0.4 potential repo corruption
  4. --------------------------------------------------------
  5. Some external errors (like network or disk I/O errors) could lead to
  6. corruption of the backup repository due to issue #1138.
  7. A sign that this happened is if "E" status was reported for a file that can
  8. not be explained by problems with the source file. If you still have logs from
  9. "borg create -v --list", you can check for "E" status.
  10. Here is what could cause corruption and what you can do now:
  11. 1) I/O errors (e.g. repo disk errors) while writing data to repo.
  12. This could lead to corrupted segment files.
  13. Fix::
  14. # check for corrupt chunks / segments:
  15. borg check -v --repository-only REPO
  16. # repair the repo:
  17. borg check -v --repository-only --repair REPO
  18. # make sure everything is fixed:
  19. borg check -v --repository-only REPO
  20. 2) Unreliable network / unreliable connection to the repo.
  21. This could lead to archive metadata corruption.
  22. Fix::
  23. # check for corrupt archives:
  24. borg check -v --archives-only REPO
  25. # delete the corrupt archives:
  26. borg delete --force REPO::CORRUPT_ARCHIVE
  27. # make sure everything is fixed:
  28. borg check -v --archives-only REPO
  29. 3) In case you want to do more intensive checking.
  30. The best check that everything is ok is to run a dry-run extraction::
  31. borg extract -v --dry-run REPO::ARCHIVE
  32. Version 1.1.0 (not released yet)
  33. --------------------------------
  34. New features:
  35. - borg check: will not produce the "Checking segments" output unless
  36. new --progress option is passed, #824.
  37. - options that imply output (--show-rc, --show-version, --list, --stats,
  38. --progress) don't need -v/--info to have that output displayed, #865
  39. - borg recreate: re-create existing archives, #787 #686 #630 #70, also see
  40. #757, #770.
  41. - selectively remove files/dirs from old archives
  42. - re-compress data
  43. - re-chunkify data, e.g. to have upgraded Attic / Borg 0.xx archives
  44. deduplicate with Borg 1.x archives or to experiment with chunker-params.
  45. - create: visit files in inode order (better speed, esp. for large directories
  46. and rotating disks)
  47. - borg diff: show differences between archives
  48. - borg list improved:
  49. - removed {formatkeys}, see "borg list --help"
  50. - --list-format is deprecated, use --format instead
  51. - now supports the usual [PATH [PATHS…]] syntax and excludes
  52. - new keys: csize, num_chunks, unique_chunks, NUL
  53. - supports guaranteed_available hashlib hashes
  54. (to avoid varying functionality depending on environment)
  55. - prune:
  56. - to better visualize the "thinning out", we now list all archives in
  57. reverse time order. rephrase and reorder help text.
  58. - implement --keep-last N via --keep-secondly N, also --keep-minutely.
  59. assuming that there is not more than 1 backup archive made in 1s,
  60. --keep-last N and --keep-secondly N are equivalent, #537
  61. - borg comment: add archive comments, #842
  62. - provide "borgfs" wrapper for borg mount, enables usage via fstab, #743
  63. - create: add 'x' status for excluded paths, #814
  64. - --show-version: shows/logs the borg version, #725
  65. - borg list/prune/delete: also output archive id, #731
  66. Bug fixes:
  67. - init: clean up partial repo if passphrase input is aborted, #850
  68. - info: quote cmdline arguments that have spaces in them
  69. - failing hashindex tests on netbsd, #804
  70. - fix links failing for extracting subtrees, #761
  71. Other changes:
  72. - replace stdlib hmac with OpenSSL, zero-copy decrypt (10-15% increase in
  73. performance of hash-lists and extract).
  74. - Source:
  75. - pass meta-data around, #765
  76. - move some constants to new constants module
  77. - better readability and less errors with namedtuples, #823
  78. - Docs:
  79. - better help texts and sphinx reproduction of usage help:
  80. - Group options
  81. - Nicer list of options in Sphinx
  82. - Deduplicate 'Common options' (including --help)
  83. - chunker: added some insights by "Voltara", #903
  84. - clarify what "deduplicated size" means
  85. - fix / update / add package list entries
  86. - new contributors in AUTHORS!
  87. - Tests:
  88. - vagrant: add ubuntu/xenial 64bit - this box has still some issues
  89. - ChunkBuffer: add test for leaving partial chunk in buffer, fixes #945
  90. Version 1.0.7 (not released yet)
  91. --------------------------------
  92. Security fixes:
  93. - fix security issue with remote repository access, #1428
  94. Version 1.0.7rc2 (2016-08-13)
  95. -----------------------------
  96. Bug fixes:
  97. - do not write objects to repository that are bigger than the allowed size,
  98. borg will reject reading them, #1451.
  99. Important: if you created archives with many millions of files or
  100. directories, please verify if you can open them successfully,
  101. e.g. try a "borg list REPO::ARCHIVE".
  102. - lz4 compression: dynamically enlarge the (de)compression buffer, the static
  103. buffer was not big enough for archives with extremely many items, #1453
  104. - larger item metadata stream chunks, raise archive item limit by 8x, #1452
  105. - fix untracked segments made by moved DELETEs, #1442
  106. Impact: Previously (metadata) segments could become untracked when deleting data,
  107. these would never be cleaned up.
  108. - extended attributes (xattrs) related fixes:
  109. - fixed a race condition in xattrs querying that led to the entire file not
  110. being backed up (while logging the error, exit code = 1), #1469
  111. - fixed a race condition in xattrs querying that led to a crash, #1462
  112. - raise OSError including the error message derived from errno, deal with
  113. path being a integer FD
  114. Other changes:
  115. - print active env var override by default, #1467
  116. - xattr module: refactor code, deduplicate, clean up
  117. - repository: split object size check into too small and too big
  118. - add a transaction_id assertion, so borg init on a broken (inconsistent)
  119. filesystem does not look like a coding error in borg, but points to the
  120. real problem.
  121. - explain confusing TypeError caused by compat support for old servers, #1456
  122. - add forgotten usage help file from build_usage
  123. - refactor/unify buffer code into helpers.Buffer class, add tests
  124. - docs:
  125. - document archive limitation, #1452
  126. - improve prune examples
  127. Version 1.0.7rc1 (2016-08-05)
  128. -----------------------------
  129. Bug fixes:
  130. - fix repo lock deadlocks (related to lock upgrade), #1220
  131. - catch unpacker exceptions, resync, #1351
  132. - fix borg break-lock ignoring BORG_REPO env var, #1324
  133. - files cache performance fixes (fixes unneccessary re-reading/chunking/
  134. hashing of unmodified files for some use cases):
  135. - fix unintended file cache eviction, #1430
  136. - implement BORG_FILES_CACHE_TTL, update FAQ, raise default TTL from 10
  137. to 20, #1338
  138. - FUSE:
  139. - cache partially read data chunks (performance), #965, #966
  140. - always create a root dir, #1125
  141. - use an OrderedDict for helptext, making the build reproducible, #1346
  142. - RemoteRepository init: always call close on exceptions, #1370 (cosmetic)
  143. - ignore stdout/stderr broken pipe errors (cosmetic), #1116
  144. New features:
  145. - better borg versions management support (useful esp. for borg servers
  146. wanting to offer multiple borg versions and for clients wanting to choose
  147. a specific server borg version), #1392:
  148. - add BORG_VERSION environment variable before executing "borg serve" via ssh
  149. - add new placeholder {borgversion}
  150. - substitute placeholders in --remote-path
  151. - borg init --append-only option (makes using the more secure append-only mode
  152. more convenient. when used remotely, this requires 1.0.7+ also on the borg
  153. server), #1291.
  154. Other changes:
  155. - Vagrantfile:
  156. - darwin64: upgrade to FUSE for macOS 3.4.1 (aka osxfuse), #1378
  157. - xenial64: use user "ubuntu", not "vagrant" (as usual), #1331
  158. - tests:
  159. - fix fuse tests on OS X, #1433
  160. - docs:
  161. - FAQ: add backup using stable filesystem names recommendation
  162. - FAQ about glibc compatibility added, #491, glibc-check improved
  163. - FAQ: 'A' unchanged file; remove ambiguous entry age sentence.
  164. - OS X: install pkg-config to build with FUSE support, fixes #1400
  165. - add notes about shell/sudo pitfalls with env. vars, #1380
  166. - added platform feature matrix
  167. - implement borg debug-dump-repo-objs
  168. Version 1.0.6 (2016-07-12)
  169. --------------------------
  170. Bug fixes:
  171. - Linux: handle multiple LD_PRELOAD entries correctly, #1314, #1111
  172. - Fix crash with unclear message if the libc is not found, #1314, #1111
  173. Other changes:
  174. - tests:
  175. - Fixed O_NOATIME tests for Solaris and GNU Hurd, #1315
  176. - Fixed sparse file tests for (file) systems not supporting it, #1310
  177. - docs:
  178. - Fixed syntax highlighting, #1313
  179. - misc docs: added data processing overview picture
  180. Version 1.0.6rc1 (2016-07-10)
  181. -----------------------------
  182. New features:
  183. - borg check --repair: heal damaged files if missing chunks re-appear (e.g. if
  184. the previously missing chunk was added again in a later backup archive),
  185. #148. (*) Also improved logging.
  186. Bug fixes:
  187. - sync_dir: silence fsync() failing with EINVAL, #1287
  188. Some network filesystems (like smbfs) don't support this and we use this in
  189. repository code.
  190. - borg mount (FUSE):
  191. - fix directories being shadowed when contained paths were also specified,
  192. #1295
  193. - raise I/O Error (EIO) on damaged files (unless -o allow_damaged_files is
  194. used), #1302. (*)
  195. - borg extract: warn if a damaged file is extracted, #1299. (*)
  196. - Added some missing return code checks (ChunkIndex._add, hashindex_resize).
  197. - borg check: fix/optimize initial hash table size, avoids resize of the table.
  198. Other changes:
  199. - tests:
  200. - add more FUSE tests, #1284
  201. - deduplicate fuse (u)mount code
  202. - fix borg binary test issues, #862
  203. - docs:
  204. - changelog: added release dates to older borg releases
  205. - fix some sphinx (docs generator) warnings, #881
  206. Notes:
  207. (*) Some features depend on information (chunks_healthy list) added to item
  208. metadata when a file with missing chunks was "repaired" using all-zero
  209. replacement chunks. The chunks_healthy list is generated since borg 1.0.4,
  210. thus borg can't recognize such "repaired" (but content-damaged) files if the
  211. repair was done with an older borg version.
  212. Version 1.0.5 (2016-07-07)
  213. --------------------------
  214. Bug fixes:
  215. - borg mount: fix FUSE crash in xattr code on Linux introduced in 1.0.4, #1282
  216. Other changes:
  217. - backport some FAQ entries from master branch
  218. - add release helper scripts
  219. - Vagrantfile:
  220. - centos6: no FUSE, don't build binary
  221. - add xz for redhat-like dists
  222. Version 1.0.4 (2016-07-07)
  223. --------------------------
  224. New features:
  225. - borg serve --append-only, #1168
  226. This was included because it was a simple change (append-only functionality
  227. was already present via repository config file) and makes better security now
  228. practically usable.
  229. - BORG_REMOTE_PATH environment variable, #1258
  230. This was included because it was a simple change (--remote-path cli option
  231. was already present) and makes borg much easier to use if you need it.
  232. - Repository: cleanup incomplete transaction on "no space left" condition.
  233. In many cases, this can avoid a 100% full repo filesystem (which is very
  234. problematic as borg always needs free space - even to delete archives).
  235. Bug fixes:
  236. - Fix wrong handling and reporting of OSErrors in borg create, #1138.
  237. This was a serious issue: in the context of "borg create", errors like
  238. repository I/O errors (e.g. disk I/O errors, ssh repo connection errors)
  239. were handled badly and did not lead to a crash (which would be good for this
  240. case, because the repo transaction would be incomplete and trigger a
  241. transaction rollback to clean up).
  242. Now, error handling for source files is cleanly separated from every other
  243. error handling, so only problematic input files are logged and skipped.
  244. - Implement fail-safe error handling for borg extract.
  245. Note that this isn't nearly as critical as the borg create error handling
  246. bug, since nothing is written to the repo. So this was "merely" misleading
  247. error reporting.
  248. - Add missing error handler in directory attr restore loop.
  249. - repo: make sure write data hits disk before the commit tag (#1236) and also
  250. sync the containing directory.
  251. - FUSE: getxattr fail must use errno.ENOATTR, #1126
  252. (fixes Mac OS X Finder malfunction: "zero bytes" file length, access denied)
  253. - borg check --repair: do not lose information about the good/original chunks.
  254. If we do not lose the original chunk IDs list when "repairing" a file
  255. (replacing missing chunks with all-zero chunks), we have a chance to "heal"
  256. the file back into its original state later, in case the chunks re-appear
  257. (e.g. in a fresh backup). Healing is not implemented yet, see #148.
  258. - fixes for --read-special mode:
  259. - ignore known files cache, #1241
  260. - fake regular file mode, #1214
  261. - improve symlinks handling, #1215
  262. - remove passphrase from subprocess environment, #1105
  263. - Ignore empty index file (will trigger index rebuild), #1195
  264. - add missing placeholder support for --prefix, #1027
  265. - improve exception handling for placeholder replacement
  266. - catch and format exceptions in arg parsing
  267. - helpers: fix "undefined name 'e'" in exception handler
  268. - better error handling for missing repo manifest, #1043
  269. - borg delete:
  270. - make it possible to delete a repo without manifest
  271. - borg delete --forced allows to delete corrupted archives, #1139
  272. - borg check:
  273. - make borg check work for empty repo
  274. - fix resync and msgpacked item qualifier, #1135
  275. - rebuild_manifest: fix crash if 'name' or 'time' key were missing.
  276. - better validation of item metadata dicts, #1130
  277. - better validation of archive metadata dicts
  278. - close the repo on exit - even if rollback did not work, #1197.
  279. This is rather cosmetic, it avoids repo closing in the destructor.
  280. - tests:
  281. - fix sparse file test, #1170
  282. - flake8: ignore new F405, #1185
  283. - catch "invalid argument" on cygwin, #257
  284. - fix sparseness assertion in test prep, #1264
  285. Other changes:
  286. - make borg build/work on OpenSSL 1.0 and 1.1, #1187
  287. - docs / help:
  288. - fix / clarify prune help, #1143
  289. - fix "patterns" help formatting
  290. - add missing docs / help about placeholders
  291. - resources: rename atticmatic to borgmatic
  292. - document sshd settings, #545
  293. - more details about checkpoints, add split trick, #1171
  294. - support docs: add freenode web chat link, #1175
  295. - add prune visualization / example, #723
  296. - add note that Fnmatch is default, #1247
  297. - make clear that lzma levels > 6 are a waste of cpu cycles
  298. - add a "do not edit" note to auto-generated files, #1250
  299. - update cygwin installation docs
  300. - repository interoperability with borg master (1.1dev) branch:
  301. - borg check: read item metadata keys from manifest, #1147
  302. - read v2 hints files, #1235
  303. - fix hints file "unknown version" error handling bug
  304. - tests: add tests for format_line
  305. - llfuse: update version requirement for freebsd
  306. - Vagrantfile:
  307. - use openbsd 5.9, #716
  308. - do not install llfuse on netbsd (broken)
  309. - update OSXfuse to version 3.3.3
  310. - use Python 3.5.2 to build the binaries
  311. - glibc compatibility checker: scripts/glibc_check.py
  312. - add .eggs to .gitignore
  313. Version 1.0.3 (2016-05-20)
  314. --------------------------
  315. Bug fixes:
  316. - prune: avoid that checkpoints are kept and completed archives are deleted in
  317. a prune run), #997
  318. - prune: fix commandline argument validation - some valid command lines were
  319. considered invalid (annoying, but harmless), #942
  320. - fix capabilities extraction on Linux (set xattrs last, after chown()), #1069
  321. - repository: fix commit tags being seen in data
  322. - when probing key files, do binary reads. avoids crash when non-borg binary
  323. files are located in borg's key files directory.
  324. - handle SIGTERM and make a clean exit - avoids orphan lock files.
  325. - repository cache: don't cache large objects (avoid using lots of temp. disk
  326. space), #1063
  327. Other changes:
  328. - Vagrantfile: OS X: update osxfuse / install lzma package, #933
  329. - setup.py: add check for platform_darwin.c
  330. - setup.py: on freebsd, use a llfuse release that builds ok
  331. - docs / help:
  332. - update readthedocs URLs, #991
  333. - add missing docs for "borg break-lock", #992
  334. - borg create help: add some words to about the archive name
  335. - borg create help: document format tags, #894
  336. Version 1.0.2 (2016-04-16)
  337. --------------------------
  338. Bug fixes:
  339. - fix malfunction and potential corruption on (nowadays rather rare) big-endian
  340. architectures or bi-endian archs in (rare) BE mode. #886, #889
  341. cache resync / index merge was malfunctioning due to this, potentially
  342. leading to data loss. borg info had cosmetic issues (displayed wrong values).
  343. note: all (widespread) little-endian archs (like x86/x64) or bi-endian archs
  344. in (widespread) LE mode (like ARMEL, MIPSEL, ...) were NOT affected.
  345. - add overflow and range checks for 1st (special) uint32 of the hashindex
  346. values, switch from int32 to uint32.
  347. - fix so that refcount will never overflow, but just stick to max. value after
  348. a overflow would have occured.
  349. - borg delete: fix --cache-only for broken caches, #874
  350. Makes --cache-only idempotent: it won't fail if the cache is already deleted.
  351. - fixed borg create --one-file-system erroneously traversing into other
  352. filesystems (if starting fs device number was 0), #873
  353. - workround a bug in Linux fadvise FADV_DONTNEED, #907
  354. Other changes:
  355. - better test coverage for hashindex, incl. overflow testing, checking correct
  356. computations so endianness issues would be discovered.
  357. - reproducible doc for ProgressIndicator*, make the build reproducible.
  358. - use latest llfuse for vagrant machines
  359. - docs:
  360. - use /path/to/repo in examples, fixes #901
  361. - fix confusing usage of "repo" as archive name (use "arch")
  362. Version 1.0.1 (2016-04-08)
  363. --------------------------
  364. New features:
  365. Usually there are no new features in a bugfix release, but these were added
  366. due to their high impact on security/safety/speed or because they are fixes
  367. also:
  368. - append-only mode for repositories, #809, #36 (see docs)
  369. - borg create: add --ignore-inode option to make borg detect unmodified files
  370. even if your filesystem does not have stable inode numbers (like sshfs and
  371. possibly CIFS).
  372. - add options --warning, --error, --critical for missing log levels, #826.
  373. it's not recommended to suppress warnings or errors, but the user may decide
  374. this on his own.
  375. note: --warning is not given to borg serve so a <= 1.0.0 borg will still
  376. work as server (it is not needed as it is the default).
  377. do not use --error or --critical when using a <= 1.0.0 borg server.
  378. Bug fixes:
  379. - fix silently skipping EIO, #748
  380. - add context manager for Repository (avoid orphan repository locks), #285
  381. - do not sleep for >60s while waiting for lock, #773
  382. - unpack file stats before passing to FUSE
  383. - fix build on illumos
  384. - don't try to backup doors or event ports (Solaris and derivates)
  385. - remove useless/misleading libc version display, #738
  386. - test suite: reset exit code of persistent archiver, #844
  387. - RemoteRepository: clean up pipe if remote open() fails
  388. - Remote: don't print tracebacks for Error exceptions handled downstream, #792
  389. - if BORG_PASSPHRASE is present but wrong, don't prompt for password, but fail
  390. instead, #791
  391. - ArchiveChecker: move "orphaned objects check skipped" to INFO log level, #826
  392. - fix capitalization, add ellipses, change log level to debug for 2 messages,
  393. #798
  394. Other changes:
  395. - update llfuse requirement, llfuse 1.0 works
  396. - update OS / dist packages on build machines, #717
  397. - prefer showing --info over -v in usage help, #859
  398. - docs:
  399. - fix cygwin requirements (gcc-g++)
  400. - document how to debug / file filesystem issues, #664
  401. - fix reproducible build of api docs
  402. - RTD theme: CSS !important overwrite, #727
  403. - Document logo font. Recreate logo png. Remove GIMP logo file.
  404. Version 1.0.0 (2016-03-05)
  405. --------------------------
  406. The major release number change (0.x -> 1.x) indicates bigger incompatible
  407. changes, please read the compatibility notes, adapt / test your scripts and
  408. check your backup logs.
  409. Compatibility notes:
  410. - drop support for python 3.2 and 3.3, require 3.4 or 3.5, #221 #65 #490
  411. note: we provide binaries that include python 3.5.1 and everything else
  412. needed. they are an option in case you are stuck with < 3.4 otherwise.
  413. - change encryption to be on by default (using "repokey" mode)
  414. - moved keyfile keys from ~/.borg/keys to ~/.config/borg/keys,
  415. you can either move them manually or run "borg upgrade <REPO>"
  416. - remove support for --encryption=passphrase,
  417. use borg migrate-to-repokey to switch to repokey mode, #97
  418. - remove deprecated --compression <number>,
  419. use --compression zlib,<number> instead
  420. in case of 0, you could also use --compression none
  421. - remove deprecated --hourly/daily/weekly/monthly/yearly
  422. use --keep-hourly/daily/weekly/monthly/yearly instead
  423. - remove deprecated --do-not-cross-mountpoints,
  424. use --one-file-system instead
  425. - disambiguate -p option, #563:
  426. - -p now is same as --progress
  427. - -P now is same as --prefix
  428. - remove deprecated "borg verify",
  429. use "borg extract --dry-run" instead
  430. - cleanup environment variable semantics, #355
  431. the environment variables used to be "yes sayers" when set, this was
  432. conceptually generalized to "automatic answerers" and they just give their
  433. value as answer (as if you typed in that value when being asked).
  434. See the "usage" / "Environment Variables" section of the docs for details.
  435. - change the builtin default for --chunker-params, create 2MiB chunks, #343
  436. --chunker-params new default: 19,23,21,4095 - old default: 10,23,16,4095
  437. one of the biggest issues with borg < 1.0 (and also attic) was that it had a
  438. default target chunk size of 64kiB, thus it created a lot of chunks and thus
  439. also a huge chunk management overhead (high RAM and disk usage).
  440. please note that the new default won't change the chunks that you already
  441. have in your repository. the new big chunks do not deduplicate with the old
  442. small chunks, so expect your repo to grow at least by the size of every
  443. changed file and in the worst case (e.g. if your files cache was lost / is
  444. not used) by the size of every file (minus any compression you might use).
  445. in case you want to immediately see a much lower resource usage (RAM / disk)
  446. for chunks management, it might be better to start with a new repo than
  447. continuing in the existing repo (with an existing repo, you'ld have to wait
  448. until all archives with small chunks got pruned to see a lower resource
  449. usage).
  450. if you used the old --chunker-params default value (or if you did not use
  451. --chunker-params option at all) and you'ld like to continue using small
  452. chunks (and you accept the huge resource usage that comes with that), just
  453. explicitly use borg create --chunker-params=10,23,16,4095.
  454. - archive timestamps: the 'time' timestamp now refers to archive creation
  455. start time (was: end time), the new 'time_end' timestamp refers to archive
  456. creation end time. This might affect prune if your backups take rather long.
  457. if you give a timestamp via cli this is stored into 'time', therefore it now
  458. needs to mean archive creation start time.
  459. New features:
  460. - implement password roundtrip, #695
  461. Bug fixes:
  462. - remote end does not need cache nor keys directories, do not create them, #701
  463. - added retry counter for passwords, #703
  464. Other changes:
  465. - fix compiler warnings, #697
  466. - docs:
  467. - update README.rst to new changelog location in docs/changes.rst
  468. - add Teemu to AUTHORS
  469. - changes.rst: fix old chunker params, #698
  470. - FAQ: how to limit bandwidth
  471. Version 1.0.0rc2 (2016-02-28)
  472. -----------------------------
  473. New features:
  474. - format options for location: user, pid, fqdn, hostname, now, utcnow, user
  475. - borg list --list-format
  476. - borg prune -v --list enables the keep/prune list output, #658
  477. Bug fixes:
  478. - fix _open_rb noatime handling, #657
  479. - add a simple archivename validator, #680
  480. - borg create --stats: show timestamps in localtime, use same labels/formatting
  481. as borg info, #651
  482. - llfuse compatibility fixes (now compatible with: 0.40, 0.41, 0.42)
  483. Other changes:
  484. - it is now possible to use "pip install borgbackup[fuse]" to automatically
  485. install the llfuse dependency using the correct version requirement
  486. for it. you still need to care about having installed the FUSE / build
  487. related OS package first, though, so that building llfuse can succeed.
  488. - Vagrant: drop Ubuntu Precise (12.04) - does not have Python >= 3.4
  489. - Vagrant: use pyinstaller v3.1.1 to build binaries
  490. - docs:
  491. - borg upgrade: add to docs that only LOCAL repos are supported
  492. - borg upgrade also handles borg 0.xx -> 1.0
  493. - use pip extras or requirements file to install llfuse
  494. - fix order in release process
  495. - updated usage docs and other minor / cosmetic fixes
  496. - verified borg examples in docs, #644
  497. - freebsd dependency installation and fuse configuration, #649
  498. - add example how to restore a raw device, #671
  499. - add a hint about the dev headers needed when installing from source
  500. - add examples for delete (and handle delete after list, before prune), #656
  501. - update example for borg create -v --stats (use iso datetime format), #663
  502. - added example to BORG_RSH docs
  503. - "connection closed by remote": add FAQ entry and point to issue #636
  504. Version 1.0.0rc1 (2016-02-07)
  505. -----------------------------
  506. New features:
  507. - borg migrate-to-repokey ("passphrase" -> "repokey" encryption key mode)
  508. - implement --short for borg list REPO, #611
  509. - implement --list for borg extract (consistency with borg create)
  510. - borg serve: overwrite client's --restrict-to-path with ssh forced command's
  511. option value (but keep everything else from the client commandline), #544
  512. - use $XDG_CONFIG_HOME/keys for keyfile keys (~/.config/borg/keys), #515
  513. - "borg upgrade" moves the keyfile keys to the new location
  514. - display both archive creation start and end time in "borg info", #627
  515. Bug fixes:
  516. - normalize trailing slashes for the repository path, #606
  517. - Cache: fix exception handling in __init__, release lock, #610
  518. Other changes:
  519. - suppress unneeded exception context (PEP 409), simpler tracebacks
  520. - removed special code needed to deal with imperfections / incompatibilities /
  521. missing stuff in py 3.2/3.3, simplify code that can be done simpler in 3.4
  522. - removed some version requirements that were kept on old versions because
  523. newer did not support py 3.2 any more
  524. - use some py 3.4+ stdlib code instead of own/openssl/pypi code:
  525. - use os.urandom instead of own cython openssl RAND_bytes wrapper, #493
  526. - use hashlib.pbkdf2_hmac from py stdlib instead of own openssl wrapper
  527. - use hmac.compare_digest instead of == operator (constant time comparison)
  528. - use stat.filemode instead of homegrown code
  529. - use "mock" library from stdlib, #145
  530. - remove borg.support (with non-broken argparse copy), it is ok in 3.4+, #358
  531. - Vagrant: copy CHANGES.rst as symlink, #592
  532. - cosmetic code cleanups, add flake8 to tox/travis, #4
  533. - docs / help:
  534. - make "borg -h" output prettier, #591
  535. - slightly rephrase prune help
  536. - add missing example for --list option of borg create
  537. - quote exclude line that includes an asterisk to prevent shell expansion
  538. - fix dead link to license
  539. - delete Ubuntu Vivid, it is not supported anymore (EOL)
  540. - OS X binary does not work for older OS X releases, #629
  541. - borg serve's special support for forced/original ssh commands, #544
  542. - misc. updates and fixes
  543. Version 0.30.0 (2016-01-23)
  544. ---------------------------
  545. Compatibility notes:
  546. - you may need to use -v (or --info) more often to actually see output emitted
  547. at INFO log level (because it is suppressed at the default WARNING log level).
  548. See the "general" section in the usage docs.
  549. - for borg create, you need --list (additionally to -v) to see the long file
  550. list (was needed so you can have e.g. --stats alone without the long list)
  551. - see below about BORG_DELETE_I_KNOW_WHAT_I_AM_DOING (was:
  552. BORG_CHECK_I_KNOW_WHAT_I_AM_DOING)
  553. Bug fixes:
  554. - fix crash when using borg create --dry-run --keep-tag-files, #570
  555. - make sure teardown with cleanup happens for Cache and RepositoryCache,
  556. avoiding leftover locks and TEMP dir contents, #285 (partially), #548
  557. - fix locking KeyError, partial fix for #502
  558. - log stats consistently, #526
  559. - add abbreviated weekday to timestamp format, fixes #496
  560. - strip whitespace when loading exclusions from file
  561. - unset LD_LIBRARY_PATH before invoking ssh, fixes strange OpenSSL library
  562. version warning when using the borg binary, #514
  563. - add some error handling/fallback for C library loading, #494
  564. - added BORG_DELETE_I_KNOW_WHAT_I_AM_DOING for check in "borg delete", #503
  565. - remove unused "repair" rpc method name
  566. New features:
  567. - borg create: implement exclusions using regular expression patterns.
  568. - borg create: implement inclusions using patterns.
  569. - borg extract: support patterns, #361
  570. - support different styles for patterns:
  571. - fnmatch (`fm:` prefix, default when omitted), like borg <= 0.29.
  572. - shell (`sh:` prefix) with `*` not matching directory separators and
  573. `**/` matching 0..n directories
  574. - path prefix (`pp:` prefix, for unifying borg create pp1 pp2 into the
  575. patterns system), semantics like in borg <= 0.29
  576. - regular expression (`re:`), new!
  577. - --progress option for borg upgrade (#291) and borg delete <archive>
  578. - update progress indication more often (e.g. for borg create within big
  579. files or for borg check repo), #500
  580. - finer chunker granularity for items metadata stream, #547, #487
  581. - borg create --list now used (additionally to -v) to enable the verbose
  582. file list output
  583. - display borg version below tracebacks, #532
  584. Other changes:
  585. - hashtable size (and thus: RAM and disk consumption) follows a growth policy:
  586. grows fast while small, grows slower when getting bigger, #527
  587. - Vagrantfile: use pyinstaller 3.1 to build binaries, freebsd sqlite3 fix,
  588. fixes #569
  589. - no separate binaries for centos6 any more because the generic linux binaries
  590. also work on centos6 (or in general: on systems with a slightly older glibc
  591. than debian7
  592. - dev environment: require virtualenv<14.0 so we get a py32 compatible pip
  593. - docs:
  594. - add space-saving chunks.archive.d trick to FAQ
  595. - important: clarify -v and log levels in usage -> general, please read!
  596. - sphinx configuration: create a simple man page from usage docs
  597. - add a repo server setup example
  598. - disable unneeded SSH features in authorized_keys examples for security.
  599. - borg prune only knows "--keep-within" and not "--within"
  600. - add gource video to resources docs, #507
  601. - add netbsd install instructions
  602. - authors: make it more clear what refers to borg and what to attic
  603. - document standalone binary requirements, #499
  604. - rephrase the mailing list section
  605. - development docs: run build_api and build_usage before tagging release
  606. - internals docs: hash table max. load factor is 0.75 now
  607. - markup, typo, grammar, phrasing, clarifications and other fixes.
  608. - add gcc gcc-c++ to redhat/fedora/corora install docs, fixes #583
  609. Version 0.29.0 (2015-12-13)
  610. ---------------------------
  611. Compatibility notes:
  612. - when upgrading to 0.29.0 you need to upgrade client as well as server
  613. installations due to the locking and commandline interface changes otherwise
  614. you'll get an error msg about a RPC protocol mismatch or a wrong commandline
  615. option.
  616. if you run a server that needs to support both old and new clients, it is
  617. suggested that you have a "borg-0.28.2" and a "borg-0.29.0" command.
  618. clients then can choose via e.g. "borg --remote-path=borg-0.29.0 ...".
  619. - the default waiting time for a lock changed from infinity to 1 second for a
  620. better interactive user experience. if the repo you want to access is
  621. currently locked, borg will now terminate after 1s with an error message.
  622. if you have scripts that shall wait for the lock for a longer time, use
  623. --lock-wait N (with N being the maximum wait time in seconds).
  624. Bug fixes:
  625. - hash table tuning (better chosen hashtable load factor 0.75 and prime initial
  626. size of 1031 gave ~1000x speedup in some scenarios)
  627. - avoid creation of an orphan lock for one case, #285
  628. - --keep-tag-files: fix file mode and multiple tag files in one directory, #432
  629. - fixes for "borg upgrade" (attic repo converter), #466
  630. - remove --progress isatty magic (and also --no-progress option) again, #476
  631. - borg init: display proper repo URL
  632. - fix format of umask in help pages, #463
  633. New features:
  634. - implement --lock-wait, support timeout for UpgradableLock, #210
  635. - implement borg break-lock command, #157
  636. - include system info below traceback, #324
  637. - sane remote logging, remote stderr, #461:
  638. - remote log output: intercept it and log it via local logging system,
  639. with "Remote: " prefixed to message. log remote tracebacks.
  640. - remote stderr: output it to local stderr with "Remote: " prefixed.
  641. - add --debug and --info (same as --verbose) to set the log level of the
  642. builtin logging configuration (which otherwise defaults to warning), #426
  643. note: there are few messages emitted at DEBUG level currently.
  644. - optionally configure logging via env var BORG_LOGGING_CONF
  645. - add --filter option for status characters: e.g. to show only the added
  646. or modified files (and also errors), use "borg create -v --filter=AME ...".
  647. - more progress indicators, #394
  648. - use ISO-8601 date and time format, #375
  649. - "borg check --prefix" to restrict archive checking to that name prefix, #206
  650. Other changes:
  651. - hashindex_add C implementation (speed up cache re-sync for new archives)
  652. - increase FUSE read_size to 1024 (speed up metadata operations)
  653. - check/delete/prune --save-space: free unused segments quickly, #239
  654. - increase rpc protocol version to 2 (see also Compatibility notes), #458
  655. - silence borg by default (via default log level WARNING)
  656. - get rid of C compiler warnings, #391
  657. - upgrade OS X FUSE to 3.0.9 on the OS X binary build system
  658. - use python 3.5.1 to build binaries
  659. - docs:
  660. - new mailing list borgbackup@python.org, #468
  661. - readthedocs: color and logo improvements
  662. - load coverage icons over SSL (avoids mixed content)
  663. - more precise binary installation steps
  664. - update release procedure docs about OS X FUSE
  665. - FAQ entry about unexpected 'A' status for unchanged file(s), #403
  666. - add docs about 'E' file status
  667. - add "borg upgrade" docs, #464
  668. - add developer docs about output and logging
  669. - clarify encryption, add note about client-side encryption
  670. - add resources section, with videos, talks, presentations, #149
  671. - Borg moved to Arch Linux [community]
  672. - fix wrong installation instructions for archlinux
  673. Version 0.28.2 (2015-11-15)
  674. ---------------------------
  675. New features:
  676. - borg create --exclude-if-present TAGFILE - exclude directories that have the
  677. given file from the backup. You can additionally give --keep-tag-files to
  678. preserve just the directory roots and the tag-files (but not backup other
  679. directory contents), #395, attic #128, attic #142
  680. Other changes:
  681. - do not create docs sources at build time (just have them in the repo),
  682. completely remove have_cython() hack, do not use the "mock" library at build
  683. time, #384
  684. - avoid hidden import, make it easier for PyInstaller, easier fix for #218
  685. - docs:
  686. - add description of item flags / status output, fixes #402
  687. - explain how to regenerate usage and API files (build_api or
  688. build_usage) and when to commit usage files directly into git, #384
  689. - minor install docs improvements
  690. Version 0.28.1 (2015-11-08)
  691. ---------------------------
  692. Bug fixes:
  693. - do not try to build api / usage docs for production install,
  694. fixes unexpected "mock" build dependency, #384
  695. Other changes:
  696. - avoid using msgpack.packb at import time
  697. - fix formatting issue in changes.rst
  698. - fix build on readthedocs
  699. Version 0.28.0 (2015-11-08)
  700. ---------------------------
  701. Compatibility notes:
  702. - changed return codes (exit codes), see docs. in short:
  703. old: 0 = ok, 1 = error. now: 0 = ok, 1 = warning, 2 = error
  704. New features:
  705. - refactor return codes (exit codes), fixes #61
  706. - add --show-rc option enable "terminating with X status, rc N" output, fixes 58, #351
  707. - borg create backups atime and ctime additionally to mtime, fixes #317
  708. - extract: support atime additionally to mtime
  709. - FUSE: support ctime and atime additionally to mtime
  710. - support borg --version
  711. - emit a warning if we have a slow msgpack installed
  712. - borg list --prefix=thishostname- REPO, fixes #205
  713. - Debug commands (do not use except if you know what you do: debug-get-obj,
  714. debug-put-obj, debug-delete-obj, debug-dump-archive-items.
  715. Bug fixes:
  716. - setup.py: fix bug related to BORG_LZ4_PREFIX processing
  717. - fix "check" for repos that have incomplete chunks, fixes #364
  718. - borg mount: fix unlocking of repository at umount time, fixes #331
  719. - fix reading files without touching their atime, #334
  720. - non-ascii ACL fixes for Linux, FreeBSD and OS X, #277
  721. - fix acl_use_local_uid_gid() and add a test for it, attic #359
  722. - borg upgrade: do not upgrade repositories in place by default, #299
  723. - fix cascading failure with the index conversion code, #269
  724. - borg check: implement 'cmdline' archive metadata value decoding, #311
  725. - fix RobustUnpacker, it missed some metadata keys (new atime and ctime keys
  726. were missing, but also bsdflags). add check for unknown metadata keys.
  727. - create from stdin: also save atime, ctime (cosmetic)
  728. - use default_notty=False for confirmations, fixes #345
  729. - vagrant: fix msgpack installation on centos, fixes #342
  730. - deal with unicode errors for symlinks in same way as for regular files and
  731. have a helpful warning message about how to fix wrong locale setup, fixes #382
  732. - add ACL keys the RobustUnpacker must know about
  733. Other changes:
  734. - improve file size displays, more flexible size formatters
  735. - explicitly commit to the units standard, #289
  736. - archiver: add E status (means that an error occurred when processing this
  737. (single) item
  738. - do binary releases via "github releases", closes #214
  739. - create: use -x and --one-file-system (was: --do-not-cross-mountpoints), #296
  740. - a lot of changes related to using "logging" module and screen output, #233
  741. - show progress display if on a tty, output more progress information, #303
  742. - factor out status output so it is consistent, fix surrogates removal,
  743. maybe fixes #309
  744. - move away from RawConfigParser to ConfigParser
  745. - archive checker: better error logging, give chunk_id and sequence numbers
  746. (can be used together with borg debug-dump-archive-items).
  747. - do not mention the deprecated passphrase mode
  748. - emit a deprecation warning for --compression N (giving a just a number)
  749. - misc .coverragerc fixes (and coverage measurement improvements), fixes #319
  750. - refactor confirmation code, reduce code duplication, add tests
  751. - prettier error messages, fixes #307, #57
  752. - tests:
  753. - add a test to find disk-full issues, #327
  754. - travis: also run tests on Python 3.5
  755. - travis: use tox -r so it rebuilds the tox environments
  756. - test the generated pyinstaller-based binary by archiver unit tests, #215
  757. - vagrant: tests: announce whether fakeroot is used or not
  758. - vagrant: add vagrant user to fuse group for debianoid systems also
  759. - vagrant: llfuse install on darwin needs pkgconfig installed
  760. - vagrant: use pyinstaller from develop branch, fixes #336
  761. - benchmarks: test create, extract, list, delete, info, check, help, fixes #146
  762. - benchmarks: test with both the binary and the python code
  763. - archiver tests: test with both the binary and the python code, fixes #215
  764. - make basic test more robust
  765. - docs:
  766. - moved docs to borgbackup.readthedocs.org, #155
  767. - a lot of fixes and improvements, use mobile-friendly RTD standard theme
  768. - use zlib,6 compression in some examples, fixes #275
  769. - add missing rename usage to docs, closes #279
  770. - include the help offered by borg help <topic> in the usage docs, fixes #293
  771. - include a list of major changes compared to attic into README, fixes #224
  772. - add OS X install instructions, #197
  773. - more details about the release process, #260
  774. - fix linux glibc requirement (binaries built on debian7 now)
  775. - build: move usage and API generation to setup.py
  776. - update docs about return codes, #61
  777. - remove api docs (too much breakage on rtd)
  778. - borgbackup install + basics presentation (asciinema)
  779. - describe the current style guide in documentation
  780. - add section about debug commands
  781. - warn about not running out of space
  782. - add example for rename
  783. - improve chunker params docs, fixes #362
  784. - minor development docs update
  785. Version 0.27.0 (2015-10-07)
  786. ---------------------------
  787. New features:
  788. - "borg upgrade" command - attic -> borg one time converter / migration, #21
  789. - temporary hack to avoid using lots of disk space for chunks.archive.d, #235:
  790. To use it: rm -rf chunks.archive.d ; touch chunks.archive.d
  791. - respect XDG_CACHE_HOME, attic #181
  792. - add support for arbitrary SSH commands, attic #99
  793. - borg delete --cache-only REPO (only delete cache, not REPO), attic #123
  794. Bug fixes:
  795. - use Debian 7 (wheezy) to build pyinstaller borgbackup binaries, fixes slow
  796. down observed when running the Centos6-built binary on Ubuntu, #222
  797. - do not crash on empty lock.roster, fixes #232
  798. - fix multiple issues with the cache config version check, #234
  799. - fix segment entry header size check, attic #352
  800. plus other error handling improvements / code deduplication there.
  801. - always give segment and offset in repo IntegrityErrors
  802. Other changes:
  803. - stop producing binary wheels, remove docs about it, #147
  804. - docs:
  805. - add warning about prune
  806. - generate usage include files only as needed
  807. - development docs: add Vagrant section
  808. - update / improve / reformat FAQ
  809. - hint to single-file pyinstaller binaries from README
  810. Version 0.26.1 (2015-09-28)
  811. ---------------------------
  812. This is a minor update, just docs and new pyinstaller binaries.
  813. - docs update about python and binary requirements
  814. - better docs for --read-special, fix #220
  815. - re-built the binaries, fix #218 and #213 (glibc version issue)
  816. - update web site about single-file pyinstaller binaries
  817. Note: if you did a python-based installation, there is no need to upgrade.
  818. Version 0.26.0 (2015-09-19)
  819. ---------------------------
  820. New features:
  821. - Faster cache sync (do all in one pass, remove tar/compression stuff), #163
  822. - BORG_REPO env var to specify the default repo, #168
  823. - read special files as if they were regular files, #79
  824. - implement borg create --dry-run, attic issue #267
  825. - Normalize paths before pattern matching on OS X, #143
  826. - support OpenBSD and NetBSD (except xattrs/ACLs)
  827. - support / run tests on Python 3.5
  828. Bug fixes:
  829. - borg mount repo: use absolute path, attic #200, attic #137
  830. - chunker: use off_t to get 64bit on 32bit platform, #178
  831. - initialize chunker fd to -1, so it's not equal to STDIN_FILENO (0)
  832. - fix reaction to "no" answer at delete repo prompt, #182
  833. - setup.py: detect lz4.h header file location
  834. - to support python < 3.2.4, add less buggy argparse lib from 3.2.6 (#194)
  835. - fix for obtaining ``char *`` from temporary Python value (old code causes
  836. a compile error on Mint 17.2)
  837. - llfuse 0.41 install troubles on some platforms, require < 0.41
  838. (UnicodeDecodeError exception due to non-ascii llfuse setup.py)
  839. - cython code: add some int types to get rid of unspecific python add /
  840. subtract operations (avoid ``undefined symbol FPE_``... error on some platforms)
  841. - fix verbose mode display of stdin backup
  842. - extract: warn if a include pattern never matched, fixes #209,
  843. implement counters for Include/ExcludePatterns
  844. - archive names with slashes are invalid, attic issue #180
  845. - chunker: add a check whether the POSIX_FADV_DONTNEED constant is defined -
  846. fixes building on OpenBSD.
  847. Other changes:
  848. - detect inconsistency / corruption / hash collision, #170
  849. - replace versioneer with setuptools_scm, #106
  850. - docs:
  851. - pkg-config is needed for llfuse installation
  852. - be more clear about pruning, attic issue #132
  853. - unit tests:
  854. - xattr: ignore security.selinux attribute showing up
  855. - ext3 seems to need a bit more space for a sparse file
  856. - do not test lzma level 9 compression (avoid MemoryError)
  857. - work around strange mtime granularity issue on netbsd, fixes #204
  858. - ignore st_rdev if file is not a block/char device, fixes #203
  859. - stay away from the setgid and sticky mode bits
  860. - use Vagrant to do easy cross-platform testing (#196), currently:
  861. - Debian 7 "wheezy" 32bit, Debian 8 "jessie" 64bit
  862. - Ubuntu 12.04 32bit, Ubuntu 14.04 64bit
  863. - Centos 7 64bit
  864. - FreeBSD 10.2 64bit
  865. - OpenBSD 5.7 64bit
  866. - NetBSD 6.1.5 64bit
  867. - Darwin (OS X Yosemite)
  868. Version 0.25.0 (2015-08-29)
  869. ---------------------------
  870. Compatibility notes:
  871. - lz4 compression library (liblz4) is a new requirement (#156)
  872. - the new compression code is very compatible: as long as you stay with zlib
  873. compression, older borg releases will still be able to read data from a
  874. repo/archive made with the new code (note: this is not the case for the
  875. default "none" compression, use "zlib,0" if you want a "no compression" mode
  876. that can be read by older borg). Also the new code is able to read repos and
  877. archives made with older borg versions (for all zlib levels 0..9).
  878. Deprecations:
  879. - --compression N (with N being a number, as in 0.24) is deprecated.
  880. We keep the --compression 0..9 for now to not break scripts, but it is
  881. deprecated and will be removed later, so better fix your scripts now:
  882. --compression 0 (as in 0.24) is the same as --compression zlib,0 (now).
  883. BUT: if you do not want compression, you rather want --compression none
  884. (which is the default).
  885. --compression 1 (in 0.24) is the same as --compression zlib,1 (now)
  886. --compression 9 (in 0.24) is the same as --compression zlib,9 (now)
  887. New features:
  888. - create --compression none (default, means: do not compress, just pass through
  889. data "as is". this is more efficient than zlib level 0 as used in borg 0.24)
  890. - create --compression lz4 (super-fast, but not very high compression)
  891. - create --compression zlib,N (slower, higher compression, default for N is 6)
  892. - create --compression lzma,N (slowest, highest compression, default N is 6)
  893. - honor the nodump flag (UF_NODUMP) and do not backup such items
  894. - list --short just outputs a simple list of the files/directories in an archive
  895. Bug fixes:
  896. - fixed --chunker-params parameter order confusion / malfunction, fixes #154
  897. - close fds of segments we delete (during compaction)
  898. - close files which fell out the lrucache
  899. - fadvise DONTNEED now is only called for the byte range actually read, not for
  900. the whole file, fixes #158.
  901. - fix issue with negative "all archives" size, fixes #165
  902. - restore_xattrs: ignore if setxattr fails with EACCES, fixes #162
  903. Other changes:
  904. - remove fakeroot requirement for tests, tests run faster without fakeroot
  905. (test setup does not fail any more without fakeroot, so you can run with or
  906. without fakeroot), fixes #151 and #91.
  907. - more tests for archiver
  908. - recover_segment(): don't assume we have an fd for segment
  909. - lrucache refactoring / cleanup, add dispose function, py.test tests
  910. - generalize hashindex code for any key length (less hardcoding)
  911. - lock roster: catch file not found in remove() method and ignore it
  912. - travis CI: use requirements file
  913. - improved docs:
  914. - replace hack for llfuse with proper solution (install libfuse-dev)
  915. - update docs about compression
  916. - update development docs about fakeroot
  917. - internals: add some words about lock files / locking system
  918. - support: mention BountySource and for what it can be used
  919. - theme: use a lighter green
  920. - add pypi, wheel, dist package based install docs
  921. - split install docs into system-specific preparations and generic instructions
  922. Version 0.24.0 (2015-08-09)
  923. ---------------------------
  924. Incompatible changes (compared to 0.23):
  925. - borg now always issues --umask NNN option when invoking another borg via ssh
  926. on the repository server. By that, it's making sure it uses the same umask
  927. for remote repos as for local ones. Because of this, you must upgrade both
  928. server and client(s) to 0.24.
  929. - the default umask is 077 now (if you do not specify via --umask) which might
  930. be a different one as you used previously. The default umask avoids that
  931. you accidentally give access permissions for group and/or others to files
  932. created by borg (e.g. the repository).
  933. Deprecations:
  934. - "--encryption passphrase" mode is deprecated, see #85 and #97.
  935. See the new "--encryption repokey" mode for a replacement.
  936. New features:
  937. - borg create --chunker-params ... to configure the chunker, fixes #16
  938. (attic #302, attic #300, and somehow also #41).
  939. This can be used to reduce memory usage caused by chunk management overhead,
  940. so borg does not create a huge chunks index/repo index and eats all your RAM
  941. if you back up lots of data in huge files (like VM disk images).
  942. See docs/misc/create_chunker-params.txt for more information.
  943. - borg info now reports chunk counts in the chunk index.
  944. - borg create --compression 0..9 to select zlib compression level, fixes #66
  945. (attic #295).
  946. - borg init --encryption repokey (to store the encryption key into the repo),
  947. fixes #85
  948. - improve at-end error logging, always log exceptions and set exit_code=1
  949. - LoggedIO: better error checks / exceptions / exception handling
  950. - implement --remote-path to allow non-default-path borg locations, #125
  951. - implement --umask M and use 077 as default umask for better security, #117
  952. - borg check: give a named single archive to it, fixes #139
  953. - cache sync: show progress indication
  954. - cache sync: reimplement the chunk index merging in C
  955. Bug fixes:
  956. - fix segfault that happened for unreadable files (chunker: n needs to be a
  957. signed size_t), #116
  958. - fix the repair mode, #144
  959. - repo delete: add destroy to allowed rpc methods, fixes issue #114
  960. - more compatible repository locking code (based on mkdir), maybe fixes #92
  961. (attic #317, attic #201).
  962. - better Exception msg if no Borg is installed on the remote repo server, #56
  963. - create a RepositoryCache implementation that can cope with >2GiB,
  964. fixes attic #326.
  965. - fix Traceback when running check --repair, attic #232
  966. - clarify help text, fixes #73.
  967. - add help string for --no-files-cache, fixes #140
  968. Other changes:
  969. - improved docs:
  970. - added docs/misc directory for misc. writeups that won't be included
  971. "as is" into the html docs.
  972. - document environment variables and return codes (attic #324, attic #52)
  973. - web site: add related projects, fix web site url, IRC #borgbackup
  974. - Fedora/Fedora-based install instructions added to docs
  975. - Cygwin-based install instructions added to docs
  976. - updated AUTHORS
  977. - add FAQ entries about redundancy / integrity
  978. - clarify that borg extract uses the cwd as extraction target
  979. - update internals doc about chunker params, memory usage and compression
  980. - added docs about development
  981. - add some words about resource usage in general
  982. - document how to backup a raw disk
  983. - add note about how to run borg from virtual env
  984. - add solutions for (ll)fuse installation problems
  985. - document what borg check does, fixes #138
  986. - reorganize borgbackup.github.io sidebar, prev/next at top
  987. - deduplicate and refactor the docs / README.rst
  988. - use borg-tmp as prefix for temporary files / directories
  989. - short prune options without "keep-" are deprecated, do not suggest them
  990. - improved tox configuration
  991. - remove usage of unittest.mock, always use mock from pypi
  992. - use entrypoints instead of scripts, for better use of the wheel format and
  993. modern installs
  994. - add requirements.d/development.txt and modify tox.ini
  995. - use travis-ci for testing based on Linux and (new) OS X
  996. - use coverage.py, pytest-cov and codecov.io for test coverage support
  997. I forgot to list some stuff already implemented in 0.23.0, here they are:
  998. New features:
  999. - efficient archive list from manifest, meaning a big speedup for slow
  1000. repo connections and "list <repo>", "delete <repo>", "prune" (attic #242,
  1001. attic #167)
  1002. - big speedup for chunks cache sync (esp. for slow repo connections), fixes #18
  1003. - hashindex: improve error messages
  1004. Other changes:
  1005. - explicitly specify binary mode to open binary files
  1006. - some easy micro optimizations
  1007. Version 0.23.0 (2015-06-11)
  1008. ---------------------------
  1009. Incompatible changes (compared to attic, fork related):
  1010. - changed sw name and cli command to "borg", updated docs
  1011. - package name (and name in urls) uses "borgbackup" to have less collisions
  1012. - changed repo / cache internal magic strings from ATTIC* to BORG*,
  1013. changed cache location to .cache/borg/ - this means that it currently won't
  1014. accept attic repos (see issue #21 about improving that)
  1015. Bug fixes:
  1016. - avoid defect python-msgpack releases, fixes attic #171, fixes attic #185
  1017. - fix traceback when trying to do unsupported passphrase change, fixes attic #189
  1018. - datetime does not like the year 10.000, fixes attic #139
  1019. - fix "info" all archives stats, fixes attic #183
  1020. - fix parsing with missing microseconds, fixes attic #282
  1021. - fix misleading hint the fuse ImportError handler gave, fixes attic #237
  1022. - check unpacked data from RPC for tuple type and correct length, fixes attic #127
  1023. - fix Repository._active_txn state when lock upgrade fails
  1024. - give specific path to xattr.is_enabled(), disable symlink setattr call that
  1025. always fails
  1026. - fix test setup for 32bit platforms, partial fix for attic #196
  1027. - upgraded versioneer, PEP440 compliance, fixes attic #257
  1028. New features:
  1029. - less memory usage: add global option --no-cache-files
  1030. - check --last N (only check the last N archives)
  1031. - check: sort archives in reverse time order
  1032. - rename repo::oldname newname (rename repository)
  1033. - create -v output more informative
  1034. - create --progress (backup progress indicator)
  1035. - create --timestamp (utc string or reference file/dir)
  1036. - create: if "-" is given as path, read binary from stdin
  1037. - extract: if --stdout is given, write all extracted binary data to stdout
  1038. - extract --sparse (simple sparse file support)
  1039. - extra debug information for 'fread failed'
  1040. - delete <repo> (deletes whole repo + local cache)
  1041. - FUSE: reflect deduplication in allocated blocks
  1042. - only allow whitelisted RPC calls in server mode
  1043. - normalize source/exclude paths before matching
  1044. - use posix_fadvise to not spoil the OS cache, fixes attic #252
  1045. - toplevel error handler: show tracebacks for better error analysis
  1046. - sigusr1 / sigint handler to print current file infos - attic PR #286
  1047. - RPCError: include the exception args we get from remote
  1048. Other changes:
  1049. - source: misc. cleanups, pep8, style
  1050. - docs and faq improvements, fixes, updates
  1051. - cleanup crypto.pyx, make it easier to adapt to other AES modes
  1052. - do os.fsync like recommended in the python docs
  1053. - source: Let chunker optionally work with os-level file descriptor.
  1054. - source: Linux: remove duplicate os.fsencode calls
  1055. - source: refactor _open_rb code a bit, so it is more consistent / regular
  1056. - source: refactor indicator (status) and item processing
  1057. - source: use py.test for better testing, flake8 for code style checks
  1058. - source: fix tox >=2.0 compatibility (test runner)
  1059. - pypi package: add python version classifiers, add FreeBSD to platforms
  1060. Attic Changelog
  1061. ---------------
  1062. Here you can see the full list of changes between each Attic release until Borg
  1063. forked from Attic:
  1064. Version 0.17
  1065. ~~~~~~~~~~~~
  1066. (bugfix release, released on X)
  1067. - Fix hashindex ARM memory alignment issue (#309)
  1068. - Improve hashindex error messages (#298)
  1069. Version 0.16
  1070. ~~~~~~~~~~~~
  1071. (bugfix release, released on May 16, 2015)
  1072. - Fix typo preventing the security confirmation prompt from working (#303)
  1073. - Improve handling of systems with improperly configured file system encoding (#289)
  1074. - Fix "All archives" output for attic info. (#183)
  1075. - More user friendly error message when repository key file is not found (#236)
  1076. - Fix parsing of iso 8601 timestamps with zero microseconds (#282)
  1077. Version 0.15
  1078. ~~~~~~~~~~~~
  1079. (bugfix release, released on Apr 15, 2015)
  1080. - xattr: Be less strict about unknown/unsupported platforms (#239)
  1081. - Reduce repository listing memory usage (#163).
  1082. - Fix BrokenPipeError for remote repositories (#233)
  1083. - Fix incorrect behavior with two character directory names (#265, #268)
  1084. - Require approval before accessing relocated/moved repository (#271)
  1085. - Require approval before accessing previously unknown unencrypted repositories (#271)
  1086. - Fix issue with hash index files larger than 2GB.
  1087. - Fix Python 3.2 compatibility issue with noatime open() (#164)
  1088. - Include missing pyx files in dist files (#168)
  1089. Version 0.14
  1090. ~~~~~~~~~~~~
  1091. (feature release, released on Dec 17, 2014)
  1092. - Added support for stripping leading path segments (#95)
  1093. "attic extract --strip-segments X"
  1094. - Add workaround for old Linux systems without acl_extended_file_no_follow (#96)
  1095. - Add MacPorts' path to the default openssl search path (#101)
  1096. - HashIndex improvements, eliminates unnecessary IO on low memory systems.
  1097. - Fix "Number of files" output for attic info. (#124)
  1098. - limit create file permissions so files aren't read while restoring
  1099. - Fix issue with empty xattr values (#106)
  1100. Version 0.13
  1101. ~~~~~~~~~~~~
  1102. (feature release, released on Jun 29, 2014)
  1103. - Fix sporadic "Resource temporarily unavailable" when using remote repositories
  1104. - Reduce file cache memory usage (#90)
  1105. - Faster AES encryption (utilizing AES-NI when available)
  1106. - Experimental Linux, OS X and FreeBSD ACL support (#66)
  1107. - Added support for backup and restore of BSDFlags (OSX, FreeBSD) (#56)
  1108. - Fix bug where xattrs on symlinks were not correctly restored
  1109. - Added cachedir support. CACHEDIR.TAG compatible cache directories
  1110. can now be excluded using ``--exclude-caches`` (#74)
  1111. - Fix crash on extreme mtime timestamps (year 2400+) (#81)
  1112. - Fix Python 3.2 specific lockf issue (EDEADLK)
  1113. Version 0.12
  1114. ~~~~~~~~~~~~
  1115. (feature release, released on April 7, 2014)
  1116. - Python 3.4 support (#62)
  1117. - Various documentation improvements a new style
  1118. - ``attic mount`` now supports mounting an entire repository not only
  1119. individual archives (#59)
  1120. - Added option to restrict remote repository access to specific path(s):
  1121. ``attic serve --restrict-to-path X`` (#51)
  1122. - Include "all archives" size information in "--stats" output. (#54)
  1123. - Added ``--stats`` option to ``attic delete`` and ``attic prune``
  1124. - Fixed bug where ``attic prune`` used UTC instead of the local time zone
  1125. when determining which archives to keep.
  1126. - Switch to SI units (Power of 1000 instead 1024) when printing file sizes
  1127. Version 0.11
  1128. ~~~~~~~~~~~~
  1129. (feature release, released on March 7, 2014)
  1130. - New "check" command for repository consistency checking (#24)
  1131. - Documentation improvements
  1132. - Fix exception during "attic create" with repeated files (#39)
  1133. - New "--exclude-from" option for attic create/extract/verify.
  1134. - Improved archive metadata deduplication.
  1135. - "attic verify" has been deprecated. Use "attic extract --dry-run" instead.
  1136. - "attic prune --hourly|daily|..." has been deprecated.
  1137. Use "attic prune --keep-hourly|daily|..." instead.
  1138. - Ignore xattr errors during "extract" if not supported by the filesystem. (#46)
  1139. Version 0.10
  1140. ~~~~~~~~~~~~
  1141. (bugfix release, released on Jan 30, 2014)
  1142. - Fix deadlock when extracting 0 sized files from remote repositories
  1143. - "--exclude" wildcard patterns are now properly applied to the full path
  1144. not just the file name part (#5).
  1145. - Make source code endianness agnostic (#1)
  1146. Version 0.9
  1147. ~~~~~~~~~~~
  1148. (feature release, released on Jan 23, 2014)
  1149. - Remote repository speed and reliability improvements.
  1150. - Fix sorting of segment names to ignore NFS left over files. (#17)
  1151. - Fix incorrect display of time (#13)
  1152. - Improved error handling / reporting. (#12)
  1153. - Use fcntl() instead of flock() when locking repository/cache. (#15)
  1154. - Let ssh figure out port/user if not specified so we don't override .ssh/config (#9)
  1155. - Improved libcrypto path detection (#23).
  1156. Version 0.8.1
  1157. ~~~~~~~~~~~~~
  1158. (bugfix release, released on Oct 4, 2013)
  1159. - Fix segmentation fault issue.
  1160. Version 0.8
  1161. ~~~~~~~~~~~
  1162. (feature release, released on Oct 3, 2013)
  1163. - Fix xattr issue when backing up sshfs filesystems (#4)
  1164. - Fix issue with excessive index file size (#6)
  1165. - Support access of read only repositories.
  1166. - New syntax to enable repository encryption:
  1167. attic init --encryption="none|passphrase|keyfile".
  1168. - Detect and abort if repository is older than the cache.
  1169. Version 0.7
  1170. ~~~~~~~~~~~
  1171. (feature release, released on Aug 5, 2013)
  1172. - Ported to FreeBSD
  1173. - Improved documentation
  1174. - Experimental: Archives mountable as fuse filesystems.
  1175. - The "user." prefix is no longer stripped from xattrs on Linux
  1176. Version 0.6.1
  1177. ~~~~~~~~~~~~~
  1178. (bugfix release, released on July 19, 2013)
  1179. - Fixed an issue where mtime was not always correctly restored.
  1180. Version 0.6
  1181. ~~~~~~~~~~~
  1182. First public release on July 9, 2013