changes.rst 81 KB

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