NEWS 79 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430
  1. 1.9.0
  2. * #609: Fix the glob expansion of "source_directories" values to respect the "working_directory"
  3. option.
  4. * #609: BREAKING: Apply the "working_directory" option to all actions, not just "create". This
  5. includes repository paths, destination paths, mount points, etc.
  6. * #562: Deprecate the "borgmatic_source_directory" option in favor of "user_runtime_directory"
  7. and "user_state_directory".
  8. * #562: BREAKING: Move the default borgmatic streaming database dump and bootstrap metadata
  9. directory from ~/.borgmatic to /run/user/$UID/borgmatic, which is more XDG-compliant. You can
  10. override this location with the new "user_runtime_directory" option. Existing archives with
  11. database dumps at the old location are still restorable.
  12. * #562, #638: Move the default check state directory from ~/.borgmatic to
  13. ~/.local/state/borgmatic. This is more XDG-compliant and also prevents these state files from
  14. getting backed up (unless you explicitly include them). You can override this location with the
  15. new "user_state_directory" option. After the first time you run the "check" action with borgmatic
  16. 1.9.0, you can safely delete the ~/.borgmatic directory.
  17. * #838: BREAKING: With Borg 1.4+, store database dumps and bootstrap metadata in a "/borgmatic"
  18. directory within a backup archive, so the path doesn't depend on the current user. This means
  19. that you can now backup as one user and restore or bootstrap as another user, among other use
  20. cases.
  21. * #902: Add loading of encrypted systemd credentials. See the documentation for more information:
  22. https://torsion.org/borgmatic/docs/how-to/provide-your-passwords/#using-systemd-service-credentials
  23. * #914: Fix a confusing apparent hang when when the repository location changes, and instead
  24. show a helpful error message.
  25. * #915: BREAKING: Rename repository actions like "rcreate" to more explicit names like
  26. "repo-create" for compatibility with recent changes in Borg 2.0.0b10.
  27. * #918: BREAKING: When databases are configured, don't auto-enable the "one_file_system" option,
  28. as existing auto-excludes of special files should be sufficient to prevent Borg from hanging on
  29. them. But if this change causes problems for you, you can always enable "one_file_system"
  30. explicitly.
  31. * #919: Clarify the command-line help for the "--config" flag.
  32. * #919: Document a policy for versioning and breaking changes:
  33. https://torsion.org/borgmatic/docs/how-to/upgrade/#versioning-and-breaking-changes
  34. * #911: Add a "key change-passphrase" action to change the passphrase protecting a repository key.
  35. * #921: BREAKING: Change soft failure command hooks to skip only the current repository rather than
  36. all repositories in the configuration file.
  37. * #922: Replace setup.py (Python packaging metadata) with the more modern pyproject.toml.
  38. * When using Borg 2, default the "archive_name_format" option to just "{hostname}", as Borg 2 does
  39. not require unique archive names; identical archive names form a common "series" that can be
  40. targeted together. See the Borg 2 documentation for more information:
  41. https://borgbackup.readthedocs.io/en/2.0.0b13/changes.html#borg-1-2-x-1-4-x-to-borg-2-0
  42. * Add support for Borg 2's "rclone:" repository URLs, so you can backup to 70+ cloud storage
  43. services whether or not they support Borg explicitly.
  44. * Add support for Borg 2's "sftp://" repository URLs.
  45. * Update the "--match-archives" and "--archive" flags to support Borg 2 series names or archive
  46. hashes.
  47. * Add a "--match-archives" flag to the "prune" action.
  48. * Add "--local-path" and "--remote-path" flags to the "config bootstrap" action for setting the
  49. Borg executable paths used for bootstrapping.
  50. * Add a "--user-runtime-directory" flag to the "config bootstrap" action for helping borgmatic
  51. locate the bootstrap metadata stored in an archive.
  52. * Add a Zabbix monitoring hook. See the documentation for more information:
  53. https://torsion.org/borgmatic/docs/how-to/monitor-your-backups/#zabbix-hook
  54. * Add a tarball of borgmatic's HTML documentation to the packages on the project page.
  55. 1.8.14
  56. * #896: Fix an error in borgmatic rcreate/init on an empty repository directory with Borg 1.4.
  57. * #898: Add glob ("*") support to the "--repository" flag. Just quote any values containing
  58. globs so your shell doesn't interpret them.
  59. * #899: Fix for a "bad character" Borg error in which the "spot" check fed Borg an invalid pattern.
  60. * #900: Fix for a potential traceback (TypeError) during the handling of another error.
  61. * #904: Clarify the configuration reference about the "spot" check options:
  62. https://torsion.org/borgmatic/docs/reference/configuration/
  63. * #905: Fix the "source_directories_must_exist" option to work with relative "source_directories"
  64. paths when a "working_directory" is set.
  65. * #906: Add documentation details for how to run custom database dump commands using binaries from
  66. running containers:
  67. https://torsion.org/borgmatic/docs/how-to/backup-your-databases/#containers
  68. * Fix a regression in which the "color" option had no effect.
  69. * Add a recent contributors section to the documentation, because credit where credit's due! See:
  70. https://torsion.org/borgmatic/#recent-contributors
  71. 1.8.13
  72. * #298: Add "delete" and "rdelete" actions to delete archives or entire repositories.
  73. * #785: Add an "only_run_on" option to consistency checks so you can limit a check to running on
  74. particular days of the week. See the documentation for more information:
  75. https://torsion.org/borgmatic/docs/how-to/deal-with-very-large-backups/#check-days
  76. * #885: Add an Uptime Kuma monitoring hook. See the documentation for more information:
  77. https://torsion.org/borgmatic/docs/how-to/monitor-your-backups/#uptime-kuma-hook
  78. * #886: Fix a PagerDuty hook traceback with Python < 3.10.
  79. * #889: Fix the Healthchecks ping body size limit, restoring it to the documented 100,000 bytes.
  80. 1.8.12
  81. * #817: Add a "--max-duration" flag to the "check" action and a "max_duration" option to the
  82. repository check configuration. This tells Borg to interrupt a repository check after a certain
  83. duration.
  84. * #860: Fix interaction between environment variable interpolation in constants and shell escaping.
  85. * #863: When color output is disabled (explicitly or implicitly), don't prefix each log line with
  86. the log level.
  87. * #865: Add an "upload_buffer_size" option to set the size of the upload buffer used in "create"
  88. action.
  89. * #866: Fix "Argument list too long" error in the "spot" check when checking hundreds of thousands
  90. of files at once.
  91. * #874: Add the configured repository label as "repository_label" to the interpolated variables
  92. passed to before/after command hooks.
  93. * #881: Fix "Unrecognized argument" error when the same value is used with different command-line
  94. flags.
  95. * In the "spot" check, don't try to hash symlinked directories.
  96. 1.8.11
  97. * #815: Add optional Healthchecks auto-provisioning via "create_slug" option.
  98. * #851: Fix lack of file extraction when using "extract --strip-components all" on a path with a
  99. leading slash.
  100. * #854: Fix a traceback when the "data" consistency check is used.
  101. * #857: Fix a traceback with "check --only spot" when the "spot" check is unconfigured.
  102. 1.8.10
  103. * #656 (beta): Add a "spot" consistency check that compares file counts and contents between your
  104. source files and the latest archive, ensuring they fall within configured tolerances. This can
  105. catch problems like incorrect excludes, inadvertent deletes, files changed by malware, etc. See
  106. the documentation for more information:
  107. https://torsion.org/borgmatic/docs/how-to/deal-with-very-large-backups/#spot-check
  108. * #779: When "--match-archives *" is used with "check" action, don't skip Borg's orphaned objects
  109. check.
  110. * #842: When a command hook exits with a soft failure, ping the log and finish states for any
  111. configured monitoring hooks.
  112. * #843: Add documentation link to Loki dashboard for borgmatic:
  113. https://torsion.org/borgmatic/docs/how-to/monitor-your-backups/#loki-hook
  114. * #847: Fix "--json" error when Borg includes non-JSON warnings in JSON output.
  115. * #848: SECURITY: Mask the password when logging a MongoDB dump or restore command.
  116. * Fix handling of the NO_COLOR environment variable to ignore an empty value.
  117. * Add documentation about backing up containerized databases by configuring borgmatic to exec into
  118. a container to run a dump command:
  119. https://torsion.org/borgmatic/docs/how-to/backup-your-databases/#containers
  120. 1.8.9
  121. * #311: Add custom dump/restore command options for MySQL and MariaDB.
  122. * #811: Add an "access_token" option to the ntfy monitoring hook for authenticating
  123. without username/password.
  124. * #827: When the "--json" flag is given, suppress console escape codes so as not to
  125. interfere with JSON output.
  126. * #829: Fix "--override" values containing deprecated section headers not actually overriding
  127. configuration options under deprecated section headers.
  128. * #835: Add support for the NO_COLOR environment variable. See the documentation for more
  129. information:
  130. https://torsion.org/borgmatic/docs/how-to/set-up-backups/#colored-output
  131. * #839: Add log sending for the Apprise logging hook, enabled by default. See the documentation for
  132. more information:
  133. https://torsion.org/borgmatic/docs/how-to/monitor-your-backups/#apprise-hook
  134. * #839: Document a potentially breaking shell quoting edge case within error hooks:
  135. https://torsion.org/borgmatic/docs/how-to/monitor-your-backups/#error-hooks
  136. * #840: When running the "rcreate" action and the repository already exists but with a different
  137. encryption mode than requested, error.
  138. * Switch from Drone to Gitea Actions for continuous integration.
  139. * Rename scripts/run-end-to-end-dev-tests to scripts/run-end-to-end-tests and use it in both dev
  140. and CI for better dev-CI parity.
  141. * Clarify documentation about restoring a database: borgmatic does not create the database upon
  142. restore.
  143. 1.8.8
  144. * #370: For the PostgreSQL hook, pass the "PGSSLMODE" environment variable through to Borg when the
  145. database's configuration omits the "ssl_mode" option.
  146. * #818: Allow the "--repository" flag to match across multiple configuration files.
  147. * #820: Fix broken repository detection in the "rcreate" action with Borg 1.4. The issue did not
  148. occur with other versions of Borg.
  149. * #822: Fix broken escaping logic in the PostgreSQL hook's "pg_dump_command" option.
  150. * SECURITY: Prevent additional shell injection attacks within the PostgreSQL hook.
  151. 1.8.7
  152. * #736: Store included configuration files within each backup archive in support of the "config
  153. bootstrap" action. Previously, only top-level configuration files were stored.
  154. * #798: Elevate specific Borg warnings to errors or squash errors to
  155. * warnings. See the documentation for more information:
  156. https://torsion.org/borgmatic/docs/how-to/customize-warnings-and-errors/
  157. * #810: SECURITY: Prevent shell injection attacks within the PostgreSQL hook, the MongoDB hook, the
  158. SQLite hook, the "borgmatic borg" action, and command hook variable/constant interpolation.
  159. * #814: Fix a traceback when providing an invalid "--override" value for a list option.
  160. 1.8.6
  161. * #767: Add an "--ssh-command" flag to the "config bootstrap" action for setting a custom SSH
  162. command, as no configuration is available (including the "ssh_command" option) until
  163. bootstrapping completes.
  164. * #794: Fix a traceback when the "repositories" option contains both strings and key/value pairs.
  165. * #800: Add configured repository labels to the JSON output for all actions.
  166. * #802: The "check --force" flag now runs checks even if "check" is in "skip_actions".
  167. * #804: Validate the configured action names in the "skip_actions" option.
  168. * #807: Stream SQLite databases directly to Borg instead of dumping to an intermediate file.
  169. * When logging commands that borgmatic executes, log the environment variables that
  170. borgmatic sets for those commands. (But don't log their values, since they often contain
  171. passwords.)
  172. 1.8.5
  173. * #701: Add a "skip_actions" option to skip running particular actions, handy for append-only or
  174. checkless configurations. See the documentation for more information:
  175. https://torsion.org/borgmatic/docs/how-to/set-up-backups/#skipping-actions
  176. * #701: Deprecate the "disabled" value for the "checks" option in favor of the new "skip_actions"
  177. option.
  178. * #745: Constants now apply to included configuration, not just the file doing the includes. As a
  179. side effect of this change, constants no longer apply to option names and only substitute into
  180. configuration values.
  181. * #779: Add a "--match-archives" flag to the "check" action for selecting the archives to check,
  182. overriding the existing "archive_name_format" and "match_archives" options in configuration.
  183. * #779: Only parse "--override" values as complex data types when they're for options of those
  184. types.
  185. * #782: Fix environment variable interpolation within configured repository paths.
  186. * #782: Add configuration constant overriding via the existing "--override" flag.
  187. * #783: Upgrade ruamel.yaml dependency to support version 0.18.x.
  188. * #784: Drop support for Python 3.7, which has been end-of-lifed.
  189. 1.8.4
  190. * #715: Add a monitoring hook for sending backup status to a variety of monitoring services via the
  191. Apprise library. See the documentation for more information:
  192. https://torsion.org/borgmatic/docs/how-to/monitor-your-backups/#apprise-hook
  193. * #748: When an archive filter causes no matching archives for the "rlist" or "info"
  194. actions, warn the user and suggest how to remove the filter.
  195. * #768: Fix a traceback when an invalid command-line flag or action is used.
  196. * #771: Fix normalization of deprecated sections ("location:", "storage:", "hooks:", etc.) to
  197. support empty sections without erroring.
  198. * #774: Disallow the "--dry-run" flag with the "borg" action, as borgmatic can't guarantee the Borg
  199. command won't have side effects.
  200. 1.8.3
  201. * #665: BREAKING: Simplify logging logic as follows: Syslog verbosity is now disabled by
  202. default, but setting the "--syslog-verbosity" flag enables it regardless of whether you're at an
  203. interactive console. Additionally, "--log-file-verbosity" and "--monitoring-verbosity" now
  204. default to 1 (info about steps borgmatic is taking) instead of 0. And both syslog logging and
  205. file logging can be enabled simultaneously.
  206. * #743: Add a monitoring hook for sending backup status and logs to Grafana Loki. See the
  207. documentation for more information:
  208. https://torsion.org/borgmatic/docs/how-to/monitor-your-backups/#loki-hook
  209. * #753: When "archive_name_format" is not set, filter archives using the default archive name
  210. format.
  211. * #754: Fix error handling to log command output as one record per line instead of truncating
  212. too-long output and swallowing the end of some Borg error messages.
  213. * #757: Update documentation so "sudo borgmatic" works for pipx borgmatic installations.
  214. * #761: Fix for borgmatic not stopping Borg immediately when the user presses ctrl-C.
  215. * Update documentation to recommend installing/upgrading borgmatic with pipx instead of pip. See the
  216. documentation for more information:
  217. https://torsion.org/borgmatic/docs/how-to/set-up-backups/#installation
  218. https://torsion.org/borgmatic/docs/how-to/upgrade/#upgrading-borgmatic
  219. 1.8.2
  220. * #345: Add "key export" action to export a copy of the repository key for safekeeping in case
  221. the original goes missing or gets damaged.
  222. * #727: Add a MariaDB database hook that uses native MariaDB commands instead of the deprecated
  223. MySQL ones. Be aware though that any existing backups made with the "mysql_databases:" hook are
  224. only restorable with a "mysql_databases:" configuration.
  225. * #738: Fix for potential data loss (data not getting restored) in which the database "restore"
  226. action didn't actually restore anything and indicated success anyway.
  227. * Remove the deprecated use of the MongoDB hook's "--db" flag for database restoration.
  228. * Add source code reference documentation for getting oriented with the borgmatic code as a
  229. developer: https://torsion.org/borgmatic/docs/reference/source-code/
  230. 1.8.1
  231. * #326: Add documentation for restoring a database to an alternate host:
  232. https://torsion.org/borgmatic/docs/how-to/backup-your-databases/#restore-to-an-alternate-host
  233. * #697: Add documentation for "bootstrap" action:
  234. https://torsion.org/borgmatic/docs/how-to/extract-a-backup/#extract-the-configuration-files-used-to-create-an-archive
  235. * #725: Add "store_config_files" option for disabling the automatic backup of configuration files
  236. used by the "config bootstrap" action.
  237. * #728: Fix for "prune" action error when using the "keep_exclude_tags" option.
  238. * #730: Fix for Borg's interactive prompt on the "check --repair" action automatically getting
  239. answered "NO" even when the "check_i_know_what_i_am_doing" option isn't set.
  240. * #732: Include multiple configuration files with a single "!include". See the documentation for
  241. more information:
  242. https://torsion.org/borgmatic/docs/how-to/make-per-application-backups/#multiple-merge-includes
  243. * #734: Omit "--glob-archives" or "--match-archives" Borg flag when its value would be "*" (meaning
  244. all archives).
  245. 1.8.0
  246. * #575: BREAKING: For the "borgmatic borg" action, instead of implicitly injecting
  247. repository/archive into the resulting Borg command-line, pass repository to Borg via an
  248. environment variable and make archive available for explicit use in your commands. See the
  249. documentation for more information:
  250. https://torsion.org/borgmatic/docs/how-to/run-arbitrary-borg-commands/
  251. * #719: Fix an error when running "borg key export" through borgmatic.
  252. * #720: Fix an error when dumping a database and the "exclude_nodump" option is set.
  253. * #724: Add "check_i_know_what_i_am_doing" option to bypass Borg confirmation prompt when running
  254. "check --repair".
  255. * When merging two configuration files, error gracefully if the two files do not adhere to the same
  256. format.
  257. * #721: Remove configuration sections ("location:", "storage:", "hooks:", etc.), while still
  258. keeping deprecated support for them. Now, all options are at the same level, and you don't need
  259. to worry about commenting/uncommenting section headers when you change an option (if you remove
  260. your sections first).
  261. * #721: BREAKING: The retention prefix and the consistency prefix can no longer have different
  262. values (unless one is not set).
  263. * #721: BREAKING: The storage umask and the hooks umask can no longer have different values (unless
  264. one is not set).
  265. * BREAKING: Flags like "--config" that previously took multiple values now need to be given once
  266. per value, e.g. "--config first.yaml --config second.yaml" instead of "--config first.yaml
  267. second.yaml". This prevents argument parsing errors on ambiguous commands.
  268. * BREAKING: Remove the deprecated (and silently ignored) "--successful" flag on the "list" action,
  269. as newer versions of Borg list successful (non-checkpoint) archives by default.
  270. * All deprecated configuration option values now generate warning logs.
  271. * Remove the deprecated (and non-functional) "--excludes" flag in favor of excludes within
  272. configuration.
  273. * Fix an error when logging too-long command output during error handling. Now, long command output
  274. is truncated before logging.
  275. 1.7.15
  276. * #326: Add configuration options and command-line flags for backing up a database from one
  277. location while restoring it somewhere else.
  278. * #399: Add a documentation troubleshooting note for MySQL/MariaDB authentication errors.
  279. * #529: Remove upgrade-borgmatic-config command for upgrading borgmatic 1.1.0 INI-style
  280. configuration.
  281. * #529: Deprecate generate-borgmatic-config in favor of new "config generate" action.
  282. * #529: Deprecate validate-borgmatic-config in favor of new "config validate" action.
  283. * #697, #712, #716: Extract borgmatic configuration from backup via new "config bootstrap"
  284. action—even when borgmatic has no configuration yet!
  285. * #669: Add sample systemd user service for running borgmatic as a non-root user.
  286. * #711, #713: Fix an error when "data" check time files are accessed without getting upgraded
  287. first.
  288. 1.7.14
  289. * #484: Add a new verbosity level (-2) to disable output entirely (for console, syslog, log file,
  290. or monitoring), so not even errors are shown.
  291. * #688: Tweak archive check probing logic to use the newest timestamp found when multiple exist.
  292. * #659: Add Borg 2 date-based matching flags to various actions for archive selection.
  293. * #703: Fix an error when loading the configuration schema on Fedora Linux.
  294. * #704: Fix "check" action error when repository and archive checks are configured but the archive
  295. check gets skipped due to the configured frequency.
  296. * #706: Fix "--archive latest" on "list" and "info" actions that only worked on the first of
  297. multiple configured repositories.
  298. 1.7.13
  299. * #375: Restore particular PostgreSQL schemas from a database dump via "borgmatic restore --schema"
  300. flag. See the documentation for more information:
  301. https://torsion.org/borgmatic/docs/how-to/backup-your-databases/#restore-particular-schemas
  302. * #678: Fix error from PostgreSQL when dumping a database with a "format" of "plain".
  303. * #678: Fix PostgreSQL hook to support "psql_command" and "pg_restore_command" options containing
  304. commands with arguments.
  305. * #678: Fix calls to psql in PostgreSQL hook to ignore "~/.psqlrc", whose settings can break
  306. database dumping.
  307. * #680: Add support for logging each log line as a JSON object via global "--log-json" flag.
  308. * #682: Fix "source_directories_must_exist" option to expand globs and tildes in source directories.
  309. * #684: Rename "master" development branch to "main" to use more inclusive language. You'll need to
  310. update your development checkouts accordingly.
  311. * #686: Add fish shell completion script so you can tab-complete on the borgmatic command-line. See
  312. the documentation for more information:
  313. https://torsion.org/borgmatic/docs/how-to/set-up-backups/#shell-completion
  314. * #687: Fix borgmatic error when not finding the configuration schema for certain "pip install
  315. --editable" development installs.
  316. * #688: Fix archive checks being skipped even when particular archives haven't been checked
  317. recently. This occurred when using multiple borgmatic configuration files with different
  318. "archive_name_format"s, for instance.
  319. * #691: Fix error in "borgmatic restore" action when the configured repository path is relative
  320. instead of absolute.
  321. * #694: Run "borgmatic borg" action without capturing output so interactive prompts and flags like
  322. "--progress" still work.
  323. 1.7.12
  324. * #413: Add "log_file" context to command hooks so your scripts can consume the borgmatic log file.
  325. See the documentation for more information:
  326. https://torsion.org/borgmatic/docs/how-to/add-preparation-and-cleanup-steps-to-backups/
  327. * #666, #670: Fix error when running the "info" action with the "--match-archives" or "--archive"
  328. flags. Also fix the "--match-archives"/"--archive" flags to correctly override the
  329. "match_archives" configuration option for the "transfer", "list", "rlist", and "info" actions.
  330. * #668: Fix error when running the "prune" action with both "archive_name_format" and "prefix"
  331. options set.
  332. * #672: Selectively shallow merge certain mappings or sequences when including configuration files.
  333. See the documentation for more information:
  334. https://torsion.org/borgmatic/docs/how-to/make-per-application-backups/#shallow-merge
  335. * #672: Selectively omit list values when including configuration files. See the documentation for
  336. more information:
  337. https://torsion.org/borgmatic/docs/how-to/make-per-application-backups/#list-merge
  338. * #673: View the results of configuration file merging via "validate-borgmatic-config --show" flag.
  339. See the documentation for more information:
  340. https://torsion.org/borgmatic/docs/how-to/make-per-application-backups/#debugging-includes
  341. * Add optional support for running end-to-end tests and building documentation with rootless Podman
  342. instead of Docker.
  343. 1.7.11
  344. * #479, #588: BREAKING: Automatically use the "archive_name_format" option to filter which archives
  345. get used for borgmatic actions that operate on multiple archives. Override this behavior with the
  346. new "match_archives" option in the storage section. This change is "breaking" in that it silently
  347. changes which archives get considered for "rlist", "prune", "check", etc. See the documentation
  348. for more information:
  349. https://torsion.org/borgmatic/docs/how-to/make-per-application-backups/#archive-naming
  350. * #479, #588: The "prefix" options have been deprecated in favor of the new "archive_name_format"
  351. auto-matching behavior and the "match_archives" option.
  352. * #658: Add "--log-file-format" flag for customizing the log message format. See the documentation
  353. for more information:
  354. https://torsion.org/borgmatic/docs/how-to/inspect-your-backups/#logging-to-file
  355. * #662: Fix regression in which the "check_repositories" option failed to match repositories.
  356. * #663: Fix regression in which the "transfer" action produced a traceback.
  357. * Add spellchecking of source code during test runs.
  358. 1.7.10
  359. * #396: When a database command errors, display and log the error message instead of swallowing it.
  360. * #501: Optionally error if a source directory does not exist via "source_directories_must_exist"
  361. option in borgmatic's location configuration.
  362. * #576: Add support for "file://" paths within "repositories" option.
  363. * #612: Define and use custom constants in borgmatic configuration files. See the documentation for
  364. more information:
  365. https://torsion.org/borgmatic/docs/how-to/make-per-application-backups/#constant-interpolation
  366. * #618: Add support for BORG_FILES_CACHE_TTL environment variable via "borg_files_cache_ttl" option
  367. in borgmatic's storage configuration.
  368. * #623: Fix confusing message when an error occurs running actions for a configuration file.
  369. * #635: Add optional repository labels so you can select a repository via "--repository yourlabel"
  370. at the command-line. See the configuration reference for more information:
  371. https://torsion.org/borgmatic/docs/reference/configuration/
  372. * #649: Add documentation on backing up a database running in a container:
  373. https://torsion.org/borgmatic/docs/how-to/backup-your-databases/#containers
  374. * #655: Fix error when databases are configured and a source directory doesn't exist.
  375. * Add code style plugins to enforce use of Python f-strings and prevent single-letter variables.
  376. To join in the pedantry, refresh your test environment with "tox --recreate".
  377. * Rename scripts/run-full-dev-tests to scripts/run-end-to-end-dev-tests and make it run end-to-end
  378. tests only. Continue using tox to run unit and integration tests.
  379. 1.7.9
  380. * #295: Add a SQLite database dump/restore hook.
  381. * #304: Change the default action order when no actions are specified on the command-line to:
  382. "create", "prune", "compact", "check". If you'd like to retain the old ordering ("prune" and
  383. "compact" first), then specify actions explicitly on the command-line.
  384. * #304: Run any command-line actions in the order specified instead of using a fixed ordering.
  385. * #564: Add "--repository" flag to all actions where it makes sense, so you can run borgmatic on
  386. a single configured repository instead of all of them.
  387. * #628: Add a Healthchecks "log" state to send borgmatic logs to Healthchecks without signalling
  388. success or failure.
  389. * #647: Add "--strip-components all" feature on the "extract" action to remove leading path
  390. components of files you extract. Must be used with the "--path" flag.
  391. * Add support for Python 3.11.
  392. 1.7.8
  393. * #620: With the "create" action and the "--list" ("--files") flag, only show excluded files at
  394. verbosity 2.
  395. * #621: Add optional authentication to the ntfy monitoring hook.
  396. * With the "create" action, only one of "--list" ("--files") and "--progress" flags can be used.
  397. This lines up with the new behavior in Borg 2.0.0b5.
  398. * Internally support new Borg 2.0.0b5 "--filter" status characters / item flags for the "create"
  399. action.
  400. * Fix the "create" action with the "--dry-run" flag querying for databases when a PostgreSQL/MySQL
  401. "all" database is configured. Now, these queries are skipped due to the dry run.
  402. * Add "--repository" flag to the "rcreate" action to optionally select one configured repository to
  403. create.
  404. * Add "--progress" flag to the "transfer" action, new in Borg 2.0.0b5.
  405. * Add "checkpoint_volume" configuration option to creates checkpoints every specified number of
  406. bytes during a long-running backup, new in Borg 2.0.0b5.
  407. 1.7.7
  408. * #642: Add MySQL database hook "add_drop_database" configuration option to control whether dumped
  409. MySQL databases get dropped right before restore.
  410. * #643: Fix for potential data loss (data not getting backed up) when dumping large "directory"
  411. format PostgreSQL/MongoDB databases. Prior to the fix, these dumps would not finish writing to
  412. disk before Borg consumed them. Now, the dumping process completes before Borg starts. This only
  413. applies to "directory" format databases; other formats still stream to Borg without using
  414. temporary disk space.
  415. * Fix MongoDB "directory" format to work with mongodump/mongorestore without error. Prior to this
  416. fix, only the "archive" format worked.
  417. 1.7.6
  418. * #393, #438, #560: Optionally dump "all" PostgreSQL/MySQL databases to separate files instead of
  419. one combined dump file, allowing more convenient restores of individual databases. You can enable
  420. this by specifying the database dump "format" option when the database is named "all".
  421. * #602: Fix logs that interfere with JSON output by making warnings go to stderr instead of stdout.
  422. * #622: Fix traceback when include merging configuration files on ARM64.
  423. * #629: Skip warning about excluded special files when no special files have been excluded.
  424. * #630: Add configuration options for database command customization: "list_options",
  425. "restore_options", and "analyze_options" for PostgreSQL, "restore_options" for MySQL, and
  426. "restore_options" for MongoDB.
  427. 1.7.5
  428. * #311: Override PostgreSQL dump/restore commands via configuration options.
  429. * #604: Fix traceback when a configuration section is present but lacking any options.
  430. * #607: Clarify documentation examples for include merging and deep merging.
  431. * #611: Fix "data" consistency check to support "check_last" and consistency "prefix" options.
  432. * #613: Clarify documentation about multiple repositories and separate configuration files.
  433. 1.7.4
  434. * #596: Fix special file detection erroring when broken symlinks are encountered.
  435. * #597, #598: Fix regression in which "check" action errored on certain systems ("Cannot determine
  436. Borg repository ID").
  437. 1.7.3
  438. * #357: Add "break-lock" action for removing any repository and cache locks leftover from Borg
  439. aborting.
  440. * #360: To prevent Borg hangs, unconditionally delete stale named pipes before dumping databases.
  441. * #587: When database hooks are enabled, auto-exclude special files from a "create" action to
  442. prevent Borg from hanging. You can override/prevent this behavior by explicitly setting the
  443. "read_special" option to true.
  444. * #587: Warn when ignoring a configured "read_special" value of false, as true is needed when
  445. database hooks are enabled.
  446. * #589: Update sample systemd service file to allow system "idle" (e.g. a video monitor turning
  447. off) while borgmatic is running.
  448. * #590: Fix for potential data loss (data not getting backed up) when the "patterns_from" option
  449. was used with "source_directories" (or the "~/.borgmatic" path existed, which got injected into
  450. "source_directories" implicitly). The fix is for borgmatic to convert "source_directories" into
  451. patterns whenever "patterns_from" is used, working around a Borg bug:
  452. https://github.com/borgbackup/borg/issues/6994
  453. * #590: In "borgmatic create --list" output, display which files get excluded from the backup due
  454. to patterns or excludes.
  455. * #591: Add support for Borg 2's "--match-archives" flag. This replaces "--glob-archives", which
  456. borgmatic now treats as an alias for "--match-archives". But note that the two flags have
  457. slightly different syntax. See the Borg 2 changelog for more information:
  458. https://borgbackup.readthedocs.io/en/2.0.0b3/changes.html#version-2-0-0b3-2022-10-02
  459. * Fix for "borgmatic --archive latest" not finding the latest archive when a verbosity is set.
  460. 1.7.2
  461. * #577: Fix regression in which "borgmatic info --archive ..." showed repository info instead of
  462. archive info with Borg 1.
  463. * #582: Fix hang when database hooks are enabled and "patterns" contains a parent directory of
  464. "~/.borgmatic".
  465. 1.7.1
  466. * #542: Make the "source_directories" option optional. This is useful for "check"-only setups or
  467. using "patterns" exclusively.
  468. * #574: Fix for potential data loss (data not getting backed up) when the "patterns" option was
  469. used with "source_directories" (or the "~/.borgmatic" path existed, which got injected into
  470. "source_directories" implicitly). The fix is for borgmatic to convert "source_directories" into
  471. patterns whenever "patterns" is used, working around a Borg bug:
  472. https://github.com/borgbackup/borg/issues/6994
  473. 1.7.0
  474. * #463: Add "before_actions" and "after_actions" command hooks that run before/after all the
  475. actions for each repository. These new hooks are a good place to run per-repository steps like
  476. mounting/unmounting a remote filesystem.
  477. * #463: Update documentation to cover per-repository configurations:
  478. https://torsion.org/borgmatic/docs/how-to/make-per-application-backups/
  479. * #557: Support for Borg 2 while still working with Borg 1. This includes new borgmatic actions
  480. like "rcreate" (replaces "init"), "rlist" (list archives in repository), "rinfo" (show repository
  481. info), and "transfer" (for upgrading Borg repositories). For the most part, borgmatic tries to
  482. smooth over differences between Borg 1 and 2 to make your upgrade process easier. However, there
  483. are still a few cases where Borg made breaking changes. See the Borg 2.0 changelog for more
  484. information: https://www.borgbackup.org/releases/borg-2.0.html
  485. * #557: If you install Borg 2, you'll need to manually upgrade your existing Borg 1 repositories
  486. before use. Note that Borg 2 stable is not yet released as of this borgmatic release, so don't
  487. use Borg 2 for production until it is! See the documentation for more information:
  488. https://torsion.org/borgmatic/docs/how-to/upgrade/#upgrading-borg
  489. * #557: Rename several configuration options to match Borg 2: "remote_rate_limit" is now
  490. "upload_rate_limit", "numeric_owner" is "numeric_ids", and "bsd_flags" is "flags". borgmatic
  491. still works with the old options.
  492. * #557: Remote repository paths without the "ssh://" syntax are deprecated but still supported for
  493. now. Remote repository paths containing "~" are deprecated in borgmatic and no longer work in
  494. Borg 2.
  495. * #557: Omitting the "--archive" flag on the "list" action is deprecated when using Borg 2. Use
  496. the new "rlist" action instead.
  497. * #557: The "--dry-run" flag can now be used with the "rcreate"/"init" action.
  498. * #565: Fix handling of "repository" and "data" consistency checks to prevent invalid Borg flags.
  499. * #566: Modify "mount" and "extract" actions to require the "--repository" flag when multiple
  500. repositories are configured.
  501. * #571: BREAKING: Remove old-style command-line action flags like "--create, "--list", etc. If
  502. you're already using actions like "create" and "list" instead, this change should not affect you.
  503. * #571: BREAKING: Rename "--files" flag on "prune" action to "--list", as it lists archives, not
  504. files.
  505. * #571: Add "--list" as alias for "--files" flag on "create" and "export-tar" actions.
  506. * Add support for disabling TLS verification in Healthchecks monitoring hook with "verify_tls"
  507. option.
  508. 1.6.6
  509. * #559: Update documentation about configuring multiple consistency checks or multiple databases.
  510. * #560: Fix all database hooks to error when the requested database to restore isn't present in the
  511. Borg archive.
  512. * #561: Fix command-line "--override" flag to continue supporting old configuration file formats.
  513. * #563: Fix traceback with "create" action and "--json" flag when a database hook is configured.
  514. 1.6.5
  515. * #553: Fix logging to include the full traceback when Borg experiences an internal error, not just
  516. the first few lines.
  517. * #554: Fix all monitoring hooks to warn if the server returns an HTTP 4xx error. This can happen
  518. with Healthchecks, for instance, when using an invalid ping URL.
  519. * #555: Fix environment variable plumbing so options like "encryption_passphrase" and
  520. "encryption_passcommand" in one configuration file aren't used for other configuration files.
  521. 1.6.4
  522. * #546, #382: Keep your repository passphrases and database passwords outside of borgmatic's
  523. configuration file with environment variable interpolation. See the documentation for more
  524. information: https://torsion.org/borgmatic/docs/how-to/provide-your-passwords/
  525. 1.6.3
  526. * #541: Add "borgmatic list --find" flag for searching for files across multiple archives, useful
  527. for hunting down that file you accidentally deleted so you can extract it. See the documentation
  528. for more information:
  529. https://torsion.org/borgmatic/docs/how-to/inspect-your-backups/#searching-for-a-file
  530. * #543: Add a monitoring hook for sending push notifications via ntfy. See the documentation for
  531. more information: https://torsion.org/borgmatic/docs/how-to/monitor-your-backups/#ntfy-hook
  532. * Fix Bash completion script to no longer alter your shell's settings (complain about unset
  533. variables or error on pipe failures).
  534. * Deprecate "borgmatic list --successful" flag, as listing only non-checkpoint (successful)
  535. archives is now the default in newer versions of Borg.
  536. 1.6.2
  537. * #523: Reduce the default consistency check frequency and support configuring the frequency
  538. independently for each check. Also add "borgmatic check --force" flag to ignore configured
  539. frequencies. See the documentation for more information:
  540. https://torsion.org/borgmatic/docs/how-to/deal-with-very-large-backups/#check-frequency
  541. * #536: Fix generate-borgmatic-config to support more complex schema changes like the new
  542. Healthchecks configuration options when the "--source" flag is used.
  543. * #538: Add support for "borgmatic borg debug" command.
  544. * #539: Add "generate-borgmatic-config --overwrite" flag to replace an existing destination file.
  545. * Add Bash completion script so you can tab-complete the borgmatic command-line. See the
  546. documentation for more information:
  547. https://torsion.org/borgmatic/docs/how-to/set-up-backups/#shell-completion
  548. 1.6.1
  549. * #294: Add Healthchecks monitoring hook "ping_body_limit" option to configure how many bytes of
  550. logs to send to the Healthchecks server.
  551. * #402: Remove the error when "archive_name_format" is specified but a retention prefix isn't.
  552. * #420: Warn when an unsupported variable is used in a hook command.
  553. * #439: Change connection failures for monitoring hooks (Healthchecks, Cronitor, PagerDuty, and
  554. Cronhub) to be warnings instead of errors. This way, the monitoring system failing does not block
  555. backups.
  556. * #460: Add Healthchecks monitoring hook "send_logs" option to enable/disable sending borgmatic
  557. logs to the Healthchecks server.
  558. * #525: Add Healthchecks monitoring hook "states" option to only enable pinging for particular
  559. monitoring states (start, finish, fail).
  560. * #528: Improve the error message when a configuration override contains an invalid value.
  561. * #531: BREAKING: When deep merging common configuration, merge colliding list values by appending
  562. them. Previously, one list replaced the other.
  563. * #532: When a configuration include is a relative path, load it from either the current working
  564. directory or from the directory containing the file doing the including. Previously, only the
  565. working directory was used.
  566. * Add a randomized delay to the sample systemd timer to spread out the load on a server.
  567. * Change the configuration format for borgmatic monitoring hooks (Healthchecks, Cronitor,
  568. PagerDuty, and Cronhub) to specify the ping URL / integration key as a named option. The intent
  569. is to support additional options (some in this release). This change is backwards-compatible.
  570. * Add emojis to documentation table of contents to make it easier to find particular how-to and
  571. reference guides at a glance.
  572. 1.6.0
  573. * #381: BREAKING: Greatly simplify configuration file reuse by deep merging when including common
  574. configuration. See the documentation for more information:
  575. https://torsion.org/borgmatic/docs/how-to/make-per-application-backups/#include-merging
  576. * #473: BREAKING: Instead of executing "before" command hooks before all borgmatic actions run (and
  577. "after" hooks after), execute these hooks right before/after the corresponding action. E.g.,
  578. "before_check" now runs immediately before the "check" action. This better supports running
  579. timing-sensitive tasks like pausing containers. Side effect: before/after command hooks now run
  580. once for each configured repository instead of once per configuration file. Additionally, the
  581. "repositories" interpolated variable has been changed to "repository", containing the path to the
  582. current repository for the hook. See the documentation for more information:
  583. https://torsion.org/borgmatic/docs/how-to/add-preparation-and-cleanup-steps-to-backups/
  584. * #513: Add mention of sudo's "secure_path" option to borgmatic installation documentation.
  585. * #515: Fix "borgmatic borg key ..." to pass parameters to Borg in the correct order.
  586. * #516: Fix handling of TERM signal to exit borgmatic, not just forward the signal to Borg.
  587. * #517: Fix borgmatic exit code (so it's zero) when initial Borg calls fail but later retries
  588. succeed.
  589. * Change Healthchecks logs truncation size from 10k bytes to 100k bytes, corresponding to that
  590. same change on Healthchecks.io.
  591. 1.5.24
  592. * #431: Add "working_directory" option to support source directories with relative paths.
  593. * #444: When loading a configuration file that is unreadable due to file permissions, warn instead
  594. of erroring. This supports running borgmatic as a non-root user with configuration in ~/.config
  595. even if there is an unreadable global configuration file in /etc.
  596. * #469: Add "repositories" context to "before_*" and "after_*" command action hooks. See the
  597. documentation for more information:
  598. https://torsion.org/borgmatic/docs/how-to/add-preparation-and-cleanup-steps-to-backups/
  599. * #486: Fix handling of "patterns_from" and "exclude_from" options to error instead of warning when
  600. referencing unreadable files and "create" action is run.
  601. * #507: Fix Borg usage error in the "compact" action when running "borgmatic --dry-run". Now, skip
  602. "compact" entirely during a dry run.
  603. 1.5.23
  604. * #394: Compact repository segments and free space with new "borgmatic compact" action. Borg 1.2+
  605. only. Also run "compact" by default when no actions are specified, as "prune" in Borg 1.2 no
  606. longer frees up space unless "compact" is run.
  607. * #394: When using the "atime", "bsd_flags", "numeric_owner", or "remote_rate_limit" options,
  608. tailor the flags passed to Borg depending on the Borg version.
  609. * #480, #482: Fix traceback when a YAML validation error occurs.
  610. 1.5.22
  611. * #288: Add database dump hook for MongoDB.
  612. * #470: Move mysqldump options to the beginning of the command due to MySQL bug 30994.
  613. * #471: When command-line configuration override produces a parse error, error cleanly instead of
  614. tracebacking.
  615. * #476: Fix unicode error when restoring particular MySQL databases.
  616. * Drop support for Python 3.6, which has been end-of-lifed.
  617. * Add support for Python 3.10.
  618. 1.5.21
  619. * #28: Optionally retry failing backups via "retries" and "retry_wait" configuration options.
  620. * #306: Add "list_options" MySQL configuration option for passing additional arguments to MySQL
  621. list command.
  622. * #459: Add support for old version (2.x) of jsonschema library.
  623. 1.5.20
  624. * Re-release with correct version without dev0 tag.
  625. 1.5.19
  626. * #387: Fix error when configured source directories are not present on the filesystem at the time
  627. of backup. Now, Borg will complain, but the backup will still continue.
  628. * #455: Mention changing borgmatic path in cron documentation.
  629. * Update sample systemd service file with more granular read-only filesystem settings.
  630. * Move Gitea and GitHub hosting from a personal namespace to an organization for better
  631. collaboration with related projects.
  632. * 1k ★s on GitHub!
  633. 1.5.18
  634. * #389: Fix "message too long" error when logging to rsyslog.
  635. * #440: Fix traceback that can occur when dumping a database.
  636. 1.5.17
  637. * #437: Fix error when configuration file contains "umask" option.
  638. * Remove test dependency on vim and /dev/urandom.
  639. 1.5.16
  640. * #379: Suppress console output in sample crontab and systemd service files.
  641. * #407: Fix syslog logging on FreeBSD.
  642. * #430: Fix hang when restoring a PostgreSQL "tar" format database dump.
  643. * Better error messages! Switch the library used for validating configuration files (from pykwalify
  644. to jsonschema).
  645. * Link borgmatic Ansible role from installation documentation:
  646. https://torsion.org/borgmatic/docs/how-to/set-up-backups/#other-ways-to-install
  647. 1.5.15
  648. * #419: Document use case of running backups conditionally based on laptop power level:
  649. https://torsion.org/borgmatic/docs/how-to/backup-to-a-removable-drive-or-an-intermittent-server/
  650. * #425: Run arbitrary Borg commands with new "borgmatic borg" action. See the documentation for
  651. more information: https://torsion.org/borgmatic/docs/how-to/run-arbitrary-borg-commands/
  652. 1.5.14
  653. * #390: Add link to Hetzner storage offering from the documentation.
  654. * #398: Clarify canonical home of borgmatic in documentation.
  655. * #406: Clarify that spaces in path names should not be backslashed in path names.
  656. * #423: Fix error handling to error loudly when Borg gets killed due to running out of memory!
  657. * Fix build so as not to attempt to build and push documentation for a non-main branch.
  658. * "Fix" build failure with Alpine Edge by switching from Edge to Alpine 3.13.
  659. * Move #borgmatic IRC channel from Freenode to Libera Chat due to Freenode takeover drama.
  660. IRC connection info: https://torsion.org/borgmatic/#issues
  661. 1.5.13
  662. * #373: Document that passphrase is used for Borg keyfile encryption, not just repokey encryption.
  663. * #404: Add support for ruamel.yaml 0.17.x YAML parsing library.
  664. * Update systemd service example to return a permission error when a system call isn't permitted
  665. (instead of terminating borgmatic outright).
  666. * Drop support for Python 3.5, which has been end-of-lifed.
  667. * Add support for Python 3.9.
  668. * Update versions of test dependencies (test_requirements.txt and test containers).
  669. * Only support black code formatter on Python 3.8+. New black dependencies make installation
  670. difficult on older versions of Python.
  671. * Replace "improve this documentation" form with link to support and ticket tracker.
  672. 1.5.12
  673. * Fix for previous release with incorrect version suffix in setup.py. No other changes.
  674. 1.5.11
  675. * #341: Add "temporary_directory" option for changing Borg's temporary directory.
  676. * #352: Lock down systemd security settings in sample systemd service file.
  677. * #355: Fix traceback when a database hook value is null in a configuration file.
  678. * #361: Merge override values when specifying the "--override" flag multiple times. The previous
  679. behavior was to take the value of the last "--override" flag only.
  680. * #367: Fix traceback when upgrading old INI-style configuration with upgrade-borgmatic-config.
  681. * #368: Fix signal forwarding from borgmatic to Borg resulting in recursion traceback.
  682. * #369: Document support for Borg placeholders in repository names.
  683. 1.5.10
  684. * #347: Add hooks that run for the "extract" action: "before_extract" and "after_extract".
  685. * #350: Fix traceback when a configuration directory is non-readable due to directory permissions.
  686. * Add documentation navigation links on left side of all documentation pages.
  687. * Clarify documentation on configuration overrides, specifically the portion about list syntax:
  688. http://torsion.org/borgmatic/docs/how-to/make-per-application-backups/#configuration-overrides
  689. * Clarify documentation overview of monitoring options:
  690. http://torsion.org/borgmatic/docs/how-to/monitor-your-backups/
  691. 1.5.9
  692. * #300: Add "borgmatic export-tar" action to export an archive to a tar-formatted file or stream.
  693. * #339: Fix for intermittent timing-related test failure of logging function.
  694. * Clarify database documentation about excluding named pipes and character/block devices to prevent
  695. hangs.
  696. * Add documentation on how to make backups redundant with multiple repositories:
  697. https://torsion.org/borgmatic/docs/how-to/make-backups-redundant/
  698. 1.5.8
  699. * #336: Fix for traceback when running Cronitor, Cronhub, and PagerDuty monitor hooks.
  700. 1.5.7
  701. * #327: Fix broken pass-through of BORG_* environment variables to Borg.
  702. * #328: Fix duplicate logging to Healthchecks and send "after_*" hooks output to Healthchecks.
  703. * #331: Add SSL support to PostgreSQL database configuration.
  704. * #333: Fix for potential data loss (data not getting backed up) when borgmatic omitted configured
  705. source directories in certain situations. Specifically, this occurred when two source directories
  706. on different filesystems were related by parentage (e.g. "/foo" and "/foo/bar/baz") and the
  707. one_file_system option was enabled.
  708. * Update documentation code fragments theme to better match the rest of the page.
  709. * Improve configuration reference documentation readability via more aggressive word-wrapping in
  710. configuration schema descriptions.
  711. 1.5.6
  712. * #292: Allow before_backup and similar hooks to exit with a soft failure without altering the
  713. monitoring status on Healthchecks or other providers. Support this by waiting to ping monitoring
  714. services with a "start" status until after before_* hooks finish. Failures in before_* hooks
  715. still trigger a monitoring "fail" status.
  716. * #316: Fix hang when a stale database dump named pipe from an aborted borgmatic run remains on
  717. disk.
  718. * #323: Fix for certain configuration options like ssh_command impacting Borg invocations for
  719. separate configuration files.
  720. * #324: Add "borgmatic extract --strip-components" flag to remove leading path components when
  721. extracting an archive.
  722. * Tweak comment indentation in generated configuration file for clarity.
  723. * Link to Borgmacator GNOME AppIndicator from monitoring documentation.
  724. 1.5.5
  725. * #314: Fix regression in support for PostgreSQL's "directory" dump format. Unlike other dump
  726. formats, the "directory" dump format does not stream directly to/from Borg.
  727. * #315: Fix enabled database hooks to implicitly set one_file_system configuration option to true.
  728. This prevents Borg from reading devices like /dev/zero and hanging.
  729. * #316: Fix hang when streaming a database dump to Borg with implicit duplicate source directories
  730. by deduplicating them first.
  731. * #319: Fix error message when there are no MySQL databases to dump for "all" databases.
  732. * Improve documentation around the installation process. Specifically, making borgmatic commands
  733. runnable via the system PATH and offering a global install option.
  734. 1.5.4
  735. * #310: Fix legitimate database dump command errors (exit code 1) not being treated as errors by
  736. borgmatic.
  737. * For database dumps, replace the named pipe on every borgmatic run. This prevent hangs on stale
  738. pipes left over from previous runs.
  739. * Fix error handling to handle more edge cases when executing commands.
  740. 1.5.3
  741. * #258: Stream database dumps and restores directly to/from Borg without using any additional
  742. filesystem space. This feature is automatic, and works even on restores from archives made with
  743. previous versions of borgmatic.
  744. * #293: Documentation on macOS launchd permissions issues with work-around for Full Disk Access.
  745. * Remove "borgmatic restore --progress" flag, as it now conflicts with streaming database restores.
  746. 1.5.2
  747. * #301: Fix MySQL restore error on "all" database dump by excluding system tables.
  748. * Fix PostgreSQL restore error on "all" database dump by using "psql" for the restore instead of
  749. "pg_restore".
  750. 1.5.1
  751. * #289: Tired of looking up the latest successful archive name in order to pass it to borgmatic
  752. actions? Me too. Now you can specify "--archive latest" to all actions that accept an archive
  753. flag.
  754. * #290: Fix the "--stats" and "--files" flags so that they yield output at verbosity 0.
  755. * Reduce the default verbosity of borgmatic logs sent to Healthchecks monitoring hook. Now, it's
  756. warnings and errors only. You can increase the verbosity via the "--monitoring-verbosity" flag.
  757. * Add security policy documentation in SECURITY.md.
  758. 1.5.0
  759. * #245: Monitor backups with PagerDuty hook integration. See the documentation for more
  760. information: https://torsion.org/borgmatic/docs/how-to/monitor-your-backups/#pagerduty-hook
  761. * #255: Add per-action hooks: "before_prune", "after_prune", "before_check", and "after_check".
  762. * #274: Add ~/.config/borgmatic.d as another configuration directory default.
  763. * #277: Customize Healthchecks log level via borgmatic "--monitoring-verbosity" flag.
  764. * #280: Change "exclude_if_present" option to support multiple filenames that indicate a directory
  765. should be excluded from backups, rather than just a single filename.
  766. * #284: Backup to a removable drive or intermittent server via "soft failure" feature. See the
  767. documentation for more information:
  768. https://torsion.org/borgmatic/docs/how-to/backup-to-a-removable-drive-or-an-intermittent-server/
  769. * #287: View consistency check progress via "--progress" flag for "check" action.
  770. * For "create" and "prune" actions, no longer list files or show detailed stats at any verbosities
  771. by default. You can opt back in with "--files" or "--stats" flags.
  772. * For "list" and "info" actions, show repository names even at verbosity 0.
  773. 1.4.22
  774. * #276, #285: Disable colored output when "--json" flag is used, so as to produce valid JSON output.
  775. * After a backup of a database dump in directory format, properly remove the dump directory.
  776. * In "borgmatic --help", don't expand $HOME in listing of default "--config" paths.
  777. 1.4.21
  778. * #268: Override particular configuration options from the command-line via "--override" flag. See
  779. the documentation for more information:
  780. https://torsion.org/borgmatic/docs/how-to/make-per-application-backups/#configuration-overrides
  781. * #270: Only trigger "on_error" hooks and monitoring failures for "prune", "create", and "check"
  782. actions, and not for other actions.
  783. * When pruning with verbosity level 1, list pruned and kept archives. Previously, this information
  784. was only shown at verbosity level 2.
  785. 1.4.20
  786. * Fix repository probing during "borgmatic init" to respect verbosity flag and remote_path option.
  787. * #249: Update Healthchecks/Cronitor/Cronhub monitoring integrations to fire for "check" and
  788. "prune" actions, not just "create".
  789. 1.4.19
  790. * #259: Optionally change the internal database dump path via "borgmatic_source_directory" option
  791. in location configuration section.
  792. * #271: Support piping "borgmatic list" output to grep by logging certain log levels to console
  793. stdout and others to stderr.
  794. * Retain colored output when piping or redirecting in an interactive terminal.
  795. * Add end-to-end tests for database dump and restore. These are run on developer machines with
  796. Docker Compose for approximate parity with continuous integration tests.
  797. 1.4.18
  798. * Fix "--repository" flag to accept relative paths.
  799. * Fix "borgmatic umount" so it only runs Borg once instead of once per repository / configuration
  800. file.
  801. * #253: Mount whole repositories via "borgmatic mount" without any "--archive" flag.
  802. * #269: Filter listed paths via "borgmatic list --path" flag.
  803. 1.4.17
  804. * #235: Pass extra options directly to particular Borg commands, handy for Borg options that
  805. borgmatic does not yet support natively. Use "extra_borg_options" in the storage configuration
  806. section.
  807. * #266: Attempt to repair any inconsistencies found during a consistency check via
  808. "borgmatic check --repair" flag.
  809. 1.4.16
  810. * #256: Fix for "before_backup" hook not triggering an error when the command contains "borg" and
  811. has an exit code of 1.
  812. * #257: Fix for garbled Borg file listing when using "borgmatic create --progress" with
  813. verbosity level 1 or 2.
  814. * #260: Fix for missing Healthchecks monitoring payload or HTTP 500 due to incorrect unicode
  815. encoding.
  816. 1.4.15
  817. * Fix for database dump removal incorrectly skipping some database dumps.
  818. * #123: Support for mounting an archive as a FUSE filesystem via "borgmatic mount" action, and
  819. unmounting via "borgmatic umount". See the documentation for more information:
  820. https://torsion.org/borgmatic/docs/how-to/extract-a-backup/#mount-a-filesystem
  821. 1.4.14
  822. * Show summary log errors regardless of verbosity level, and log the "summary:" header with a log
  823. level based on the contained summary logs.
  824. 1.4.13
  825. * Show full error logs at "--verbosity 0" so you can see command output without upping the
  826. verbosity level.
  827. 1.4.12
  828. * #247: With "borgmatic check", consider Borg warnings as errors.
  829. * Dial back the display of inline error logs a bit, so failed command output doesn't appear
  830. multiple times in the logs (well, except for the summary).
  831. 1.4.11
  832. * #241: When using the Healthchecks monitoring hook, include borgmatic logs in the payloads for
  833. completion and failure pings.
  834. * With --verbosity level 1 or 2, show error logs both inline when they occur and in the summary
  835. logs at the bottom. With lower verbosity levels, suppress the summary and show error logs when
  836. they occur.
  837. 1.4.10
  838. * #246: Fix for "borgmatic restore" showing success and incorrectly extracting archive files, even
  839. when no databases are configured to restore. As this can overwrite files from the archive and
  840. lead to data loss, please upgrade to get the fix before using "borgmatic restore".
  841. * Reopen the file given by "--log-file" flag if an external program rotates the log file while
  842. borgmatic is running.
  843. 1.4.9
  844. * #228: Database dump hooks for MySQL/MariaDB, so you can easily dump your databases before backups
  845. run.
  846. * #243: Fix repository does not exist error with "borgmatic extract" when repository is remote.
  847. 1.4.8
  848. * Monitor backups with Cronhub hook integration. See the documentation for more information:
  849. https://torsion.org/borgmatic/docs/how-to/monitor-your-backups/#cronhub-hook
  850. * Fix Healthchecks/Cronitor hooks to skip actions when the borgmatic "--dry-run" flag is used.
  851. 1.4.7
  852. * #238: In documentation, clarify when Healthchecks/Cronitor hooks fire in relation to other hooks.
  853. * #239: Upgrade your borgmatic configuration to get new options and comments via
  854. "generate-borgmatic-config --source". See the documentation for more information:
  855. https://torsion.org/borgmatic/docs/how-to/upgrade/#upgrading-your-configuration
  856. 1.4.6
  857. * Verbosity level "-1" for even quieter output: Errors only (#236).
  858. 1.4.5
  859. * Log to file instead of syslog via command-line "--log-file" flag (#233).
  860. 1.4.4
  861. * #234: Support for Borg --keep-exclude-tags and --exclude-nodump options.
  862. 1.4.3
  863. * Monitor backups with Cronitor hook integration. See the documentation for more information:
  864. https://torsion.org/borgmatic/docs/how-to/monitor-your-backups/#cronitor-hook
  865. 1.4.2
  866. * Extract files to a particular directory via "borgmatic extract --destination" flag.
  867. * Rename "borgmatic extract --restore-path" flag to "--path" to reduce confusion with the separate
  868. "borgmatic restore" action. Any uses of "--restore-path" will continue working.
  869. 1.4.1
  870. * #229: Restore backed up PostgreSQL databases via "borgmatic restore" action. See the
  871. documentation for more information:
  872. https://torsion.org/borgmatic/docs/how-to/backup-your-databases/
  873. * Documentation on how to develop borgmatic's documentation:
  874. https://torsion.org/borgmatic/docs/how-to/develop-on-borgmatic/#documentation-development
  875. 1.4.0
  876. * #225: Database dump hooks for PostgreSQL, so you can easily dump your databases before backups
  877. run.
  878. * #230: Rename "borgmatic list --pattern-from" flag to "--patterns-from" to match Borg.
  879. 1.3.26
  880. * #224: Fix "borgmatic list --successful" with a slightly better heuristic for listing successful
  881. (non-checkpoint) archives.
  882. 1.3.25
  883. * #223: Dead man's switch to detect when backups start failing silently, implemented via
  884. healthchecks.io hook integration. See the documentation for more information:
  885. https://torsion.org/borgmatic/docs/how-to/monitor-your-backups/#healthchecks-hook
  886. * Documentation on monitoring and alerting options for borgmatic backups:
  887. https://torsion.org/borgmatic/docs/how-to/monitor-your-backups/
  888. * Automatically rewrite links when developing on documentation locally.
  889. 1.3.24
  890. * #86: Add "borgmatic list --successful" flag to only list successful (non-checkpoint) archives.
  891. * Add a suggestion form to all documentation pages, so users can submit ideas for improving the
  892. documentation.
  893. * Update documentation link to community Arch Linux borgmatic package.
  894. 1.3.23
  895. * #174: More detailed error alerting via runtime context available in "on_error" hook.
  896. 1.3.22
  897. * #144: When backups to one of several repositories fails, keep backing up to the other
  898. repositories and report errors afterwards.
  899. 1.3.21
  900. * #192: User-defined hooks for global setup or cleanup that run before/after all actions. See the
  901. documentation for more information:
  902. https://torsion.org/borgmatic/docs/how-to/add-preparation-and-cleanup-steps-to-backups/
  903. 1.3.20
  904. * #205: More robust sample systemd service: boot delay, network dependency, lowered CPU/IO
  905. priority, etc.
  906. * #221: Fix "borgmatic create --progress" output so that it updates on the console in real-time.
  907. 1.3.19
  908. * #219: Fix visibility of "borgmatic prune --stats" output.
  909. 1.3.18
  910. * #220: Fix regression of argument parsing for default actions.
  911. 1.3.17
  912. * #217: Fix error with "borgmatic check --only" command-line flag with "extract" consistency check.
  913. 1.3.16
  914. * #210: Support for Borg check --verify-data flag via borgmatic "data" consistency check.
  915. * #210: Override configured consistency checks via "borgmatic check --only" command-line flag.
  916. * When generating sample configuration with generate-borgmatic-config, add a space after each "#"
  917. comment indicator.
  918. 1.3.15
  919. * #208: Fix for traceback when the "checks" option has an empty value.
  920. * #209: Bypass Borg error about a moved repository via "relocated_repo_access_is_ok" option in
  921. borgmatic storage configuration section.
  922. * #213: Reorder arguments passed to Borg to fix duplicate directories when using Borg patterns.
  923. * #214: Fix for hook erroring with exit code 1 not being interpreted as an error.
  924. 1.3.14
  925. * #204: Do not treat Borg warnings (exit code 1) as failures.
  926. * When validating configuration files, require strings instead of allowing any scalar type.
  927. 1.3.13
  928. * #199: Add note to documentation about using spaces instead of tabs for indentation, as YAML does
  929. not allow tabs.
  930. * #203: Fix compatibility with ruamel.yaml 0.16.x.
  931. * If a "prefix" option in borgmatic's configuration has an empty value (blank or ""), then disable
  932. default prefix.
  933. 1.3.12
  934. * Only log to syslog when run from a non-interactive console (e.g. a cron job).
  935. * Remove unicode byte order mark from syslog output so it doesn't show up as a literal in rsyslog
  936. output. See discussion on #197.
  937. 1.3.11
  938. * #193: Pass through several "borg list" and "borg info" flags like --short, --format, --sort-by,
  939. --first, --last, etc. via borgmatic command-line flags.
  940. * Add borgmatic info --repository and --archive command-line flags to display info for individual
  941. repositories or archives.
  942. * Support for Borg --noatime, --noctime, and --nobirthtime flags via corresponding options in
  943. borgmatic configuration location section.
  944. 1.3.10
  945. * #198: Fix for Borg create error output not showing up at borgmatic verbosity level zero.
  946. 1.3.9
  947. * #195: Switch to command-line actions as more traditional sub-commands, e.g. "borgmatic create",
  948. "borgmatic prune", etc. However, the classic dashed options like "--create" still work!
  949. 1.3.8
  950. * #191: Disable console color via "color" option in borgmatic configuration output section.
  951. 1.3.7
  952. * #196: Fix for unclear error message for invalid YAML merge include.
  953. * #197: Don't color syslog output.
  954. * Change default syslog verbosity to show errors only.
  955. 1.3.6
  956. * #53: Log to syslog in addition to existing console logging. Add --syslog-verbosity flag to
  957. customize the log level. See the documentation for more information:
  958. https://torsion.org/borgmatic/docs/how-to/inspect-your-backups/
  959. * #178: Look for .yml configuration file extension in addition to .yaml.
  960. * #189: Set umask used when executing hooks via "umask" option in borgmatic hooks section.
  961. * Remove Python cache files before each Tox run.
  962. * Add #borgmatic Freenode IRC channel to documentation.
  963. * Add Borg/borgmatic hosting providers section to documentation.
  964. * Add files for building documentation into a Docker image for web serving.
  965. * Upgrade project build server from Drone 0.8 to 1.1.
  966. * Build borgmatic documentation during continuous integration.
  967. * We're nearly at 500 ★s on GitHub. We can do this!
  968. 1.3.5
  969. * #153: Support for various Borg directory environment variables (BORG_CONFIG_DIR, BORG_CACHE_DIR,
  970. etc.) via options in borgmatic's storage configuration.
  971. * #177: Fix for regression with missing verbose log entries.
  972. 1.3.4
  973. * Part of #125: Color borgmatic (but not Borg) output when using an interactive terminal.
  974. * #166: Run tests for all installed versions of Python.
  975. * #168: Update README with continuous integration badge.
  976. * #169: Automatically sort Python imports in code.
  977. * Document installing borgmatic with pip install --user instead of a system Python install.
  978. * Get more reproducible builds by pinning the versions of pip and tox used to run tests.
  979. * Factor out build/test configuration from tox.ini file.
  980. 1.3.3
  981. * Add validate-borgmatic-config command, useful for validating borgmatic config generated by
  982. configuration management or even edited by hand.
  983. 1.3.2
  984. * #160: Fix for hooks executing when using --dry-run. Now hooks are skipped during a dry run.
  985. 1.3.1
  986. * #155: Fix for invalid JSON output when using multiple borgmatic configuration files.
  987. * #157: Fix for seemingly random filename ordering when running through a directory of
  988. configuration files.
  989. * Fix for empty JSON output when using --create --json.
  990. * Now capturing Borg output only when --json flag is used. Previously, borgmatic delayed Borg
  991. output even without the --json flag.
  992. 1.3.0
  993. * #148: Configuration file includes and merging via "!include" tag to support reuse of common
  994. options across configuration files.
  995. 1.2.18
  996. * #147: Support for Borg create/extract --numeric-owner flag via "numeric_owner" option in
  997. borgmatic's location section.
  998. 1.2.17
  999. * #140: List the files within an archive via --list --archive option.
  1000. 1.2.16
  1001. * #119: Include a sample borgmatic configuration file in the documentation.
  1002. * #123: Support for Borg archive restoration via borgmatic --extract command-line flag.
  1003. * Refactor documentation into multiple separate pages for clarity and findability.
  1004. * Organize options within command-line help into logical groups.
  1005. * Exclude tests from distribution packages.
  1006. 1.2.15
  1007. * #127: Remove date echo from schema example, as it's not a substitute for real logging.
  1008. * #132: Leave exclude_patterns glob expansion to Borg, since doing it in borgmatic leads to
  1009. confusing behavior.
  1010. * #136: Handle and format validation errors raised during argument parsing.
  1011. * #138: Allow use of --stats flag when --create or --prune flags are implied.
  1012. 1.2.14
  1013. * #103: When generating sample configuration with generate-borgmatic-config, document the defaults
  1014. for each option.
  1015. * #116: When running multiple configuration files, attempt all configuration files even if one of
  1016. them errors. Log a summary of results at the end.
  1017. * Add borgmatic --version command-line flag to get the current installed version number.
  1018. 1.2.13
  1019. * #100: Support for --stats command-line flag independent of --verbosity.
  1020. * #117: With borgmatic --init command-line flag, proceed without erroring if a repository already
  1021. exists.
  1022. 1.2.12
  1023. * #110: Support for Borg repository initialization via borgmatic --init command-line flag.
  1024. * #111: Update Borg create --filter values so a dry run lists files to back up.
  1025. * #113: Update README with link to a new/forked Docker image.
  1026. * Prevent deprecated --excludes command-line option from being used.
  1027. * Refactor README a bit to flow better for first-time users.
  1028. * Update README with a few additional borgmatic packages (Debian and Ubuntu).
  1029. 1.2.11
  1030. * #108: Support for Borg create --progress via borgmatic command-line flag.
  1031. 1.2.10
  1032. * #105: Support for Borg --chunker-params create option via "chunker_params" option in borgmatic's
  1033. storage section.
  1034. 1.2.9
  1035. * #102: Fix for syntax error that occurred in Python 3.5 and below.
  1036. * Make automated tests support running in Python 3.5.
  1037. 1.2.8
  1038. * #73: Enable consistency checks for only certain repositories via "check_repositories" option in
  1039. borgmatic's consistency configuration. Handy for large repositories that take forever to check.
  1040. * Include link to issue tracker within various command output.
  1041. * Run continuous integration tests on a matrix of Python and Borg versions.
  1042. 1.2.7
  1043. * #98: Support for Borg --keep-secondly prune option.
  1044. * Use Black code formatter and Flake8 code checker as part of running automated tests.
  1045. * Add an end-to-end automated test that actually integrates with Borg.
  1046. * Set up continuous integration for borgmatic automated tests on projects.evoworx.org.
  1047. 1.2.6
  1048. * Fix generated configuration to also include a "keep_daily" value so pruning works out of the
  1049. box.
  1050. 1.2.5
  1051. * #57: When generating sample configuration with generate-borgmatic-config, comment out all
  1052. optional configuration so as to streamline the initial configuration process.
  1053. 1.2.4
  1054. * Fix for archive checking traceback due to parameter mismatch.
  1055. 1.2.3
  1056. * #64, #90, #92: Rewrite of logging system. Now verbosity flags passed to Borg are derived from
  1057. borgmatic's log level. Note that the output of borgmatic might slightly change.
  1058. * Part of #80: Support for Borg create --read-special via "read_special" option in borgmatic's
  1059. location configuration.
  1060. * #87: Support for Borg create --checkpoint-interval via "checkpoint_interval" option in
  1061. borgmatic's storage configuration.
  1062. * #88: Fix declared pykwalify compatibility version range in setup.py to prevent use of ancient
  1063. versions of pykwalify with large version numbers.
  1064. * #89: Pass --show-rc option to Borg when at highest verbosity level.
  1065. * #94: Support for Borg --json option via borgmatic command-line to --create archives.
  1066. 1.2.2
  1067. * #85: Fix compatibility issue between pykwalify and ruamel.yaml 0.15.52, which manifested in
  1068. borgmatic as a pykwalify RuleError.
  1069. 1.2.1
  1070. * Skip before/after backup hooks when only doing --prune, --check, --list, and/or --info.
  1071. * #71: Support for XDG_CONFIG_HOME environment variable for specifying alternate user ~/.config/
  1072. path.
  1073. * #74, #83: Support for Borg --json option via borgmatic command-line to --list archives or show
  1074. archive --info in JSON format, ideal for programmatic consumption.
  1075. * #38, #76: Upgrade ruamel.yaml compatibility version range and fix support for Python 3.7.
  1076. * #77: Skip non-"*.yaml" config filenames in /etc/borgmatic.d/ so as not to parse backup files,
  1077. editor swap files, etc.
  1078. * #81: Document user-defined hooks run before/after backup, or on error.
  1079. * Add code style guidelines to the documentation.
  1080. 1.2.0
  1081. * #61: Support for Borg --list option via borgmatic command-line to list all archives.
  1082. * #61: Support for Borg --info option via borgmatic command-line to display summary information.
  1083. * #62: Update README to mention other ways of installing borgmatic.
  1084. * Support for Borg --prefix option for consistency checks via "prefix" option in borgmatic's
  1085. consistency configuration.
  1086. * Add introductory screencast link to documentation.
  1087. * #59: Ignore "check_last" and consistency "prefix" when "archives" not in consistency checks.
  1088. * #60: Add "Persistent" flag to systemd timer example.
  1089. * #63: Support for Borg --nobsdflags option to skip recording bsdflags (e.g. NODUMP, IMMUTABLE) in
  1090. archive.
  1091. * #69: Support for Borg prune --umask option using value of existing "umask" option in borgmatic's
  1092. storage configuration.
  1093. * Update tox.ini to only assume Python 3.x instead of Python 3.4 specifically.
  1094. * Add ~/.config/borgmatic/config.yaml to default configuration path probing.
  1095. * Document how to develop on and contribute to borgmatic.
  1096. 1.1.15
  1097. * Support for Borg BORG_PASSCOMMAND environment variable to read a password from an external file.
  1098. * Fix for Borg create error when using borgmatic's --dry-run and --verbosity options together.
  1099. Work-around for behavior introduced in Borg 1.1.3: https://github.com/borgbackup/borg/issues/3298
  1100. * #55: Fix for missing tags/releases on Gitea and GitHub project hosting.
  1101. * #56: Support for Borg --lock-wait option for the maximum wait for a repository/cache lock.
  1102. * #58: Support for using tilde in exclude_patterns to reference home directory.
  1103. 1.1.14
  1104. * #49: Fix for typo in --patterns-from option.
  1105. * #47: Support for Borg --dry-run option via borgmatic command-line.
  1106. 1.1.13
  1107. * #54: Fix for incorrect consistency check flags passed to Borg when all three checks ("repository",
  1108. "archives", and "extract") are specified in borgmatic configuration.
  1109. * #48: Add "local_path" to configuration for specifying an alternative Borg executable path.
  1110. * #49: Support for Borg experimental --patterns-from and --patterns options for specifying mixed
  1111. includes/excludes.
  1112. * Moved issue tracker from Taiga to integrated Gitea tracker at
  1113. https://projects.torsion.org/borgmatic-collective/borgmatic/issues
  1114. 1.1.12
  1115. * #46: Declare dependency on pykwalify 1.6 or above, as older versions yield "Unknown key: version"
  1116. rule errors.
  1117. * Support for Borg --keep-minutely prune option.
  1118. 1.1.11
  1119. * #26: Add "ssh_command" to configuration for specifying a custom SSH command or options.
  1120. * Fix for incorrect /etc/borgmatic.d/ configuration path probing on macOS. This problem manifested
  1121. as an error on startup: "[Errno 2] No such file or directory: '/etc/borgmatic.d'".
  1122. 1.1.10
  1123. * Pass several Unix signals through to child processes like Borg. This means that Borg now properly
  1124. shuts down if borgmatic is terminated (e.g. due to a system suspend).
  1125. * #30: Support for using tilde in repository paths to reference home directory.
  1126. * #43: Support for Borg --files-cache option for setting the files cache operation mode.
  1127. * #45: Support for Borg --remote-ratelimit option for limiting upload rate.
  1128. * Log invoked Borg commands when at highest verbosity level.
  1129. 1.1.9
  1130. * #17, #39: Support for user-defined hooks before/after backup, or on error.
  1131. * #34: Improve clarity of logging spew at high verbosity levels.
  1132. * #30: Support for using tilde in source directory path to reference home directory.
  1133. * Require "prefix" in retention section when "archive_name_format" is set. This is to avoid
  1134. accidental pruning of archives with a different archive name format. For similar reasons, default
  1135. "prefix" to "{hostname}-" if not specified.
  1136. * Convert main source repository from Mercurial to Git.
  1137. * Update dead links to Borg documentation.
  1138. 1.1.8
  1139. * #40: Fix to make /etc/borgmatic/config.yaml optional rather than required when using the default
  1140. config paths.
  1141. 1.1.7
  1142. * #29: Add "archive_name_format" to configuration for customizing archive names.
  1143. * Fix for traceback when "exclude_from" value is empty in configuration file.
  1144. * When pruning, make highest verbosity level list archives kept and pruned.
  1145. * Clarification of Python 3 pip usage in documentation.
  1146. 1.1.6
  1147. * #13, #36: Support for Borg --exclude-from, --exclude-caches, and --exclude-if-present options.
  1148. 1.1.5
  1149. * #35: New "extract" consistency check that performs a dry-run extraction of the most recent
  1150. archive.
  1151. 1.1.4
  1152. * #18: Added command-line flags for performing a borgmatic run with only pruning, creating, or
  1153. checking enabled. This supports use cases like running consistency checks from a different cron
  1154. job with a different frequency, or running pruning with a different verbosity level.
  1155. 1.1.3
  1156. * #15: Support for running multiple config files in /etc/borgmatic.d/ from a single borgmatic run.
  1157. * Fix for generate-borgmatic-config writing config with invalid one_file_system value.
  1158. 1.1.2
  1159. * #33: Fix for passing check_last as integer to subprocess when calling Borg.
  1160. 1.1.1
  1161. * Part of #33: Fix for upgrade-borgmatic-config converting check_last option as a string instead of
  1162. an integer.
  1163. * Fix for upgrade-borgmatic-config erroring when consistency checks option is not present.
  1164. 1.1.0
  1165. * Switched config file format to YAML. Run upgrade-borgmatic-config to upgrade.
  1166. * Added generate-borgmatic-config command for initial config creation.
  1167. * Dropped Python 2 support. Now Python 3 only.
  1168. * #19: Fix for README mention of sample files not included in package.
  1169. * #23: Sample files for triggering borgmatic from a systemd timer.
  1170. * Support for backing up to multiple repositories.
  1171. * To free up space, now pruning backups prior to creating a new backup.
  1172. * Enabled test coverage output during tox runs.
  1173. * Added logo.
  1174. 1.0.3
  1175. * #22: Fix for verbosity flag not actually causing verbose output.
  1176. 1.0.2
  1177. * #21: Fix for traceback when remote_path option is missing.
  1178. 1.0.1
  1179. * #20: Support for Borg's --remote-path option to use an alternate Borg
  1180. executable. See sample/config.
  1181. 1.0.0
  1182. * Attic is no longer supported, as there hasn't been any recent development on
  1183. it. Dropping Attic support will allow faster iteration on Borg-specific
  1184. features. If you're still using Attic, this is a good time to switch to Borg!
  1185. * Project renamed from atticmatic to borgmatic. See the borgmatic README for
  1186. information on upgrading.
  1187. 0.1.8
  1188. * Fix for handling of spaces in source_directories which resulted in backup up everything.
  1189. * Fix for broken links to Borg documentation.
  1190. * At verbosity zero, suppressing Borg check stderr spew about "Checking segments".
  1191. * Support for Borg --one-file-system.
  1192. * Support for Borg create --umask.
  1193. * Support for file globs in source_directories.
  1194. 0.1.7
  1195. * #12: Fixed parsing of punctuation in configuration file.
  1196. * Better error message when configuration file is missing.
  1197. 0.1.6
  1198. * #10: New configuration option for the encryption passphrase.
  1199. * #11: Support for Borg's new archive compression feature.
  1200. 0.1.5
  1201. * Changes to support release on PyPI. Now pip installable by name!
  1202. 0.1.4
  1203. * Adding test that setup.py version matches release version.
  1204. 0.1.3
  1205. * #2: Add support for "borg check --last N" to Borg backend.
  1206. 0.1.2
  1207. * As a convenience to new users, allow a missing default excludes file.
  1208. * New issue tracker, linked from documentation.
  1209. 0.1.1
  1210. * Adding borgmatic cron example, and updating documentation to refer to it.
  1211. 0.1.0
  1212. * New "borgmatic" command to support Borg backup software, a fork of Attic.
  1213. 0.0.7
  1214. * Flag for multiple levels of verbosity: some, and lots.
  1215. * Improved mocking of Python builtins in unit tests.
  1216. 0.0.6
  1217. * New configuration section for customizing which Attic consistency checks run, if any.
  1218. 0.0.5
  1219. * Fixed regression with --verbose output being buffered. This means dropping the helpful error
  1220. message introduced in 0.0.4.
  1221. 0.0.4
  1222. * Now using tox to run tests against multiple versions of Python in one go.
  1223. * Helpful error message about how to create a repository if one is missing.
  1224. * Troubleshooting section with steps to deal with broken pipes.
  1225. * Nosetests config file (setup.cfg) with defaults.
  1226. 0.0.3
  1227. * After pruning, run attic's consistency checks on all archives.
  1228. * Integration tests for argument parsing.
  1229. * Documentation updates about repository encryption.
  1230. 0.0.2
  1231. * Configuration support for additional attic prune flags: keep_within, keep_hourly, keep_yearly,
  1232. and prefix.
  1233. 0.0.1
  1234. * Initial release.