Release Notes

v0.29.1 (2025-02-06)

❄️ Small maintenance release ☃️

Not much going on in this maintenance release while I’m still working on a big refactoring of the scheduling for the next release.

  • logrotate package added to the Docker image
  • upgrade dependencies to fix security vulnerabilities

Changelog

v0.29.0 (2024-10-28)

🧙🏻‍♀️ Halloween edition 🎃

  • Finally a long standing bug was fixed in this version: use proper nice and ionice values on systemd scheduled tasks.
  • Also the last chunk of work for the configuration v2: we can now schedule groups!
  • Improvement on the JSON schema: a single URL can be used for v1 and v2 configuration
  • Another long standing bug on Windows: escape configuration file path on scheduled tasks

Changelog

v0.28.1 (2024-10-02)

🍂 Autumn bug fixing 🍁

  • fix JSON schema for TOML files that stopped working some time ago (when using Even Better TOML extension on VSCode)
  • [configuration v2] fix regression bug where profile groups were stopping after an error when the continue-on-error flag was set

Changelog

v0.28.0 (2024-08-17)

🌞 Sunny Summer Edition 🌻

Two big things in this release:

  • support for all the new commands and flags of restic 0.17
  • experimental support for environment variables in configuration flags

Example of using environment variables in configuration:

check-repo-profile:
    inherit: default

    run-before:
        - "echo DOW=`date +\"%u\"` >> {{ env }}"

    check:
        read-data-subset: "$DOW/7"

Changelog

  • 3b42e4a Add contributed docs for protected configuration on Windows (#394)
  • 1e80d02 Restic 0.17 (#396)
  • eb8c721 build with go 1.23
  • 1df3711 convert priority value to lowercase
  • d74c521 fix panic when sending on closed handler
  • 49add79 refactoring of arguments generation (#387)
  • cff446b upgrade packages

v0.27.1 (2024-07-08)

🌦️ Rainy Summer Edition ☔

Fix of a regression bug preventing resticprofile from sending logs to a temporary session log file (prefixed with temp:/t/) Thanks @iluvatyr for the quick bug report 👍🏻

Changelog

  • a615444 fix creation of mock binaries during unit tests (#375)
  • c9f87ec fix documentation for release
  • eb13003 fix regression with temporary log file (#386)
  • abf35a7 prepare next release
  • 854f6c9 refactor unit tests on package lock (#374)
  • ffffabf remove flaky test
  • 5cfdca2 remove goarm linked to the internal variable of runtime go1.23 will apparently forbid the use of linkname to the standard library

v0.27.0 (2024-06-27)

🌻 Summer release 🌞

Summer is here in the Northern Hemisphere! A new release is here too! 🎉

A lot of goodies in this release:

new run-schedule command

It’s more a behind the scene feature: you no longer need to re-schedule your targets after you changed the configuration. The generated schedule command line is now using this new run-schedule command that reads all the newest bits from the configuration.

You might want to unschedule and schedule all your profiles one last time to replace the existing command line using the new run-schedule command.

More information: https://creativeprojects.github.io/resticprofile/schedules/commands/index.html#run-schedule-command

direct support for crontab files

Previously resticprofile was using the crontab tool to read and write crond schedules. Now you can directly setup a crontab file no matter which tool is going to consume it.

More information: https://creativeprojects.github.io/resticprofile/schedules/index.html

keep content of configuration variables between commands

This was a big issue for some time. The wait is over! You can now set a configuration variable anywhere in a script and use its value later.

More information: https://creativeprojects.github.io/resticprofile/configuration/run_hooks/index.html#passing-environment-variables

“RESTICPROFILE_{FLAGNAME}” env vars

All cli flags can now be set using environment variables.

More information: #334

allow controlling command output redirection

Allow redirection of the console messages to a log file or to syslog.

More information: #343

Add “–stderr” to redirect console to stderr (for “cat” and “dump”)

More information: https://github.com/creativeprojects/resticprofile/pull/353

Add option to set working directory for restic backup

More information: https://github.com/creativeprojects/resticprofile/pull/354

many bug fixes!

Changelog

  • 1bbac2a Add “–stderr” to redirect console to stderr (for “cat” and “dump”) (#353)
  • 0598026 Add documentation on how to ingest resticprofile stats into telegraf (#366)
  • f9b5dac Add option to set working directory for restic backup (#354)
  • 00360a2 Fix group priority (#339)
  • a05ad39 Relative source followup: Evaluate symlinks (#355)
  • 56f20af Squashed commit of the following: (#259)
  • 6b00c2c add “profile” flag as an alias for “name” (#357)
  • 6da0317 also search configuration from ~/.config/resticprofile on macOS (#370)
  • 5739b13 crond: add support for crontab file only (on any OS) (#289)
  • 9719411 don’t replace header value in stringifyHeaders (#327)
  • 2a7d5fc drop-ins: move systemd drop-ins into unified schedule struct (#341)
  • 7e03741 drop-ins: transparent timer drop-in support (#340)
  • 9b2bd8c env-file: Implement dotenv and {{env}} support (#323)
  • 16f5dc5 fix remaining unit tests failing in Windows (#360)
  • 3b8613e fixed link to config reference / global section (#349)
  • 5fad1cb flags: added “RESTICPROFILE_{FLAGNAME}” env vars (#335)
  • 85d5afc log: allow controlling command output redirection (#343)
  • e5b17d3 restic: use repository-file if the repo flag contains a password (#336)
  • 4255868 schedule: added unified schedule config struct (#333)
  • 667180e syslog: local syslog and stdout redirection (#344)
  • e93874d build with go 1.22 and macOs arm64 (#317)
  • e6eed3d update test to pass on Windows 11 (#359)
  • 655e9c5 upgrade packages (CVE-2024-24786) (#347)
  • 08a01c4 upgrade packages (CVE-2024-6104)

v0.26.0 (2024-02-20)

🦆 Second time lucky February release 🚀

🆕 A lot of pre-built binaries have been added on this release. This is to align with the list of pre-built binaries provided by restic

Otherwise this is mostly a maintenance release with a few fixes:

  • fixes multiple backup profiles exporting prometheus files to node_exporter
  • fix missing fields in the show command
  • weekly docker image build (rebuilt under the same version tag, and as latest)
  • restrict the copy command to a list of snapshots in the configuration

Changelog

  • 2ab1f3a Add pre-built binary targets to release pipeline (#324)
  • 233e4b8 Add prometheus label to build info (#319)
  • b1b03db Change priority warning message (#310)
  • 9eba431 Fix missing fields in show command (#315)
  • a9273f8 Merge pull request #312 from creativeprojects/nightly
  • 15004f9 Restrict copy command to a list of snapshots (#291)
  • 1c076dc add separate goreleaser config for rebuilding the docker image only (#309)
  • bbb3760 add snapshot build to docker hub
  • 8aebd28 publish docker images and manifest manually (#313)

v0.25.0 (2024-02-08)

💖 February release 💝

⚠️ Potential breaking change

The prometheus library used to send metrics to the proxy using protobuf. By default it’s now using the more widely used text format.

If you have any issue sending metrics to your proxy, you can revert to the previous behaviour by adding this option to your profile (it’s not a global option)

my_profile:
  prometheus-push-format: protobuf

More information about the different formats: https://prometheus.io/docs/instrumenting/exposition_formats/#exposition-formats

New in this version

  • fix for CVE-2023-48795
  • new option prometheus-push-format with values text or protobuf (#281)
  • new option to set log output in global section (#277)
  • more control over the default systemd service files (#267)
  • and bug fixes!

Thanks to all our contributors for the good work!

Changelog

  • 765c2af Add prometheus-push-format to allow selecting text format (#281)
  • ae9554a Pass context to own commands and profile runner (#280)
  • fccc05b Remove rclone binary in make clean target (#283)
  • 0871d28 Trying new configuration for CodeQL (#306)
  • 1317f60 Upgrade packages (#307)
  • 63f8faf chore: prep next release & allow deployment to fail on PR
  • 3d72803 chore: various fixes (#285)
  • 952380f doc: add information about windows path in variables
  • f346571 doc: add various missing information (#278)
  • 1b3292c logging: allow to setup default log output in global (#277)
  • 99484bf macOS: create LaunchAgents folder if it doesn’t exist
  • 37dcf84 profile: support source with “-” (dash) prefix (#276)
  • a1b7840 systemd drop-ins support, option to wait for network-online.target (#267)

v0.24.0 (2023-10-24)

🎃 October release 👻

  • upgrade dependencies to fix CVE-2023-3978, CVE-2023-39325 and CVE-2023-44487
  • fix the broken documentation (some tabs were not accessible)
  • can now stop the wait for a lock (restic or resticprofile lock). Before the fix the CTRL-C or other signal was ignored until the lock was acquired or timed out.
  • resticprofile is now available on scoop! thanks @hgraeber
  • detect if the host is running on battery and cancel an action depending on how much battery is left - see schedule section
  • bug fixes (see changelog)

Changelog

  • ac99302 Allow to interrupt the wait for a lock (#249)
  • b08ac73 Detect if running on battery (#235)
  • 1e6d07a Docs for installation from scoop (#268)
  • 0d73c2b Fix doc shortcodes (#271)
  • f5e751c Template: Reduce log level for Getwd() failures (#251)
  • e20973e systemd: prevent paging in systemd schedules (#270)
  • bcfaaa7 upgrade packages - CVE-2023-3978 - CVE-2023-39325 - CVE-2023-44487

v0.23.0 (2023-08-11)

🌞 New summer edition 🌻

This release mostly fixes a few regression from version 0.21.0 and adds a handful of new features:

  • Allow to set base-dir and source-dir in a profile so you can start resticprofile from any current folder
  • Allow to set keep-tag, tag & group-by as empty string
  • Support for restic v0.16 new flags

Thanks to all the contributors for the great work 👍🏻

Changelog

  • b0767ad Added {{ “data” | base64 }} & {{ “data” | hex }} (#213)
  • b00c8a0 Allow to set a base-dir inside the profile (#183) (#192)
  • 4b2ea31 Fix 194: Allow to set “keep-tag”, “tag” & “group-by” as empty string (#220)
  • 10057d4 Fix 218: Args filter must not remove paths (#222)
  • 0c8c985 Fix 223, 230: Escape args and absolute restic path for pwsh (#224)
  • 2bf0d28 Fix 242: iexclude-file not converted to abs path (#243)
  • 6cbfdb3 Fix links for versioned JSON schema files (#244)
  • fc66fab Fix schedule tests (#236)
  • 304e418 Fix: Do not add --tag for tag: true (#221)
  • 82fccdb Restic: Add restic v16 release (#238)
  • 3f4e0bf Restic: Fixed unit tests for restic v16 (#239)
  • ba9297a Retention: Align host filter with “backup” (#227)
  • 347501d Schedule: Capture os.Environ on schedule creation (#212)
  • 9c05157 Support lock-wait with --lock-retry in restic 0.16 (#240)
  • 6cc332d Support build when GOPATH is unset / fix mockery build warning (#234)
  • 3476fbc Variables: Allow to escape “$” with “$$” (#216)

v0.22.0 (2023-05-06)

⚠️ Breaking change

The default value of the job tag on prometheus gateway push has changed from command to profile.command. But don’t worry: you can easily revert back to the original value by adding this option in your configuration:

prometheus-push-job: "${COMMAND}"

Fixes:

  • Complicated scheduling on Windows was sometimes setting up a random delay before starting a job

Changelog

  • c00fc9a New option to specify Prometheus Pushgateway job name (#193)
  • 0c7405f Templates: Add map/splitR/contains/matches (#197)
  • 7545bbf Upgrade task scheduler library (#206)

v0.21.1 (2023-04-05)

Bug fixes!

This small release fixes two regression bugs introduced in version 0.21.0

  • the ~ was no longer replaced by the user’s home directory for some flag (repository and others…)
  • environment variables were no longer replaced by their value for some flag (repository and others…)

Thanks @jkellerer for the quick fixes 😉 👍🏻

New features from v0.21.0

This release adds a verification of all the flags permitted by restic. Only the flags compatible with your version of restic will be generated (prior to this version, any flag like unknown-flag would end up on the restic command line as --unknown-flag.

Also this version generates a JSON schema: this is the configuration schema which can auto-complete options, and verify that your configuration is correct. It works with any compatible editor for the JSON, TOML and YAML configuration file format. Thanks @jkellerer for the awesome work on this 🎉 . More information here.

Other nice feature is the introduction of the help command which works for both all the resticprofile and restic commands and flags. Try it out!

Changelog

  • 487db0b Fix #187: homedir/env-vars in repo and other flags (#188)
  • b78d1a0 Fix #189: completion of own commands (#190)
  • b6a98ef Updated clog to 0.13 (#191)

v0.21.0 (2023-04-03)

This is a great milestone for resticprofile 🥳

This release adds a verification of all the flags permitted by restic. Only the flags compatible with your version of restic will be generated (prior to this version, any flag like unknown-flag would end up on the restic command line as --unknown-flag.

Also this version generates a JSON schema: this is the configuration schema which can auto-complete options, and verify that your configuration is correct. It works with any compatible editor for the JSON, TOML and YAML configuration file format. Thanks @jkellerer for the awesome work on this 🎉 . More information here.

Other nice feature is the introduction of the help command which works for both all the resticprofile and restic commands and flags. Try it out!

And as usual, a lot of bug fixes 😉

Changelog

  • 683bf78 Add variables .OS and .Arch to all templates (#181)
  • 74b0c46 Allow config encoding in UTF16 and ISO88591
  • d6a51ad Enhanced: Catch any –help & –dry-run (http only) (#178)
  • 3f5cdc6 Feature: JSON schema (#103) & generated reference
  • 1aad0fb Fix #164: Failure on uppercase mixin names
  • e65f9bc Implement tempDir and log without locking (#168) (#174)
  • f2a9c04 Make URL and header confidential in HTTP-hook (#175)
  • e069b77 Restic: Add restic v15 release (#180)
  • d2e789c add build tag to disable self-update (#184)
  • 8231087 add suppport for user_logged_on (#160)
  • f782ef5 build with go 1.20
  • bd3813a upgrade packages CVE-2022-41721

v0.20.0 (2023-01-23)

Not too many new features in this release, but I wanted to build a new docker image with the new restic 0.15.0

Improvements

  • Adds shell command hooks to the following additional commands: dump, find, ls, mount, restore, snapshots, stats and tag.
  • Docker image now contains ssh (to allow sftp repository), curl, tzdata and ca-certificates

Changelog

  • 51634c8 Merge pull request #154 from jkellerer/ft-151
  • 00ab266 New docker image (#161)
  • fce7165 Run-hooks for all non-conflicting commands (#151)
  • 7439620 add QEMU for github agent to build an arm64 image
  • 7c2f806 dry-run should not send web hooks #157

v0.19.0 (2022-11-11)

New version 0.19.0 of resticprofile!

With:

  • New help system showing all flags from resticprofile and restic. Just type resticprofile help backup and see (thanks @jkellerer)
  • copy command now has run-before, run-after, run-after-fail and run-finally targets. Also more targets are now available for backup and for a profile. See the documentation.
  • groups of profiles can keep running after a profile failed (this is a global settings)
  • Prevent your system from idle sleeping (Windows, macOS, and unix type OS using systemd)
  • May contain nuts

Changelog

  • c360880 Add –help to own commands (e.g. generate –help) (#139)
  • 1edf995 Add last backup time to prometheus metrics (#132)
  • 8a70e7b Config: Add run before/after/fail to more restic commands than backup (#138)
  • 419e66c Continue profile in group on error (#149)
  • a880b44 Fixes zsh completion script (use of outdated CLI) (#150)
  • 49c4920 Prevent system from idle sleeping (#140)
  • d4c1032 add devcontainer config
  • 0c43c2c chore: upgrade packages

v0.18.0 (2022-08-29)

Following the release of the long awaited restic 0.14.0, here’s a new resticprofile!

A few big features were introduced in this version:

  • HTTP hooks using a similar syntax to command hooks but sending HTTP messages to monitoring platforms
  • Better support of the new-ish copy command
  • Addition of mixins on configuration file v2 (in preview)
  • Ability to choose your preferred shell on Windows (cmd, powershell or bash)
  • Send resticprofile logs to a syslog server
  • Add armv8 (arm64) CPU target to docker images
  • Upgrade to restic 0.14.0 in docker image
  • Add rclone to docker image
  • Also search for a configuration file in the resticprofile program folder on Windows (to be used in portable mode)

Changelog

  • 7ba20ad Add http hooks (#114)
  • fb62876 Add support for syslog (#127)
  • a5c1147 Allow to choose shell in global config (#112)
  • d492d7d ConfigV2: Mixins (#115)
  • ca9a418 ConfigV2: Replace list params - fix #108 (#113)
  • 2ed3045 Initialise copy repository using –copy-chunker-params (#117)
  • 43ce0be Mixins: List merging & inheritance update (#121)
  • 1b8774c add binary dir in path and .BinaryDir template var (#134)
  • eb70a8a add goreleaser config to also build arm64 images
  • 35d07ee add rclone to docker image #131
  • 0381942 upgrade packages (CVE-2022-28948)

v0.17.0 (2022-05-16)

Here it is!

It’s been a while since we released a new version 😞 The resticprofile team has been busy preparing some really cool new features:

  • simplify the command line by allowing the use of [profile].[command] - Thanks @Syphdias for the PR #89
  • shell completion (for bash, can also be used by zsh with bash compatibility) - Thanks @jkellerer for the PR #90
  • run a shell command to use as a stdin input (like mysqldump) - Thanks @jkellerer for the PR #98
  • run a shell command in the background when non fatal errors are detected from restic - Thanks @jkellerer for the PR #99

and a lot of bug fixes 👍🏻

Changelog

  • 83e423e Add run flag to to be able to have profile and job name as one argument (#89)
  • 20a3b81 Added “generate” command to create resources (#110)
  • 1d2b214 Added missing cmds that filter by host, tag & path
  • 8cef157 Feature: Take command output as stdin for restic (#98)
  • fe336ff Fix and unit tests for #91
  • ad511c4 Fix config includes when any pattern has no match (#95)
  • 3e856ce Implemented stream-error callbacks (#99)
  • 3688b90 Merge pull request #101 from jkellerer/fix-common-args
  • 4f13930 Merge pull request #94 from jkellerer/ft-add-missing-commands
  • a72f635 Only pass common CLI args to command hooks [#100]
  • 7553a24 Shell completion (#90)
  • ea52e93 display a neat stack trace on panic
  • ff13660 fix for profiles command not showing inherited commands fixes second part of #97
  • 69dd965 remove “includes” section from profiles in “profiles” command

v0.16.1 (2022-01-30)

New maintenance version, with bug fixes:

  • fix multiplication of arguments when commands are retried
  • fix status file telling the backup was successful when a warning happened (file/dir not found)

Changelog

  • e18906b Fix args are multiplied when commands are retried (#84)
  • 358f060 Fix for #88 with unit tests
  • b011437 don’t inherit profile description
  • 16ad4b1 prepare for future versions of the configuration
  • da8c255 show schedules separately
  • 358a5db simple implementation of a config file v2
  • e2bd2cf update packages

v0.16.0 (2021-10-18)

This release adds a few new features:

  • support for splitting configuration into multiple files
  • support for run-finally that runs shell commands every time after restic
  • ability to define your own systemd unit and timer files (from go templates)
  • support for the restic copy command
  • fix for some cosmetic issues with crond scheduler

Changelog

  • 1fa7d48 Add support for copy command (#73)
  • 271c128 Change codecov uploader to use GitHub Action v2 (#79)
  • 85fcc20 Optional: Allow disabling path in retention with ‘false’ (#67)
  • 8773899 Scheduler refactoring (#76)
  • 48c822c Support “run-finally” in backup-section & profile (#70)
  • ac13d06 Supporting config includes (e.g. profiles.d) (#65)
  • 245a440 Systemd template (#75)
  • 122620e add tests on crontab
  • 0dad5a8 crontab RemoveJob returns error if the entry was not found
  • ff2fc1f upgrade dependencies

Docker images

  • docker pull creativeprojects/resticprofile:0.16.0

v0.15.0 (2021-08-29)

⚠️ Important

Version 0.15 fixed some issues with escaping parameters to the restic command line. If you’ve used any of these characters in file or directory names in your configuration, please make sure your backup is still working as expected: space, *, ?, \, [, ', ".

If for some reason the fix broke your configuration, there’s a new flag legacy-arguments that you can activate in the global section to revert back to the broken implementation:

global:
    legacy-arguments: true

New features in 0.15:

  • add .Hostname in configuration template (#55)
  • add description field in profile section
  • add support for prometheus file export and push gateway
  • hide confidential values in output (#58)
  • add .TmpDir variable to configuration template (#62)

This version also includes fixes for:

  • resolving special paths starting with a ~ (unixes only)
  • warn when the restic binary was not found at the specified location (but still found at a different location)
  • resolve glob expressions in backup sources (#63)

Changelog

  • abf0b00 Add support for prometheus export and push (#57)
  • 37a69d7 Added “{{.TmpDir}}” to TemplateData (#62)
  • 8218e70 Feature: Hide confidential values in output (#58)
  • 0be5d5f Resolve glob expressions in backup sources (#63)
  • 8cc2574 Shell escape (#60)
  • 34f693c Update non-confidential values to support shell.Args (#68)
  • 0841959 add Hostname pre-defined variable to template resolver (#55)
  • f58116b add description field in profile section
  • 0f9b21e build with go 1.17
  • 16308e9 don’t send status summary in dry-run
  • 88052c6 show description in output of profiles command

Docker images

  • docker pull creativeprojects/resticprofile:0.15.0

v0.14.1 (2021-06-23)

Bug fix release

This release changes the way the restic binary is searched:

  • restic binary path in global configuration can now contain the ~ character like ~restic/bin/restic
  • if you specified a path in the global configuration and it cannot find the file, a warning will be displayed and resticprofile will keep trying to find a suitable binary

Changelog

  • 4686dd2 use shell to resolve special paths with ~
  • 823304a warning when the restic-binary was not found

Docker images

  • docker pull creativeprojects/resticprofile:0.14.1

v0.14.0 (2021-05-11)

Release 0.14.0

  • New locking/unlocking features. Thanks jkellerer for the PR

Changelog

  • 331b710 Added resticprofile flags –no-lock & –lock-wait (#33)
  • 7fc5b3a Summary from plain output when not run in terminal (#48)
  • b7edeb5 Updated contrib script systemd/send-error.sh (#49)
  • fa42cf2 add macOS arm64 target to install.sh script
  • a87f76d add token as an environment variable

Docker images

  • docker pull creativeprojects/resticprofile:latest
  • docker pull creativeprojects/resticprofile:0.14.0

v0.13.2 (2021-04-20)

This version fixes a defect where extended status wasn’t returning the extended information on Windows.

Changelog

  • cab8909 add Homebrew Tap (#45)
  • 794f404 add github token in config
  • 5e06dbd fix test too slow on build agent
  • 2f79a46 fix windows bogus prefix (#47)

Docker images

  • docker pull creativeprojects/resticprofile:latest
  • docker pull creativeprojects/resticprofile:0.13.2

v0.13.1 (2021-03-26)

Bug fix:

  • regression from v0.13.0: a message was sent to stderr when initialize parameter was set and the repository already exists

Changelog

  • 02e6414 Increase test coverage (#40)
  • d64dc4f fix #41: a message was sent to stderr when parameter initialize=true and repo exists

Docker images

  • docker pull creativeprojects/resticprofile:latest
  • docker pull creativeprojects/resticprofile:0.13.1

v0.13.0 (2021-03-24)

This version adds two new features:

  • parameter no-error-on-warning to consider a backup successful when restic produced a new snapshot but some files were missing (https://github.com/creativeprojects/resticprofile/discussions/38)
  • resticprofile now catches the error output (stderr) to be written in the status file, also makes the environment variable RESTIC_STDERR available to the targets run-after-fail.

Changelog

  • 8968e33 add RESTIC_STDERR env variable to run-after-fail
  • 6b7dea4 quick implementation of ignore warning
  • 833d24d quick mock to do some testing with a fake restic
  • 3c54cc6 returns stderr output in the status file

Docker images

  • docker pull creativeprojects/resticprofile:latest
  • docker pull creativeprojects/resticprofile:0.13.0

v0.12.0 (2021-03-18)

This release mainly brings 2 new features and a few enhancements:

  • add support for --all in status, schedule, unschedule commands
  • add backup statistics to the status file (via a new extended-status flag)

Changelog

  • 237a87f Add backup statistics in status file (#36)
  • 6622a39 Added fail env variable ERROR_COMMANDLINE (#32)
  • 0887354 Added support for –all to status & (un)schedule (#31)
  • 16e6c19 Enhanced “unschedule” to remove all possible jobs (#28)
  • 47489a2 add profile name when running status –all
  • 01ae05a fix an issue where status –all was stopping at the first profile with no schedule
  • f50131b update goreleaser config to v0.154
  • c700d60 upgrade packages
  • 4569f0d upgrade self-update library
  • 7eb663d use go 1.16

Docker images

  • docker pull creativeprojects/resticprofile:latest
  • docker pull creativeprojects/resticprofile:0.12.0

v0.11.0 (2021-01-20)

Highlights:

Deprecation

Scheduling in the retention section is now deprecated, please use the forget section instead (https://github.com/creativeprojects/resticprofile/issues/23)

Changelog

  • be72758 Add background types and low priorityIO to launchd plist (#19)
  • d0de636 Add support for scheduling forget (#26)
  • ec02310 Added prune as supported, schedulable command (#24)
  • 8f48acf Move CI build from Travis CI to GitHub Actions
  • 2e1564a Refactoring schedule package (#30)
  • 8fd7a2e Schedule priority (#29)
  • b8c3e6a add crond support to unix targets (except macOS)
  • 3e93f45 add deprecation notice for schedule on retention
  • 4b815f2 add docker build to goreleaser
  • 5830a34 add pre-release parameter to self-update
  • a8939ed add schedule-priority parameter
  • 641dc91 add working directory to crontab line
  • 08141a3 allow verbose flag after the command
  • 2a6b0c0 display systemd timer status in a nicer way also display log >= “warning” instead of “err”
  • a19f124 move other-flags before the sub-sections
  • 967c4a8 refactor show command to remove empty lines
  • 6544052 search for systemctl instead of systemd
  • c406e80 upgrade clog package

Docker images

  • docker pull creativeprojects/resticprofile:latest
  • docker pull creativeprojects/resticprofile:0.11.0

v0.10.1 (2020-11-17)

This update changes the way systemd units are generated: These used to be of type oneshot but it means they can be started more than once. They have been changed to notify which is like simple but resticprofile is notifying systemd that the schedule has started and stopped.

To change the type on your existing schedules, you’ll need to run the commands unschedule and schedule again.

Changelog

  • ba711f2 change systemd unit to “notify”
  • 9f2edb8 update packages verify self-update binary using checksums.txt file
  • cff661b update restic to 0.11.0 in docker image

v0.10.0 (2020-11-12)

New resticprofile version with bug fixes and a big new feature:

  • fix –exclude and –iexclude parameters in unix environment not properly escaping ? and * characters
  • don’t escape (space) if already escaped
  • self-update now works on ARM CPUs (like raspberry pi)
  • configuration files can embed Go templates for modularity

I think it is now feature complete for a version 1.0 😄

Changelog

  • e2047e0 Escape exclude globs passed to /sh
  • be97fae add proper character escaping: - count the number of \ in front - do not escape it again if it was already escaped
  • b30cbe5 change self-updater library to work with ARM cpus
  • 8d95c1e detect arm version from runtime internal register
  • c9b0c34 new version of the updater
  • 604da32 put armv7 target back
  • 836cbae squash merge of branch config-single-template: add templating and variable expansion
  • f177173 upgrade clog package
  • 48cf85e upgrade selfupdate package

v0.9.2 (2020-11-02)

A few minor features and bug fixes:

  • add version command
  • add force-inactive-lock flag in profiles

Changelog

v0.9.1 (2020-08-03)

Two new features in this release:

  • add a few environment variables when running scripts (run-before, run-after, run-after-fail)
  • add a status file generated after running a profile (to send to some monitoring software)

Changelog

  • 58ecde0 Merge branch run-after-fail
  • 05afb52 merge from branch status-file

v0.9.0 (2020-07-29)

A few new big features in this release:

  • add --dry-run flag
  • redirect console to a file with --log (for running in the background)
  • generate random keys with generate-random command
  • schedule/unschedule profiles automatically with command schedule/unschedule (also status to check a scheduled task)

Changelog

  • c0c067e add SUDO_USER to systemd environment
  • 67e24a4 add dry-run flag
  • b31c4cf add file logger
  • ef87550 add journalctl to status output
  • ba9d132 add schedule documentation to README
  • db4fd20 add schedule parameter in config
  • 05d0308 add windows task scheduler
  • 2a03874 create plist file for darwin
  • b1c12ab create system job on darwin
  • c73ccb3 full implementation of systemd user unit
  • fce69a1 generate random keys
  • 5ddecf0 generate schedule for darwin
  • 4647e6e implement schedule-log
  • 631038d move logger into external package
  • 43e7f81 only ask for the user password once
  • af04717 redirect terminal when elevated mode
  • b049747 send message from elevated process to parent process via some simple http calls
  • 106ea1b send terminal output remotely
  • fbac6f4 sudo trick in the example configuration
  • 0465a19 system daemon with launchd
  • 8538fce systemd user/system

v0.8.3 (2020-07-13)

Bug fixing release:

Changelog

  • 4e08c7b add restic flags for forget and mount commands
  • 74d36fe add test to verify forget flags are loaded for all configuration types
  • 4b1d937 version 0.8.3

v0.8.2 (2020-07-09)

This is a bug fixing release:

  • in the configuration file, some strings containing a comma were split into an array of strings. This is now fixed.

Changelog

  • 7a7836f add table of contents
  • 0bf1400 build 0.8.2
  • 1ecc090 document new features in README
  • e2f1d8e remove armv7 packages from goreleaser
  • 3183207 remove default decode hooks (which can do funny things with tags)

v0.8.1 (2020-07-02)

This is mostly a bug fixing release:

  • allow for spaces in directories and files (these were ignored before and were messing up the command line)
  • add a show command to see the profile details (mostly for debugging really)
  • add a --format flag to specify the type of configuration file format (if you want to use a different extension)

Changelog

  • d2ebc7b add –format flag to specify the config format
  • 85a5d59 add command ‘show’ to display profile properties
  • b3349bc add show command to help
  • 3ac1afa allow spaces in directories and files
  • 52c74cd change expected structure in unit tests
  • 1006fcf display correct XDG directories in error message
  • 98706fb update dependencies

v0.8.0 (2020-06-29)

This version is introducing a few new features:

  • experimental support for HCL configuration files
  • a configuration file with no extension is searched using all supported file extensions: -c profiles would either load profiles.conf, profiles.yaml, profiles.toml, profiles.json or profiles.hcl
  • a new global parameter to check available memory before starting a profile (default is 100MB)

Changelog

  • d74a5d6 Initial support for HCL configuration file
  • 1e645e2 Refactoring y/n question
  • 4aa7bcb add OS & ARCH to panic data
  • 5e417b3 add missing build info to docker image
  • 254377b add note with self-updating on linux/arm
  • b1a7674 add safeguard to prevent running restic when memory is running low: “min-memory” in “global”
  • e10a2ab add section on where to locate configuration file
  • 8c548bf bump version
  • 742f6dd example of configuration in HCL
  • 69a4385 refactor configuration as a dependency as opposed to a global
  • 8efe9c4 search for configuration file without an extension resticprofile will load the first file with a valid extension (conf, yaml, toml, json, hcl)
  • 428fdb8 update xdg paths in documentation

v0.7.1 (2020-06-25)

This a maintenance release:

  • add a new parameter run-after-fail which is running the shell commands after any kind of failure (during other commands or during restic execution)
  • a minor breaking change if you use the repository auto-initialization, it will now run after the run-before scripts. It makes more sense this way (in case you mount your backup disks in run-before for example)

Changelog

  • 2321bf9 add raspberry pi to supported platforms
  • 1efeb81 add run-after-fail parameter to run shell commands after a restic command failed. the auto initialization of a repository now happens after the “run-before” scripts (in version 0.7.0 it was happening before)
  • 80ddc06 detect panic and display a nice message asking the user to post details on github
  • 9ca91d0 fix self-update not working on windows
  • d32c172 run self-update command with no configuration file

v0.7.0 (2020-06-24)

This is a maintenance release:

  • fixing a defect when starting a backup with no command definition for backup
  • adding two new options to run scripts before and after a profile (not just backup like before)
  • implementation of a new module to create systemd units. More to come on future releases

Changelog

  • a8ff142 Bump up version
  • b499f76 Fix update confirmation message
  • d71f45f Refactoring resticprofile commands
  • ab527c0 add goreleaser target to build for raspberry pi
  • 744ac5b initial support for systemd
  • 88cb74f run shell commands before and after a profile. In previous versions, you could only run commands before and after a backup
  • c4c8d9a stop creating empty configuration file at XDG config location

v0.6.1 (2020-04-22)

Changelog

  • b17b23c Activate self-update flag
  • 713e429 Add .tar.gz binary for mac os
  • 4c4c0d8 Build tar.gz for windows so we can download it from git bash
  • a2fe661 Clean up lock file after pressing CTRL-C
  • 2a76a04 Fix nil pointer panic when retention not defined

v0.6.0 (2020-04-07)

Complete rewrite of resticprofile in go:

  • I tried python and I wasn’t particularly impressed
  • I tried go and I loved it (also that’s what all the cool kids do nowadays)

The default configuration profiles.conf is still expected to be in TOML format. But now, resticprofile also supports YAML and JSON file format. Simply feed a .toml, .json or a .yaml file to select the desired format.

The configuration file from the previous versions remains unchanged. There are two additions to it:

  • priority flags: acts like nice on unixes and now available on all platforms
  • lock flag to avoid running two profiles at the same time (this is a local lock)

v0.5.2 (2019-09-26)

Accept a repository from the environment instead of the configuration file

v0.5.1 (2019-08-12)

  • Add a timestamp before each message
  • Use colours more readable on light console
  • Add a flag to disable all ansi characters (to redirect the output to a file)

v0.5.0 (2019-06-26)

Adds support for stdin file stream

v0.4.1 Beta (2019-06-26)

  • Adding ‘mount’ command support
  • Allow chained inheritance of environment variables
  • Allow inheritance on ‘retention’ section

v0.4.0 Beta (2019-06-25)

  • Removing ugly KeyboardInterrupt message when you hit CTRL-C
  • Allow the host flag to be a boolean (if set to yes the current hostname will be used)
  • Also search for restic binary under Windows (like the chocolatey bin folder)
  • Adding two options to check repository before and/or after a backup: ‘check-before’ and ‘check-after’
  • Run shell commands before and after a backup: ‘run-before’ and ‘run-after’

v0.3.0 Beta (2019-06-24)

  • Added “groups”: ability to define groups of profiles to run at once

v0.2.0 Beta (2019-06-24)

  • Fixed compatibility with Windows
  • Fixed defect in profile inheritance

v0.1.0 Beta (2019-06-24)

First ‘usable’ version of resticprofile!

Please note the groups are not working yet (groups can run multiple configuration in one command)