Simple, configuration-driven backup software for servers and workstations
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 

425 lines
18 KiB

  1. 1.3.17
  2. * #217: Fix error with "borgmatic check --only" command-line flag with "extract" consistency check.
  3. 1.3.16
  4. * #210: Support for Borg check --verify-data flag via borgmatic "data" consistency check.
  5. * #210: Override configured consistency checks via "borgmatic check --only" command-line flag.
  6. * When generating sample configuration with generate-borgmatic-config, add a space after each "#"
  7. comment indicator.
  8. 1.3.15
  9. * #208: Fix for traceback when the "checks" option has an empty value.
  10. * #209: Bypass Borg error about a moved repository via "relocated_repo_access_is_ok" option in
  11. borgmatic storage configuration section.
  12. * #213: Reorder arguments passed to Borg to fix duplicate directories when using Borg patterns.
  13. * #214: Fix for hook erroring with exit code 1 not being interpreted as an error.
  14. 1.3.14
  15. * #204: Do not treat Borg warnings (exit code 1) as failures.
  16. * When validating configuration files, require strings instead of allowing any scalar type.
  17. 1.3.13
  18. * #199: Add note to documentation about using spaces instead of tabs for indentation, as YAML does
  19. not allow tabs.
  20. * #203: Fix compatibility with ruamel.yaml 0.16.x.
  21. * If a "prefix" option in borgmatic's configuration has an empty value (blank or ""), then disable
  22. default prefix.
  23. 1.3.12
  24. * Only log to syslog when run from a non-interactive console (e.g. a cron job).
  25. * Remove unicode byte order mark from syslog output so it doesn't show up as a literal in rsyslog
  26. output. See discussion on #197.
  27. 1.3.11
  28. * #193: Pass through several "borg list" and "borg info" flags like --short, --format, --sort-by,
  29. --first, --last, etc. via borgmatic command-line flags.
  30. * Add borgmatic info --repository and --archive command-line flags to display info for individual
  31. repositories or archives.
  32. * Support for Borg --noatime, --noctime, and --nobirthtime flags via corresponding options in
  33. borgmatic configuration location section.
  34. 1.3.10
  35. * #198: Fix for Borg create error output not showing up at borgmatic verbosity level zero.
  36. 1.3.9
  37. * #195: Switch to command-line actions as more traditional sub-commands, e.g. "borgmatic create",
  38. "borgmatic prune", etc. However, the classic dashed options like "--create" still work!
  39. 1.3.8
  40. * #191: Disable console color via "color" option in borgmatic configuration output section.
  41. 1.3.7
  42. * #196: Fix for unclear error message for invalid YAML merge include.
  43. * #197: Don't color syslog output.
  44. * Change default syslog verbosity to show errors only.
  45. 1.3.6
  46. * #53: Log to syslog in addition to existing console logging. Add --syslog-verbosity flag to
  47. customize the log level. See the documentation for more information:
  48. https://torsion.org/borgmatic/docs/how-to/inspect-your-backups/
  49. * #178: Look for .yml configuration file extension in addition to .yaml.
  50. * #189: Set umask used when executing hooks via "umask" option in borgmatic hooks section.
  51. * Remove Python cache files before each Tox run.
  52. * Add #borgmatic Freenode IRC channel to documentation.
  53. * Add Borg/borgmatic hosting providers section to documentation.
  54. * Add files for building documentation into a Docker image for web serving.
  55. * Upgrade project build server from Drone 0.8 to 1.1.
  56. * Build borgmatic documentation during continuous integration.
  57. * We're nearly at 500 ★s on GitHub. We can do this!
  58. 1.3.5
  59. * #153: Support for various Borg directory environment variables (BORG_CONFIG_DIR, BORG_CACHE_DIR,
  60. etc.) via options in borgmatic's storage configuration.
  61. * #177: Fix for regression with missing verbose log entries.
  62. 1.3.4
  63. * Part of #125: Color borgmatic (but not Borg) output when using an interactive terminal.
  64. * #166: Run tests for all installed versions of Python.
  65. * #168: Update README with continuous integration badge.
  66. * #169: Automatically sort Python imports in code.
  67. * Document installing borgmatic with pip install --user instead of a system Python install.
  68. * Get more reproducible builds by pinning the versions of pip and tox used to run tests.
  69. * Factor out build/test configuration from tox.ini file.
  70. 1.3.3
  71. * Add validate-borgmatic-config command, useful for validating borgmatic config generated by
  72. configuration management or even edited by hand.
  73. 1.3.2
  74. * #160: Fix for hooks executing when using --dry-run. Now hooks are skipped during a dry run.
  75. 1.3.1
  76. * #155: Fix for invalid JSON output when using multiple borgmatic configuration files.
  77. * #157: Fix for seemingly random filename ordering when running through a directory of
  78. configuration files.
  79. * Fix for empty JSON output when using --create --json.
  80. * Now capturing Borg output only when --json flag is used. Previously, borgmatic delayed Borg
  81. output even without the --json flag.
  82. 1.3.0
  83. * #148: Configuration file includes and merging via "!include" tag to support reuse of common
  84. options across configuration files.
  85. 1.2.18
  86. * #147: Support for Borg create/extract --numeric-owner flag via "numeric_owner" option in
  87. borgmatic's location section.
  88. 1.2.17
  89. * #140: List the files within an archive via --list --archive option.
  90. 1.2.16
  91. * #119: Include a sample borgmatic configuration file in the documentation.
  92. * #123: Support for Borg archive restoration via borgmatic --extract command-line flag.
  93. * Refactor documentation into multiple separate pages for clarity and findability.
  94. * Organize options within command-line help into logical groups.
  95. * Exclude tests from distribution packages.
  96. 1.2.15
  97. * #127: Remove date echo from schema example, as it's not a substitute for real logging.
  98. * #132: Leave exclude_patterns glob expansion to Borg, since doing it in borgmatic leads to
  99. confusing behavior.
  100. * #136: Handle and format validation errors raised during argument parsing.
  101. * #138: Allow use of --stats flag when --create or --prune flags are implied.
  102. 1.2.14
  103. * #103: When generating sample configuration with generate-borgmatic-config, document the defaults
  104. for each option.
  105. * #116: When running multiple configuration files, attempt all configuration files even if one of
  106. them errors. Log a summary of results at the end.
  107. * Add borgmatic --version command-line flag to get the current installed version number.
  108. 1.2.13
  109. * #100: Support for --stats command-line flag independent of --verbosity.
  110. * #117: With borgmatic --init command-line flag, proceed without erroring if a repository already
  111. exists.
  112. 1.2.12
  113. * #110: Support for Borg repository initialization via borgmatic --init command-line flag.
  114. * #111: Update Borg create --filter values so a dry run lists files to back up.
  115. * #113: Update README with link to a new/forked Docker image.
  116. * Prevent deprecated --excludes command-line option from being used.
  117. * Refactor README a bit to flow better for first-time users.
  118. * Update README with a few additional borgmatic packages (Debian and Ubuntu).
  119. 1.2.11
  120. * #108: Support for Borg create --progress via borgmatic command-line flag.
  121. 1.2.10
  122. * #105: Support for Borg --chunker-params create option via "chunker_params" option in borgmatic's
  123. storage section.
  124. 1.2.9
  125. * #102: Fix for syntax error that occurred in Python 3.5 and below.
  126. * Make automated tests support running in Python 3.5.
  127. 1.2.8
  128. * #73: Enable consistency checks for only certain repositories via "check_repositories" option in
  129. borgmatic's consistency configuration. Handy for large repositories that take forever to check.
  130. * Include link to issue tracker within various command output.
  131. * Run continuous integration tests on a matrix of Python and Borg versions.
  132. 1.2.7
  133. * #98: Support for Borg --keep-secondly prune option.
  134. * Use Black code formatter and Flake8 code checker as part of running automated tests.
  135. * Add an end-to-end automated test that actually integrates with Borg.
  136. * Set up continuous integration for borgmatic automated tests on projects.evoworx.org.
  137. 1.2.6
  138. * Fix generated configuration to also include a "keep_daily" value so pruning works out of the
  139. box.
  140. 1.2.5
  141. * #57: When generating sample configuration with generate-borgmatic-config, comment out all
  142. optional configuration so as to streamline the initial configuration process.
  143. 1.2.4
  144. * Fix for archive checking traceback due to parameter mismatch.
  145. 1.2.3
  146. * #64, #90, #92: Rewrite of logging system. Now verbosity flags passed to Borg are derived from
  147. borgmatic's log level. Note that the output of borgmatic might slightly change.
  148. * Part of #80: Support for Borg create --read-special via "read_special" option in borgmatic's
  149. location configuration.
  150. * #87: Support for Borg create --checkpoint-interval via "checkpoint_interval" option in
  151. borgmatic's storage configuration.
  152. * #88: Fix declared pykwalify compatibility version range in setup.py to prevent use of ancient
  153. versions of pykwalify with large version numbers.
  154. * #89: Pass --show-rc option to Borg when at highest verbosity level.
  155. * #94: Support for Borg --json option via borgmatic command-line to --create archives.
  156. 1.2.2
  157. * #85: Fix compatibility issue between pykwalify and ruamel.yaml 0.15.52, which manifested in
  158. borgmatic as a pykwalify RuleError.
  159. 1.2.1
  160. * Skip before/after backup hooks when only doing --prune, --check, --list, and/or --info.
  161. * #71: Support for XDG_CONFIG_HOME environment variable for specifying alternate user ~/.config/
  162. path.
  163. * #74, #83: Support for Borg --json option via borgmatic command-line to --list archives or show
  164. archive --info in JSON format, ideal for programmatic consumption.
  165. * #38, #76: Upgrade ruamel.yaml compatibility version range and fix support for Python 3.7.
  166. * #77: Skip non-"*.yaml" config filenames in /etc/borgmatic.d/ so as not to parse backup files,
  167. editor swap files, etc.
  168. * #81: Document user-defined hooks run before/after backup, or on error.
  169. * Add code style guidelines to the documention.
  170. 1.2.0
  171. * #61: Support for Borg --list option via borgmatic command-line to list all archives.
  172. * #61: Support for Borg --info option via borgmatic command-line to display summary information.
  173. * #62: Update README to mention other ways of installing borgmatic.
  174. * Support for Borg --prefix option for consistency checks via "prefix" option in borgmatic's
  175. consistency configuration.
  176. * Add introductory screencast link to documentation.
  177. * #59: Ignore "check_last" and consistency "prefix" when "archives" not in consistency checks.
  178. * #60: Add "Persistent" flag to systemd timer example.
  179. * #63: Support for Borg --nobsdflags option to skip recording bsdflags (e.g. NODUMP, IMMUTABLE) in
  180. archive.
  181. * #69: Support for Borg prune --umask option using value of existing "umask" option in borgmatic's
  182. storage configuration.
  183. * Update tox.ini to only assume Python 3.x instead of Python 3.4 specifically.
  184. * Add ~/.config/borgmatic/config.yaml to default configuration path probing.
  185. * Document how to develop on and contribute to borgmatic.
  186. 1.1.15
  187. * Support for Borg BORG_PASSCOMMAND environment variable to read a password from an external file.
  188. * Fix for Borg create error when using borgmatic's --dry-run and --verbosity options together.
  189. Work-around for behavior introduced in Borg 1.1.3: https://github.com/borgbackup/borg/issues/3298
  190. * #55: Fix for missing tags/releases on Gitea and GitHub project hosting.
  191. * #56: Support for Borg --lock-wait option for the maximum wait for a repository/cache lock.
  192. * #58: Support for using tilde in exclude_patterns to reference home directory.
  193. 1.1.14
  194. * #49: Fix for typo in --patterns-from option.
  195. * #47: Support for Borg --dry-run option via borgmatic command-line.
  196. 1.1.13
  197. * #54: Fix for incorrect consistency check flags passed to Borg when all three checks ("repository",
  198. "archives", and "extract") are specified in borgmatic configuration.
  199. * #48: Add "local_path" to configuration for specifying an alternative Borg executable path.
  200. * #49: Support for Borg experimental --patterns-from and --patterns options for specifying mixed
  201. includes/excludes.
  202. * Moved issue tracker from Taiga to integrated Gitea tracker at
  203. https://projects.torsion.org/witten/borgmatic/issues
  204. 1.1.12
  205. * #46: Declare dependency on pykwalify 1.6 or above, as older versions yield "Unknown key: version"
  206. rule errors.
  207. * Support for Borg --keep-minutely prune option.
  208. 1.1.11
  209. * #26: Add "ssh_command" to configuration for specifying a custom SSH command or options.
  210. * Fix for incorrect /etc/borgmatic.d/ configuration path probing on macOS. This problem manifested
  211. as an error on startup: "[Errno 2] No such file or directory: '/etc/borgmatic.d'".
  212. 1.1.10
  213. * Pass several Unix signals through to child processes like Borg. This means that Borg now properly
  214. shuts down if borgmatic is terminated (e.g. due to a system suspend).
  215. * #30: Support for using tilde in repository paths to reference home directory.
  216. * #43: Support for Borg --files-cache option for setting the files cache operation mode.
  217. * #45: Support for Borg --remote-ratelimit option for limiting upload rate.
  218. * Log invoked Borg commands when at highest verbosity level.
  219. 1.1.9
  220. * #17, #39: Support for user-defined hooks before/after backup, or on error.
  221. * #34: Improve clarity of logging spew at high verbosity levels.
  222. * #30: Support for using tilde in source directory path to reference home directory.
  223. * Require "prefix" in retention section when "archive_name_format" is set. This is to avoid
  224. accidental pruning of archives with a different archive name format. For similar reasons, default
  225. "prefix" to "{hostname}-" if not specified.
  226. * Convert main source repository from Mercurial to Git.
  227. * Update dead links to Borg documentation.
  228. 1.1.8
  229. * #40: Fix to make /etc/borgmatic/config.yaml optional rather than required when using the default
  230. config paths.
  231. 1.1.7
  232. * #29: Add "archive_name_format" to configuration for customizing archive names.
  233. * Fix for traceback when "exclude_from" value is empty in configuration file.
  234. * When pruning, make highest verbosity level list archives kept and pruned.
  235. * Clarification of Python 3 pip usage in documentation.
  236. 1.1.6
  237. * #13, #36: Support for Borg --exclude-from, --exclude-caches, and --exclude-if-present options.
  238. 1.1.5
  239. * #35: New "extract" consistency check that performs a dry-run extraction of the most recent
  240. archive.
  241. 1.1.4
  242. * #18: Added command-line flags for performing a borgmatic run with only pruning, creating, or
  243. checking enabled. This supports use cases like running consistency checks from a different cron
  244. job with a different frequency, or running pruning with a different verbosity level.
  245. 1.1.3
  246. * #15: Support for running multiple config files in /etc/borgmatic.d/ from a single borgmatic run.
  247. * Fix for generate-borgmatic-config writing config with invalid one_file_system value.
  248. 1.1.2
  249. * #33: Fix for passing check_last as integer to subprocess when calling Borg.
  250. 1.1.1
  251. * Part of #33: Fix for upgrade-borgmatic-config converting check_last option as a string instead of
  252. an integer.
  253. * Fix for upgrade-borgmatic-config erroring when consistency checks option is not present.
  254. 1.1.0
  255. * Switched config file format to YAML. Run upgrade-borgmatic-config to upgrade.
  256. * Added generate-borgmatic-config command for initial config creation.
  257. * Dropped Python 2 support. Now Python 3 only.
  258. * #19: Fix for README mention of sample files not included in package.
  259. * #23: Sample files for triggering borgmatic from a systemd timer.
  260. * Support for backing up to multiple repositories.
  261. * To free up space, now pruning backups prior to creating a new backup.
  262. * Enabled test coverage output during tox runs.
  263. * Added logo.
  264. 1.0.3
  265. * #22: Fix for verbosity flag not actually causing verbose output.
  266. 1.0.2
  267. * #21: Fix for traceback when remote_path option is missing.
  268. 1.0.1
  269. * #20: Support for Borg's --remote-path option to use an alternate Borg
  270. executable. See sample/config.
  271. 1.0.0
  272. * Attic is no longer supported, as there hasn't been any recent development on
  273. it. Dropping Attic support will allow faster iteration on Borg-specific
  274. features. If you're still using Attic, this is a good time to switch to Borg!
  275. * Project renamed from atticmatic to borgmatic. See the borgmatic README for
  276. information on upgrading.
  277. 0.1.8
  278. * Fix for handling of spaces in source_directories which resulted in backup up everything.
  279. * Fix for broken links to Borg documentation.
  280. * At verbosity zero, suppressing Borg check stderr spew about "Checking segments".
  281. * Support for Borg --one-file-system.
  282. * Support for Borg create --umask.
  283. * Support for file globs in source_directories.
  284. 0.1.7
  285. * #12: Fixed parsing of punctuation in configuration file.
  286. * Better error message when configuration file is missing.
  287. 0.1.6
  288. * #10: New configuration option for the encryption passphrase.
  289. * #11: Support for Borg's new archive compression feature.
  290. 0.1.5
  291. * Changes to support release on PyPI. Now pip installable by name!
  292. 0.1.4
  293. * Adding test that setup.py version matches release version.
  294. 0.1.3
  295. * #2: Add support for "borg check --last N" to Borg backend.
  296. 0.1.2
  297. * As a convenience to new users, allow a missing default excludes file.
  298. * New issue tracker, linked from documentation.
  299. 0.1.1
  300. * Adding borgmatic cron example, and updating documentation to refer to it.
  301. 0.1.0
  302. * New "borgmatic" command to support Borg backup software, a fork of Attic.
  303. 0.0.7
  304. * Flag for multiple levels of verbosity: some, and lots.
  305. * Improved mocking of Python builtins in unit tests.
  306. 0.0.6
  307. * New configuration section for customizing which Attic consistency checks run, if any.
  308. 0.0.5
  309. * Fixed regression with --verbose output being buffered. This means dropping the helpful error
  310. message introduced in 0.0.4.
  311. 0.0.4
  312. * Now using tox to run tests against multiple versions of Python in one go.
  313. * Helpful error message about how to create a repository if one is missing.
  314. * Troubleshooting section with steps to deal with broken pipes.
  315. * Nosetests config file (setup.cfg) with defaults.
  316. 0.0.3
  317. * After pruning, run attic's consistency checks on all archives.
  318. * Integration tests for argument parsing.
  319. * Documentation updates about repository encryption.
  320. 0.0.2
  321. * Configuration support for additional attic prune flags: keep_within, keep_hourly, keep_yearly,
  322. and prefix.
  323. 0.0.1
  324. * Initial release.