changes.rst 81 KB

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