From fa26467415bf26e4ddcb08c2d382732c9794f265 Mon Sep 17 00:00:00 2001 From: Fred Date: Thu, 27 Feb 2025 23:26:12 +0000 Subject: [PATCH 1/8] rephrasing home and getting started pages --- docs/content/_index.md | 65 +++++++++---------- .../configuration/getting_started/index.md | 52 +++++++-------- .../content/schedules/task_scheduler/index.md | 10 +-- docs/hugo.toml | 44 ++++++++++++- docs/version.toml | 2 + examples/dev.yaml | 12 ++++ 6 files changed, 119 insertions(+), 66 deletions(-) create mode 100644 docs/version.toml diff --git a/docs/content/_index.md b/docs/content/_index.md index 74ff5e8aa..536280e8d 100644 --- a/docs/content/_index.md +++ b/docs/content/_index.md @@ -6,41 +6,38 @@ description: Configuration profiles manager for restic backup Configuration profiles manager for [restic backup](https://restic.net/) -**resticprofile** is the missing link between a configuration file and restic backup. Creating a configuration file for restic has been [discussed before](https://github.com/restic/restic/issues/16), but seems to be a very low priority right now. +**resticprofile** bridges the gap between a configuration file and restic backup. Although creating a configuration file for restic has been [discussed](https://github.com/restic/restic/issues/16), it remains a low priority. With resticprofile: -* You no longer need to remember command parameters and environment variables -* You can create multiple profiles inside one configuration file -* A profile can inherit all the options from another profile -* You can run the forget command before or after a backup (in a section called *retention*) -* You can check a repository before or after a backup -* You can create groups of profiles that will run sequentially -* You can run [shell commands]({{% relref "/configuration/run_hooks" %}}) before or after running a profile: useful if you need to mount and unmount your backup disk for example -* You can run a [shell command]({{% relref "/configuration/run_hooks" %}}) if an error occurred (at any time) -* You can send a backup stream via _stdin_ -* You can start restic at a lower or higher priority (Priority Class in Windows, *nice* in all unixes) and/or _ionice_ (only available on Linux) -* It can check that you have [enough memory]({{% relref "/usage/memory" %}}) before starting a backup. (I've had some backups that literally killed a server with swap disabled) -* You can generate cryptographically secure random keys to use as a restic [key file]({{% relref "/usage/keyfile" %}}) -* You can easily [schedule]({{% relref "/schedules" %}}) backups, retentions and checks (works for *systemd*, *crond*, *launchd* and *windows task scheduler*) -* You can generate a simple [status file]({{% relref "/status" %}}) to send to some monitoring software and make sure your backups are running fine -* You can use a template syntax in your configuration file -* You can generate scheduled tasks using *crond* -* Get backup statistics in your [status file]({{% relref "/status" %}}) -* Automatically clear up [stale locks]({{% relref "/usage/locks" %}}) -* Export a [prometheus]({{% relref "/status/prometheus" %}}) file after a backup, or send the report to a push gateway automatically -* **[new for v0.17.0]** Run shell commands in the background when non fatal errors are detected from restic -* **[new for v0.18.0]** Send messages to [HTTP hooks]({{% relref "/configuration/http_hooks" %}}) before, after a successful or failed job (backup, forget, check, prune, copy) -* **[new for v0.18.0]** Automatically initialize the secondary repository using `copy-chunker-params` flag -* **[new for v0.18.0]** Send resticprofile logs to a syslog server -* **[new for v0.19.0]** Preventing your system from idle sleeping -* **[new for v0.21.0]** See the help from both restic and resticprofile via the `help` command or `-h` flag -* **[new for v0.24.0]** Don't schedule a job when the system is running on battery -* **[new for v0.29.0]** Scheduling a group of profiles is finally available (configuration `v2` only) - -The configuration file accepts various formats: -* [TOML](https://github.com/toml-lang/toml) : configuration file with extension _.toml_ and _.conf_ to keep compatibility with versions before 0.6.0 -* [JSON](https://en.wikipedia.org/wiki/JSON) : configuration file with extension _.json_ -* [YAML](https://en.wikipedia.org/wiki/YAML) : configuration file with extension _.yaml_ -* [HCL](https://github.com/hashicorp/hcl): configuration file with extension _.hcl_ +* No need to remember command parameters and environment variables +* Create multiple profiles in one configuration file +* Profiles can inherit options from other profiles +* Run the forget command before or after a backup (in a section called *retention*) +* Check a repository before or after a backup +* Create groups of profiles to run sequentially +* Run [shell commands]({{% relref "/configuration/run_hooks" %}}) before or after running a profile, useful for mounting and unmounting backup disks +* Run a [shell command]({{% relref "/configuration/run_hooks" %}}) if an error occurs +* Send a backup stream via _stdin_ +* Start restic at different [priorities]({{% relref "/configuration/priority" %}}) (Priority Class in Windows, *nice* in Unix, and/or _ionice_ in Linux) +* Check for [enough memory]({{% relref "/usage/memory" %}}) before starting a backup +* Generate cryptographically secure random keys for a restic [key file]({{% relref "/usage/keyfile" %}}) +* Easily [schedule]({{% relref "/schedules" %}}) backups, retentions, and checks (supports *systemd*, *crond*, *launchd*, and *Windows Task Scheduler*) +* Generate a simple [status file]({{% relref "/status" %}}) for monitoring software to ensure backups are running smoothly +* Use [template syntax]({{% relref "/configuration/templates" %}}) in your configuration file +* Automatically clear [stale locks]({{% relref "/usage/locks" %}}) +* Export a [prometheus]({{% relref "/status/prometheus" %}}) file after a backup or send the report to a push gateway +* Run shell commands in the background when non-fatal errors are detected +* Send messages to [HTTP hooks]({{% relref "/configuration/http_hooks" %}}) before, after a successful or failed job (backup, forget, check, prune, copy) +* Automatically [initialize the secondary repository]({{% relref "/configuration/copy" %}}) using the `copy-chunker-params` flag +* Send resticprofile [logs]({{% relref "/configuration/logs" %}}) to a syslog server +* Prevent the system from [idle sleeping]({{% relref "/configuration/sleep" %}}) +* View help for both restic and resticprofile via the `help` command or `-h` flag +* Avoid scheduling a job when the system is on battery +* **[new for v0.29.0]** Schedule a group of profiles (configuration `v2` only) +The configuration file supports various formats: +* [TOML](https://github.com/toml-lang/toml): files with extensions _.toml_ and _.conf_ (for compatibility with versions before 0.6.0) +* [JSON](https://en.wikipedia.org/wiki/JSON): files with extension _.json_ +* [YAML](https://en.wikipedia.org/wiki/YAML): files with extension _.yaml_ +* [HCL](https://github.com/hashicorp/hcl): files with extension _.hcl_ \ No newline at end of file diff --git a/docs/content/configuration/getting_started/index.md b/docs/content/configuration/getting_started/index.md index 145c82cf0..dc2c967dc 100644 --- a/docs/content/configuration/getting_started/index.md +++ b/docs/content/configuration/getting_started/index.md @@ -5,61 +5,61 @@ weight: 2 ## Prerequisite -**resticprofile** is one of many automation tools for restic, also called a *wrapper*. +**resticprofile** is an automation tool for restic, also known as a *wrapper*. -In a nutshell, **resticprofile** provides a configuration file and a runner that will generate all the necessary calls to **restic**. +In short, **resticprofile** provides a configuration file and a runner that generates all necessary calls to **restic**. Unless you're using the **resticprofile** [Docker image]({{% relref "/installation/docker/index.html" %}}), you need to have **restic** [installed on your machine](https://restic.readthedocs.io/en/stable/). -## Choose your favourite format +## Choose Your Favorite Format -**resticprofile** configuration file can be written in: -* [TOML](https://github.com/toml-lang/toml) : configuration file with extension _.toml_ or _.conf_ -* [YAML](https://en.wikipedia.org/wiki/YAML) : configuration file with extension _.yaml_ -* [JSON](https://en.wikipedia.org/wiki/JSON) : configuration file with extension _.json_ +The **resticprofile** configuration file can be written in: +* [TOML](https://github.com/toml-lang/toml): configuration file with extension _.toml_ or _.conf_ +* [YAML](https://en.wikipedia.org/wiki/YAML): configuration file with extension _.yaml_ +* [JSON](https://en.wikipedia.org/wiki/JSON): configuration file with extension _.json_ * [HCL](https://github.com/hashicorp/hcl): configuration file with extension _.hcl_ We recommend using either TOML or YAML. -JSON is fine for auto generated configurations but is not the easiest format for a human to read and write. +JSON is suitable for auto-generated configurations but is not the easiest format for humans to read and write. -HCL can be interesting if you already use a tool from the Hashicorp stack otherwise that's yet another format to learn. +HCL can be useful if you already use a tool from the Hashicorp stack; otherwise, it's another format to learn. -## Configure your text editor +## Configure Your Text Editor -We're going to show you how to get documentation and auto-completion for the **resticprofile** configuration using [Visual Studio Code](https://code.visualstudio.com/). +We'll show you how to get documentation and auto-completion for the **resticprofile** configuration using [Visual Studio Code](https://code.visualstudio.com/). -You can use any other editor that recognise the [JSON schema]({{% relref "/configuration/jsonschema" %}}). The same JSON schema can be used for JSON, TOML and YAML file formats. +You can use any other editor that recognizes the [JSON schema]({{% relref "/configuration/jsonschema" %}}). The same JSON schema can be used for JSON, TOML, and YAML file formats. ### TOML -In Visual Studio Code, you need to install an extension that supports completion and syntax validation using a JSON schema. +In Visual Studio Code, install an extension that supports completion and syntax validation using a JSON schema. -For example you can install the [Even Better TOML](https://marketplace.visualstudio.com/items?itemName=tamasfe.even-better-toml) extension: +For example, install the [Even Better TOML](https://marketplace.visualstudio.com/items?itemName=tamasfe.even-better-toml) extension: ![TOML extension]({{< absolute "configuration/getting_started/TOML.png" nohtml >}}) ### YAML -Same for YAML: in Visual Studio Code you need to install an extension like the one [provided by Red Hat](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml) to understand the shape of your configuration file. +For YAML, install an extension like the one [provided by Red Hat](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml) in Visual Studio Code to understand the shape of your configuration file. ![YAML extension]({{< absolute "configuration/getting_started/YAML.png" nohtml >}}) ## Write your first configuration file -The configuration file is essentially a list of profiles containing a list of commands and flags. +The configuration file lists profiles containing commands and flags. A profile defines: -* a restic repository (flag `repository`) -* how to access your restic repository (like `password-file`) -* a list of commands (like `backup`): - * which files to include in a backup (flag `source`) - * when to backup them (we'll see that later) - * any other restic flags you would add to the command line (like `verbose`) +* a restic repository (`repository` flag) +* how to access your restic repository (e.g., `password-file`) +* a list of commands (e.g., `backup`): + * files to include in a backup (`source` flag) + * when to back them up (details later) + * other restic flags for the command line (e.g., `verbose`) -In this example, we're going to call our profile `default`. You don't need to specify the profile name on the command line when using this name (`default`). +In this example, we'll call our profile `default`. You don't need to specify the profile name on the command line when using `default`. -Create a file named `profiles` with the extension of your choice (.toml, .yaml, .hcl or .json) +Create a file named `profiles` with an extension of your choice (.toml, .yaml, .hcl, or .json). {{< tabs groupid="config-with-json" >}} {{% tab title="toml" %}} @@ -138,7 +138,7 @@ default { ## Generate a secure password -**resticprofile** has a handy command that can generate a [cryptographically secure password file]({{% relref "/usage/keyfile" %}}) for you: +**resticprofile** can generate a [secure password file]({{% relref "/usage/keyfile" %}}) for you: ```shell resticprofile generate --random-key > password.txt @@ -146,7 +146,7 @@ resticprofile generate --random-key > password.txt ## Initialize your repository -Now that you have a password file, you can initialize your restic repository: +With the password file, initialize your restic repository: ```shell resticprofile init diff --git a/docs/content/schedules/task_scheduler/index.md b/docs/content/schedules/task_scheduler/index.md index 244b80732..597a8e526 100644 --- a/docs/content/schedules/task_scheduler/index.md +++ b/docs/content/schedules/task_scheduler/index.md @@ -9,21 +9,21 @@ Windows 10 is the minimum version supported for scheduling. ## Elevated mode -If you have any schedule profile with the permission set to `system`, resticprofile will need to run in elevated permission mode to be able to set up the schedules. +If your schedule profile has the permission set to `system`, resticprofile needs to run in elevated mode to set up the schedules. -In general, you shouldn't worry about it: resticprofile will restart itself in elevated mode. You'll see the popup window asking to give resticprofile elevated privileges. +Generally, you don't need to worry about this: resticprofile will restart itself in elevated mode. You'll see a popup window asking for elevated privileges. ### resticprofile is blocked from restarting in elevated mode ![Unwanted software]({{< absolute "schedules/task_scheduler/unwanted_my_ass.png" nohtml >}}) -There's nothing I can do on my side to prevent this, but to buy a $300 certificate. Developer certificates for Windows are way more expensive than certificates for macOS. If you know any other way for free open-source software, please let me know. +I can't prevent this without buying a developer certificate. If you know any free or cheap certificate for open-source software, please let me know. #### Solution You'll need to start an elevated shell yourself. -- Right click on `Command Prompt`, `Windows Terminal` or `Windows Powershell` (just pick your favorite) +- Right-click on `Command Prompt`, `Windows Terminal`, or `Windows Powershell` (choose your favorite) - Click on `Run as administrator` ![Start elevated command prompt]({{< absolute "schedules/task_scheduler/runas.png" nohtml >}}) @@ -33,4 +33,4 @@ It's easy to spot a terminal window opened with Administrator privileges: ![Administrator prefix]({{< absolute "schedules/task_scheduler/administrator.png" nohtml >}}) > [!IMPORTANT] -> By running the schedule command, Windows might also just delete _resticprofile.exe_ instead, by pretending it's a threat. I suppose installing a third party backup tool is kind-of a threat to their OneDrive backup offering after all. +> Running the schedule command might cause Windows to delete _resticprofile.exe_, treating it as a threat. diff --git a/docs/hugo.toml b/docs/hugo.toml index c4905ac21..bb40d1ba3 100644 --- a/docs/hugo.toml +++ b/docs/hugo.toml @@ -11,7 +11,6 @@ publishdir = "../public/" home = [ "html", "rss" ] [params] - # themeVariant = [ "relearn-dark", "relearn-light" ] themeVariant = [ { identifier = 'relearn-auto', name = 'Relearn Light/Dark', auto = [] }, { identifier = 'relearn-light' }, @@ -21,6 +20,43 @@ publishdir = "../public/" externalLinkTarget = "_blank" ordersectionsby = "weight" + +[[params.sidebarmenus]] + disableTitle = true + identifier = 'home' + main = true + pageRef = '' + type = 'page' + +[[params.sidebarmenus]] + disableTitle = false + identifier = 'version' + main = false + type = 'menu' + +[[params.sidebarmenus]] + disableTitle = false + identifier = 'shortcuts' + main = false + type = 'menu' + +[menu] + [[menu.version]] + name = 'A Menu Title for the Whole Menu' + +# make a list of versions here, or use this trick with one page per version: https://dannorth.net/hugo-redirects/#the-solution + [[menu.version]] + name = 'A Menu Entry Title for Child 1' + parent = 'Parent' + url = 'https://example.com/1' + weight = 1 + + [[menu.version]] + name = 'A Menu Entry Title for Child 2' + parent = 'Parent' + url = 'https://example.com/2' + weight = 2 + [[menu.shortcuts]] name = " Tags" url = "/tags" @@ -56,3 +92,9 @@ publishdir = "../public/" # - set `style` to a predefined style name noClasses = false # style = "tango" + +[image] + errorlevel = 'warning' + +[link] + errorlevel = 'warning' diff --git a/docs/version.toml b/docs/version.toml new file mode 100644 index 000000000..68e404cfc --- /dev/null +++ b/docs/version.toml @@ -0,0 +1,2 @@ +[params] + version = "v0.30.0" diff --git a/examples/dev.yaml b/examples/dev.yaml index 292d27bdf..6db6ca4c9 100644 --- a/examples/dev.yaml +++ b/examples/dev.yaml @@ -345,3 +345,15 @@ nopwd: initialize: true repository: "/Volumes/RAMDisk/{{ .Profile.Name }}" insecure-no-password: true + +with-env: + inherit: default + env-file: .env + backup: + send-before: + method: POST + url: https://healthcheck.example.org/ping/$VAR1/${PROFILE_NAME}/start + send-after: + body-template: send-body-template.json + method: POST + url: https://healthcheck.example.org/ping/$VAR2/${PROFILE_NAME}/end From 73b6c8b6bd925dc922e632a290aeb59b55d3d9dc Mon Sep 17 00:00:00 2001 From: Fred Date: Fri, 28 Feb 2025 12:02:27 +0000 Subject: [PATCH 2/8] add release notes generated from github releases --- docs/content/changelog.md | 1046 +++++++++++++++++++++++++++++++++++++ 1 file changed, 1046 insertions(+) create mode 100644 docs/content/changelog.md diff --git a/docs/content/changelog.md b/docs/content/changelog.md new file mode 100644 index 000000000..0e191da83 --- /dev/null +++ b/docs/content/changelog.md @@ -0,0 +1,1046 @@ +--- +archetype: chapter +pre: 8. +title: Release Notes +weight: 8 +--- + +# 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 +* [e2297a6f4f0f03a1733177db1dc950c6e05ddd88](https://github.com/creativeprojects/resticprofile/commit/e2297a6f4f0f03a1733177db1dc950c6e05ddd88) add logrotate to docker image #440 +* [37c9aef3032005a88ed006059432a2baddc97ab6](https://github.com/creativeprojects/resticprofile/commit/37c9aef3032005a88ed006059432a2baddc97ab6) upgrade package - CVE-2024-45337 +* [467b82ee1eade497c9d23c0dfe69a889143dc807](https://github.com/creativeprojects/resticprofile/commit/467b82ee1eade497c9d23c0dfe69a889143dc807) upgrade packages + + + +# 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 +* [fb6c7a2fbb0d3a955a0cdb53e87c58a32a532022](https://github.com/creativeprojects/resticprofile/commit/fb6c7a2fbb0d3a955a0cdb53e87c58a32a532022) Escape config file name in schedule parameters (#420) +* [1d3ec32e293c9d3c4918df7ea7bd6a62a3eb2168](https://github.com/creativeprojects/resticprofile/commit/1d3ec32e293c9d3c4918df7ea7bd6a62a3eb2168) Fix scheduling arguments (#423) +* [62c5c6472f4ef5462bbafc02d6e75d7684a40abf](https://github.com/creativeprojects/resticprofile/commit/62c5c6472f4ef5462bbafc02d6e75d7684a40abf) Global json schema (auto versioning) (#412) +* [2a34ea77e5d4c8367436e2ebb2c7cf82973f39a5](https://github.com/creativeprojects/resticprofile/commit/2a34ea77e5d4c8367436e2ebb2c7cf82973f39a5) Group schedule (#418) +* [830d0fd4f8313a0de7a04ffd48d2b44cc797929a](https://github.com/creativeprojects/resticprofile/commit/830d0fd4f8313a0de7a04ffd48d2b44cc797929a) Setup systemd priority (#409) +* [62f311814f0f1e034942f3bf6a95dff3590597e3](https://github.com/creativeprojects/resticprofile/commit/62f311814f0f1e034942f3bf6a95dff3590597e3) doc: upgrade hugo theme +* [da03de768a30c8d6656be5cce39d35a9e42e0817](https://github.com/creativeprojects/resticprofile/commit/da03de768a30c8d6656be5cce39d35a9e42e0817) fix deprecated option in goreleaser config + + + +# 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 +* [57d1439ea33e6da9a5e19010cf2fc95b951ea27e](https://github.com/creativeprojects/resticprofile/commit/57d1439ea33e6da9a5e19010cf2fc95b951ea27e) Fix for continue-on-error broken in 0.26.0 (#407) +* [ccccfa2d0a56432af84dda9f3833e760e30d6a48](https://github.com/creativeprojects/resticprofile/commit/ccccfa2d0a56432af84dda9f3833e760e30d6a48) Linters (#397) +* [249fd41b3d8e1af034594c9617bc3145a6a3e29a](https://github.com/creativeprojects/resticprofile/commit/249fd41b3d8e1af034594c9617bc3145a6a3e29a) add base url on json schema (#408) +* [b254503506c76700eb74868677facaed250a7730](https://github.com/creativeprojects/resticprofile/commit/b254503506c76700eb74868677facaed250a7730) add misspell linter +* [7dcb41bf248da13a58d551838cca7eb2412eaaf2](https://github.com/creativeprojects/resticprofile/commit/7dcb41bf248da13a58d551838cca7eb2412eaaf2) fix bullet points from restic man (#398) +* [4181d9e809539ede5b2d73aeb682fa9324e493db](https://github.com/creativeprojects/resticprofile/commit/4181d9e809539ede5b2d73aeb682fa9324e493db) fix overflow integer conversion lint warning from gosec (#399) +* [22317937234ab678c899c15ac7b1900dc7fe4b54](https://github.com/creativeprojects/resticprofile/commit/22317937234ab678c899c15ac7b1900dc7fe4b54) generate JSON schema for restic 0.17 +* [0ad1b68504f41fc6e7ca11297683ec4e2dc02ff8](https://github.com/creativeprojects/resticprofile/commit/0ad1b68504f41fc6e7ca11297683ec4e2dc02ff8) prepare next release +* [3612b519aa5c0e41ae302ce5fda136db288e0837](https://github.com/creativeprojects/resticprofile/commit/3612b519aa5c0e41ae302ce5fda136db288e0837) use goreleaser v2 + + + +# 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: + +```yaml +check-repo-profile: + inherit: default + + run-before: + - "echo DOW=`date +\"%u\"` >> {{ env }}" + + check: + read-data-subset: "$DOW/7" + +``` + +## Changelog +* [3b42e4a](https://github.com/creativeprojects/resticprofile/commit/3b42e4a) Add contributed docs for protected configuration on Windows (#394) +* [1e80d02](https://github.com/creativeprojects/resticprofile/commit/1e80d02) Restic 0.17 (#396) +* [eb8c721](https://github.com/creativeprojects/resticprofile/commit/eb8c721) build with go 1.23 +* [1df3711](https://github.com/creativeprojects/resticprofile/commit/1df3711) convert priority value to lowercase +* [d74c521](https://github.com/creativeprojects/resticprofile/commit/d74c521) fix panic when sending on closed handler +* [49add79](https://github.com/creativeprojects/resticprofile/commit/49add79) refactoring of arguments generation (#387) +* [cff446b](https://github.com/creativeprojects/resticprofile/commit/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](https://github.com/creativeprojects/resticprofile/commit/a615444) fix creation of mock binaries during unit tests (#375) +* [c9f87ec](https://github.com/creativeprojects/resticprofile/commit/c9f87ec) fix documentation for release +* [eb13003](https://github.com/creativeprojects/resticprofile/commit/eb13003) fix regression with temporary log file (#386) +* [abf35a7](https://github.com/creativeprojects/resticprofile/commit/abf35a7) prepare next release +* [854f6c9](https://github.com/creativeprojects/resticprofile/commit/854f6c9) refactor unit tests on package lock (#374) +* [ffffabf](https://github.com/creativeprojects/resticprofile/commit/ffffabf) remove flaky test +* [5cfdca2](https://github.com/creativeprojects/resticprofile/commit/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](https://github.com/creativeprojects/resticprofile/issues/334) + +### allow controlling command output redirection + +Allow redirection of the console messages to a log file or to syslog. + +More information: [#343](https://github.com/creativeprojects/resticprofile/pull/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](https://github.com/creativeprojects/resticprofile/commit/1bbac2a) Add "--stderr" to redirect console to stderr (for "cat" and "dump") (#353) +* [0598026](https://github.com/creativeprojects/resticprofile/commit/0598026) Add documentation on how to ingest resticprofile stats into telegraf (#366) +* [f9b5dac](https://github.com/creativeprojects/resticprofile/commit/f9b5dac) Add option to set working directory for restic backup (#354) +* [00360a2](https://github.com/creativeprojects/resticprofile/commit/00360a2) Fix group priority (#339) +* [a05ad39](https://github.com/creativeprojects/resticprofile/commit/a05ad39) Relative source followup: Evaluate symlinks (#355) +* [56f20af](https://github.com/creativeprojects/resticprofile/commit/56f20af) Squashed commit of the following: (#259) +* [6b00c2c](https://github.com/creativeprojects/resticprofile/commit/6b00c2c) add "profile" flag as an alias for "name" (#357) +* [6da0317](https://github.com/creativeprojects/resticprofile/commit/6da0317) also search configuration from ~/.config/resticprofile on macOS (#370) +* [5739b13](https://github.com/creativeprojects/resticprofile/commit/5739b13) crond: add support for crontab file only (on any OS) (#289) +* [9719411](https://github.com/creativeprojects/resticprofile/commit/9719411) don't replace header value in stringifyHeaders (#327) +* [2a7d5fc](https://github.com/creativeprojects/resticprofile/commit/2a7d5fc) drop-ins: move systemd drop-ins into unified schedule struct (#341) +* [7e03741](https://github.com/creativeprojects/resticprofile/commit/7e03741) drop-ins: transparent timer drop-in support (#340) +* [9b2bd8c](https://github.com/creativeprojects/resticprofile/commit/9b2bd8c) env-file: Implement dotenv and {{env}} support (#323) +* [16f5dc5](https://github.com/creativeprojects/resticprofile/commit/16f5dc5) fix remaining unit tests failing in Windows (#360) +* [3b8613e](https://github.com/creativeprojects/resticprofile/commit/3b8613e) fixed link to config reference / global section (#349) +* [5fad1cb](https://github.com/creativeprojects/resticprofile/commit/5fad1cb) flags: added "RESTICPROFILE_{FLAGNAME}" env vars (#335) +* [85d5afc](https://github.com/creativeprojects/resticprofile/commit/85d5afc) log: allow controlling command output redirection (#343) +* [e5b17d3](https://github.com/creativeprojects/resticprofile/commit/e5b17d3) restic: use repository-file if the repo flag contains a password (#336) +* [4255868](https://github.com/creativeprojects/resticprofile/commit/4255868) schedule: added unified schedule config struct (#333) +* [667180e](https://github.com/creativeprojects/resticprofile/commit/667180e) syslog: local syslog and stdout redirection (#344) +* [e93874d](https://github.com/creativeprojects/resticprofile/commit/e93874d) build with go 1.22 and macOs arm64 (#317) +* [e6eed3d](https://github.com/creativeprojects/resticprofile/commit/e6eed3d) update test to pass on Windows 11 (#359) +* [655e9c5](https://github.com/creativeprojects/resticprofile/commit/655e9c5) upgrade packages (CVE-2024-24786) (#347) +* [08a01c4](https://github.com/creativeprojects/resticprofile/commit/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](https://github.com/creativeprojects/resticprofile/commit/2ab1f3a) Add pre-built binary targets to release pipeline (#324) +* [233e4b8](https://github.com/creativeprojects/resticprofile/commit/233e4b8) Add prometheus label to build info (#319) +* [b1b03db](https://github.com/creativeprojects/resticprofile/commit/b1b03db) Change priority warning message (#310) +* [9eba431](https://github.com/creativeprojects/resticprofile/commit/9eba431) Fix missing fields in show command (#315) +* [a9273f8](https://github.com/creativeprojects/resticprofile/commit/a9273f8) Merge pull request #312 from creativeprojects/nightly +* [15004f9](https://github.com/creativeprojects/resticprofile/commit/15004f9) Restrict copy command to a list of snapshots (#291) +* [1c076dc](https://github.com/creativeprojects/resticprofile/commit/1c076dc) add separate goreleaser config for rebuilding the docker image only (#309) +* [bbb3760](https://github.com/creativeprojects/resticprofile/commit/bbb3760) add snapshot build to docker hub +* [8aebd28](https://github.com/creativeprojects/resticprofile/commit/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) + +```yaml +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](https://github.com/creativeprojects/resticprofile/commit/765c2af) Add `prometheus-push-format` to allow selecting text format (#281) +* [ae9554a](https://github.com/creativeprojects/resticprofile/commit/ae9554a) Pass context to own commands and profile runner (#280) +* [fccc05b](https://github.com/creativeprojects/resticprofile/commit/fccc05b) Remove rclone binary in make clean target (#283) +* [0871d28](https://github.com/creativeprojects/resticprofile/commit/0871d28) Trying new configuration for CodeQL (#306) +* [1317f60](https://github.com/creativeprojects/resticprofile/commit/1317f60) Upgrade packages (#307) +* [63f8faf](https://github.com/creativeprojects/resticprofile/commit/63f8faf) chore: prep next release & allow deployment to fail on PR +* [3d72803](https://github.com/creativeprojects/resticprofile/commit/3d72803) chore: various fixes (#285) +* [952380f](https://github.com/creativeprojects/resticprofile/commit/952380f) doc: add information about windows path in variables +* [f346571](https://github.com/creativeprojects/resticprofile/commit/f346571) doc: add various missing information (#278) +* [1b3292c](https://github.com/creativeprojects/resticprofile/commit/1b3292c) logging: allow to setup default log output in global (#277) +* [99484bf](https://github.com/creativeprojects/resticprofile/commit/99484bf) macOS: create LaunchAgents folder if it doesn't exist +* [37dcf84](https://github.com/creativeprojects/resticprofile/commit/37dcf84) profile: support source with "-" (dash) prefix (#276) +* [a1b7840](https://github.com/creativeprojects/resticprofile/commit/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](https://scoop.sh/#/apps?q=resticprofile)! thanks @hgraeber +- detect if the host is running on battery and cancel an action depending on how much battery is left - see [schedule section](https://creativeprojects.github.io/resticprofile/schedules/configuration/index.html#schedule-ignore-on-battery) +- bug fixes (see changelog) + +## Changelog +* [ac99302](https://github.com/creativeprojects/resticprofile/commit/ac99302) Allow to interrupt the wait for a lock (#249) +* [b08ac73](https://github.com/creativeprojects/resticprofile/commit/b08ac73) Detect if running on battery (#235) +* [1e6d07a](https://github.com/creativeprojects/resticprofile/commit/1e6d07a) Docs for installation from scoop (#268) +* [0d73c2b](https://github.com/creativeprojects/resticprofile/commit/0d73c2b) Fix doc shortcodes (#271) +* [f5e751c](https://github.com/creativeprojects/resticprofile/commit/f5e751c) Template: Reduce log level for `Getwd()` failures (#251) +* [e20973e](https://github.com/creativeprojects/resticprofile/commit/e20973e) systemd: prevent paging in systemd schedules (#270) +* [bcfaaa7](https://github.com/creativeprojects/resticprofile/commit/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](https://github.com/creativeprojects/resticprofile/commit/b0767ad) Added {{ "data" | base64 }} & {{ "data" | hex }} (#213) +* [b00c8a0](https://github.com/creativeprojects/resticprofile/commit/b00c8a0) Allow to set a base-dir inside the profile (#183) (#192) +* [4b2ea31](https://github.com/creativeprojects/resticprofile/commit/4b2ea31) Fix 194: Allow to set "keep-tag", β€œtag” & β€œgroup-by” as empty string (#220) +* [10057d4](https://github.com/creativeprojects/resticprofile/commit/10057d4) Fix 218: Args filter must not remove paths (#222) +* [0c8c985](https://github.com/creativeprojects/resticprofile/commit/0c8c985) Fix 223, 230: Escape args and absolute restic path for pwsh (#224) +* [2bf0d28](https://github.com/creativeprojects/resticprofile/commit/2bf0d28) Fix 242: iexclude-file not converted to abs path (#243) +* [6cbfdb3](https://github.com/creativeprojects/resticprofile/commit/6cbfdb3) Fix links for versioned JSON schema files (#244) +* [fc66fab](https://github.com/creativeprojects/resticprofile/commit/fc66fab) Fix schedule tests (#236) +* [304e418](https://github.com/creativeprojects/resticprofile/commit/304e418) Fix: Do not add `--tag` for `tag: true` (#221) +* [82fccdb](https://github.com/creativeprojects/resticprofile/commit/82fccdb) Restic: Add restic v16 release (#238) +* [3f4e0bf](https://github.com/creativeprojects/resticprofile/commit/3f4e0bf) Restic: Fixed unit tests for restic v16 (#239) +* [ba9297a](https://github.com/creativeprojects/resticprofile/commit/ba9297a) Retention: Align host filter with "backup" (#227) +* [347501d](https://github.com/creativeprojects/resticprofile/commit/347501d) Schedule: Capture `os.Environ` on schedule creation (#212) +* [9c05157](https://github.com/creativeprojects/resticprofile/commit/9c05157) Support `lock-wait` with `--lock-retry` in restic 0.16 (#240) +* [6cc332d](https://github.com/creativeprojects/resticprofile/commit/6cc332d) Support build when GOPATH is unset / fix mockery build warning (#234) +* [3476fbc](https://github.com/creativeprojects/resticprofile/commit/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: + +```yaml +prometheus-push-job: "${COMMAND}" +``` + +## Fixes: +* Complicated scheduling on Windows was sometimes setting up a random delay before starting a job + +## Changelog +* [c00fc9a](https://github.com/creativeprojects/resticprofile/commit/c00fc9a) New option to specify Prometheus Pushgateway job name (#193) +* [0c7405f](https://github.com/creativeprojects/resticprofile/commit/0c7405f) Templates: Add `map`/`splitR`/`contains`/`matches` (#197) +* [7545bbf](https://github.com/creativeprojects/resticprofile/commit/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](https://creativeprojects.github.io/resticprofile/configuration/jsonschema/index.html). + +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](https://github.com/creativeprojects/resticprofile/commit/487db0b) Fix #187: homedir/env-vars in repo and other flags (#188) +* [b78d1a0](https://github.com/creativeprojects/resticprofile/commit/b78d1a0) Fix #189: completion of own commands (#190) +* [b6a98ef](https://github.com/creativeprojects/resticprofile/commit/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](https://creativeprojects.github.io/resticprofile/configuration/jsonschema/index.html). + +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](https://github.com/creativeprojects/resticprofile/commit/683bf78) Add variables `.OS` and `.Arch` to all templates (#181) +* [74b0c46](https://github.com/creativeprojects/resticprofile/commit/74b0c46) Allow config encoding in UTF16 and ISO88591 +* [d6a51ad](https://github.com/creativeprojects/resticprofile/commit/d6a51ad) Enhanced: Catch any --help & --dry-run (http only) (#178) +* [3f5cdc6](https://github.com/creativeprojects/resticprofile/commit/3f5cdc6) Feature: JSON schema (#103) & generated reference +* [1aad0fb](https://github.com/creativeprojects/resticprofile/commit/1aad0fb) Fix #164: Failure on uppercase mixin names +* [e65f9bc](https://github.com/creativeprojects/resticprofile/commit/e65f9bc) Implement tempDir and log without locking (#168) (#174) +* [f2a9c04](https://github.com/creativeprojects/resticprofile/commit/f2a9c04) Make URL and header confidential in HTTP-hook (#175) +* [e069b77](https://github.com/creativeprojects/resticprofile/commit/e069b77) Restic: Add restic v15 release (#180) +* [d2e789c](https://github.com/creativeprojects/resticprofile/commit/d2e789c) add build tag to disable self-update (#184) +* [8231087](https://github.com/creativeprojects/resticprofile/commit/8231087) add suppport for user_logged_on (#160) +* [f782ef5](https://github.com/creativeprojects/resticprofile/commit/f782ef5) build with go 1.20 +* [bd3813a](https://github.com/creativeprojects/resticprofile/commit/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](https://github.com/creativeprojects/resticprofile/commit/51634c8) Merge pull request #154 from jkellerer/ft-151 +* [00ab266](https://github.com/creativeprojects/resticprofile/commit/00ab266) New docker image (#161) +* [fce7165](https://github.com/creativeprojects/resticprofile/commit/fce7165) Run-hooks for all non-conflicting commands (#151) +* [7439620](https://github.com/creativeprojects/resticprofile/commit/7439620) add QEMU for github agent to build an arm64 image +* [7c2f806](https://github.com/creativeprojects/resticprofile/commit/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](https://creativeprojects.github.io/resticprofile/configuration/run_hooks/index.html). +- 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](https://github.com/creativeprojects/resticprofile/commit/c360880) Add --help to own commands (e.g. generate --help) (#139) +* [1edf995](https://github.com/creativeprojects/resticprofile/commit/1edf995) Add last backup time to prometheus metrics (#132) +* [8a70e7b](https://github.com/creativeprojects/resticprofile/commit/8a70e7b) Config: Add run before/after/fail to more restic commands than backup (#138) +* [419e66c](https://github.com/creativeprojects/resticprofile/commit/419e66c) Continue profile in group on error (#149) +* [a880b44](https://github.com/creativeprojects/resticprofile/commit/a880b44) Fixes zsh completion script (use of outdated CLI) (#150) +* [49c4920](https://github.com/creativeprojects/resticprofile/commit/49c4920) Prevent system from idle sleeping (#140) +* [d4c1032](https://github.com/creativeprojects/resticprofile/commit/d4c1032) add devcontainer config +* [0c43c2c](https://github.com/creativeprojects/resticprofile/commit/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](https://github.com/creativeprojects/resticprofile/commit/7ba20ad) Add http hooks (#114) +* [fb62876](https://github.com/creativeprojects/resticprofile/commit/fb62876) Add support for syslog (#127) +* [a5c1147](https://github.com/creativeprojects/resticprofile/commit/a5c1147) Allow to choose `shell` in global config (#112) +* [d492d7d](https://github.com/creativeprojects/resticprofile/commit/d492d7d) ConfigV2: Mixins (#115) +* [ca9a418](https://github.com/creativeprojects/resticprofile/commit/ca9a418) ConfigV2: Replace list params - fix #108 (#113) +* [2ed3045](https://github.com/creativeprojects/resticprofile/commit/2ed3045) Initialise copy repository using --copy-chunker-params (#117) +* [43ce0be](https://github.com/creativeprojects/resticprofile/commit/43ce0be) Mixins: List merging & inheritance update (#121) +* [1b8774c](https://github.com/creativeprojects/resticprofile/commit/1b8774c) add binary dir in path and .BinaryDir template var (#134) +* [eb70a8a](https://github.com/creativeprojects/resticprofile/commit/eb70a8a) add goreleaser config to also build arm64 images +* [35d07ee](https://github.com/creativeprojects/resticprofile/commit/35d07ee) add rclone to docker image #131 +* [0381942](https://github.com/creativeprojects/resticprofile/commit/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](https://github.com/creativeprojects/resticprofile/commit/83e423e) Add run flag to to be able to have profile and job name as one argument (#89) +* [20a3b81](https://github.com/creativeprojects/resticprofile/commit/20a3b81) Added "generate" command to create resources (#110) +* [1d2b214](https://github.com/creativeprojects/resticprofile/commit/1d2b214) Added missing cmds that filter by host, tag & path +* [8cef157](https://github.com/creativeprojects/resticprofile/commit/8cef157) Feature: Take command output as stdin for restic (#98) +* [fe336ff](https://github.com/creativeprojects/resticprofile/commit/fe336ff) Fix and unit tests for #91 +* [ad511c4](https://github.com/creativeprojects/resticprofile/commit/ad511c4) Fix config includes when any pattern has no match (#95) +* [3e856ce](https://github.com/creativeprojects/resticprofile/commit/3e856ce) Implemented stream-error callbacks (#99) +* [3688b90](https://github.com/creativeprojects/resticprofile/commit/3688b90) Merge pull request #101 from jkellerer/fix-common-args +* [4f13930](https://github.com/creativeprojects/resticprofile/commit/4f13930) Merge pull request #94 from jkellerer/ft-add-missing-commands +* [a72f635](https://github.com/creativeprojects/resticprofile/commit/a72f635) Only pass common CLI args to command hooks [#100] +* [7553a24](https://github.com/creativeprojects/resticprofile/commit/7553a24) Shell completion (#90) +* [ea52e93](https://github.com/creativeprojects/resticprofile/commit/ea52e93) display a neat stack trace on panic +* [ff13660](https://github.com/creativeprojects/resticprofile/commit/ff13660) fix for profiles command not showing inherited commands fixes second part of #97 +* [69dd965](https://github.com/creativeprojects/resticprofile/commit/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](https://github.com/creativeprojects/resticprofile/commit/e18906b) Fix args are multiplied when commands are retried (#84) +* [358f060](https://github.com/creativeprojects/resticprofile/commit/358f060) Fix for #88 with unit tests +* [b011437](https://github.com/creativeprojects/resticprofile/commit/b011437) don't inherit profile description +* [16ad4b1](https://github.com/creativeprojects/resticprofile/commit/16ad4b1) prepare for future versions of the configuration +* [da8c255](https://github.com/creativeprojects/resticprofile/commit/da8c255) show schedules separately +* [358a5db](https://github.com/creativeprojects/resticprofile/commit/358a5db) simple implementation of a config file v2 +* [e2bd2cf](https://github.com/creativeprojects/resticprofile/commit/e2bd2cf) update packages + + + +# v0.16.0 (2021-10-18) + +This release adds a few new features: + +- support for [splitting configuration into multiple files](https://github.com/creativeprojects/resticprofile/tree/v0.16.0#includes) +- support for `run-finally` that [runs shell commands every time after restic](https://github.com/creativeprojects/resticprofile/tree/v0.16.0#run-commands-before-after-success-or-after-failure) +- ability to [define your own systemd unit and timer files](https://github.com/creativeprojects/resticprofile/tree/v0.16.0#how-to-change-the-default-systemd-unit-and-timer-file-using-a-template) (from go templates) +- support for the restic `copy` [command](https://github.com/creativeprojects/resticprofile/tree/v0.16.0#special-case-for-the-copy-command-section) +- fix for some cosmetic issues with `crond` scheduler + +## Changelog + +* [1fa7d48](https://github.com/creativeprojects/resticprofile/commit/1fa7d48) Add support for copy command (#73) +* [271c128](https://github.com/creativeprojects/resticprofile/commit/271c128) Change codecov uploader to use GitHub Action v2 (#79) +* [85fcc20](https://github.com/creativeprojects/resticprofile/commit/85fcc20) Optional: Allow disabling path in retention with 'false' (#67) +* [8773899](https://github.com/creativeprojects/resticprofile/commit/8773899) Scheduler refactoring (#76) +* [48c822c](https://github.com/creativeprojects/resticprofile/commit/48c822c) Support "run-finally" in backup-section & profile (#70) +* [ac13d06](https://github.com/creativeprojects/resticprofile/commit/ac13d06) Supporting config `includes` (e.g. `profiles.d`) (#65) +* [245a440](https://github.com/creativeprojects/resticprofile/commit/245a440) Systemd template (#75) +* [122620e](https://github.com/creativeprojects/resticprofile/commit/122620e) add tests on crontab +* [0dad5a8](https://github.com/creativeprojects/resticprofile/commit/0dad5a8) crontab RemoveJob returns error if the entry was not found +* [ff2fc1f](https://github.com/creativeprojects/resticprofile/commit/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: + +```yaml +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](https://github.com/creativeprojects/resticprofile/commit/abf0b00) Add support for prometheus export and push (#57) +* [37a69d7](https://github.com/creativeprojects/resticprofile/commit/37a69d7) Added "{{.TmpDir}}" to TemplateData (#62) +* [8218e70](https://github.com/creativeprojects/resticprofile/commit/8218e70) Feature: Hide confidential values in output (#58) +* [0be5d5f](https://github.com/creativeprojects/resticprofile/commit/0be5d5f) Resolve glob expressions in backup sources (#63) +* [8cc2574](https://github.com/creativeprojects/resticprofile/commit/8cc2574) Shell escape (#60) +* [34f693c](https://github.com/creativeprojects/resticprofile/commit/34f693c) Update non-confidential values to support shell.Args (#68) +* [0841959](https://github.com/creativeprojects/resticprofile/commit/0841959) add Hostname pre-defined variable to template resolver (#55) +* [f58116b](https://github.com/creativeprojects/resticprofile/commit/f58116b) add description field in profile section +* [0f9b21e](https://github.com/creativeprojects/resticprofile/commit/0f9b21e) build with go 1.17 +* [16308e9](https://github.com/creativeprojects/resticprofile/commit/16308e9) don't send status summary in dry-run +* [88052c6](https://github.com/creativeprojects/resticprofile/commit/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](https://github.com/creativeprojects/resticprofile/commit/4686dd2) use shell to resolve special paths with ~ +* [823304a](https://github.com/creativeprojects/resticprofile/commit/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](https://github.com/creativeprojects/resticprofile/commit/331b710) Added resticprofile flags --no-lock & --lock-wait (#33) +* [7fc5b3a](https://github.com/creativeprojects/resticprofile/commit/7fc5b3a) Summary from plain output when not run in terminal (#48) +* [b7edeb5](https://github.com/creativeprojects/resticprofile/commit/b7edeb5) Updated contrib script systemd/send-error.sh (#49) +* [fa42cf2](https://github.com/creativeprojects/resticprofile/commit/fa42cf2) add macOS arm64 target to install.sh script +* [a87f76d](https://github.com/creativeprojects/resticprofile/commit/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](https://github.com/creativeprojects/resticprofile/commit/cab8909) add Homebrew Tap (#45) +* [794f404](https://github.com/creativeprojects/resticprofile/commit/794f404) add github token in config +* [5e06dbd](https://github.com/creativeprojects/resticprofile/commit/5e06dbd) fix test too slow on build agent +* [2f79a46](https://github.com/creativeprojects/resticprofile/commit/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](https://github.com/creativeprojects/resticprofile/commit/02e6414) Increase test coverage (#40) +* [d64dc4f](https://github.com/creativeprojects/resticprofile/commit/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](https://github.com/creativeprojects/resticprofile/commit/8968e33) add RESTIC_STDERR env variable to run-after-fail +* [6b7dea4](https://github.com/creativeprojects/resticprofile/commit/6b7dea4) quick implementation of ignore warning +* [833d24d](https://github.com/creativeprojects/resticprofile/commit/833d24d) quick mock to do some testing with a fake restic +* [3c54cc6](https://github.com/creativeprojects/resticprofile/commit/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](https://github.com/creativeprojects/resticprofile/commit/237a87f) Add backup statistics in status file (#36) +* [6622a39](https://github.com/creativeprojects/resticprofile/commit/6622a39) Added fail env variable ERROR_COMMANDLINE (#32) +* [0887354](https://github.com/creativeprojects/resticprofile/commit/0887354) Added support for --all to status & (un)schedule (#31) +* [16e6c19](https://github.com/creativeprojects/resticprofile/commit/16e6c19) Enhanced "unschedule" to remove all possible jobs (#28) +* [47489a2](https://github.com/creativeprojects/resticprofile/commit/47489a2) add profile name when running status --all +* [01ae05a](https://github.com/creativeprojects/resticprofile/commit/01ae05a) fix an issue where status --all was stopping at the first profile with no schedule +* [f50131b](https://github.com/creativeprojects/resticprofile/commit/f50131b) update goreleaser config to v0.154 +* [c700d60](https://github.com/creativeprojects/resticprofile/commit/c700d60) upgrade packages +* [4569f0d](https://github.com/creativeprojects/resticprofile/commit/4569f0d) upgrade self-update library +* [7eb663d](https://github.com/creativeprojects/resticprofile/commit/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: + +- detect systemd using `systemctl`: https://github.com/creativeprojects/resticprofile/issues/25 +- add **experimental** support for scheduling tasks with **crond** +- add support for background tasks on Mac OS via a new `schedule-priority` parameter +- add support for scheduling `forget` and `prune` commands + +## Deprecation + +Scheduling in the `retention` section is now deprecated, please use the `forget` section instead (https://github.com/creativeprojects/resticprofile/issues/23) + +## Changelog + +* [be72758](https://github.com/creativeprojects/resticprofile/commit/be72758) Add background types and low priorityIO to launchd plist (#19) +* [d0de636](https://github.com/creativeprojects/resticprofile/commit/d0de636) Add support for scheduling forget (#26) +* [ec02310](https://github.com/creativeprojects/resticprofile/commit/ec02310) Added prune as supported, schedulable command (#24) +* [8f48acf](https://github.com/creativeprojects/resticprofile/commit/8f48acf) Move CI build from Travis CI to GitHub Actions +* [2e1564a](https://github.com/creativeprojects/resticprofile/commit/2e1564a) Refactoring schedule package (#30) +* [8fd7a2e](https://github.com/creativeprojects/resticprofile/commit/8fd7a2e) Schedule priority (#29) +* [b8c3e6a](https://github.com/creativeprojects/resticprofile/commit/b8c3e6a) add crond support to unix targets (except macOS) +* [3e93f45](https://github.com/creativeprojects/resticprofile/commit/3e93f45) add deprecation notice for schedule on retention +* [4b815f2](https://github.com/creativeprojects/resticprofile/commit/4b815f2) add docker build to goreleaser +* [5830a34](https://github.com/creativeprojects/resticprofile/commit/5830a34) add pre-release parameter to self-update +* [a8939ed](https://github.com/creativeprojects/resticprofile/commit/a8939ed) add schedule-priority parameter +* [641dc91](https://github.com/creativeprojects/resticprofile/commit/641dc91) add working directory to crontab line +* [08141a3](https://github.com/creativeprojects/resticprofile/commit/08141a3) allow verbose flag after the command +* [2a6b0c0](https://github.com/creativeprojects/resticprofile/commit/2a6b0c0) display systemd timer status in a nicer way also display log >= "warning" instead of "err" +* [a19f124](https://github.com/creativeprojects/resticprofile/commit/a19f124) move other-flags before the sub-sections +* [967c4a8](https://github.com/creativeprojects/resticprofile/commit/967c4a8) refactor show command to remove empty lines +* [6544052](https://github.com/creativeprojects/resticprofile/commit/6544052) search for systemctl instead of systemd +* [c406e80](https://github.com/creativeprojects/resticprofile/commit/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](https://github.com/creativeprojects/resticprofile/commit/ba711f2) change systemd unit to "notify" +* [9f2edb8](https://github.com/creativeprojects/resticprofile/commit/9f2edb8) update packages verify self-update binary using checksums.txt file +* [cff661b](https://github.com/creativeprojects/resticprofile/commit/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](https://github.com/creativeprojects/resticprofile/commit/e2047e0) Escape `exclude` globs passed to `/sh` +* [be97fae](https://github.com/creativeprojects/resticprofile/commit/be97fae) add proper character escaping: - count the number of \ in front - do not escape it again if it was already escaped +* [b30cbe5](https://github.com/creativeprojects/resticprofile/commit/b30cbe5) change self-updater library to work with ARM cpus +* [8d95c1e](https://github.com/creativeprojects/resticprofile/commit/8d95c1e) detect arm version from runtime internal register +* [c9b0c34](https://github.com/creativeprojects/resticprofile/commit/c9b0c34) new version of the updater +* [604da32](https://github.com/creativeprojects/resticprofile/commit/604da32) put armv7 target back +* [836cbae](https://github.com/creativeprojects/resticprofile/commit/836cbae) squash merge of branch config-single-template: add templating and variable expansion +* [f177173](https://github.com/creativeprojects/resticprofile/commit/f177173) upgrade clog package +* [48cf85e](https://github.com/creativeprojects/resticprofile/commit/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 + +* [ca6ff07](https://github.com/creativeprojects/resticprofile/commit/ca6ff07) Add "option" in example configurations in README and azure.conf fixes https://github.com/creativeprojects/resticprofile/issues/13 +* [06f98e9](https://github.com/creativeprojects/resticprofile/commit/06f98e9) Add version command +* [f3aa7b9](https://github.com/creativeprojects/resticprofile/commit/f3aa7b9) add tests on set and get PID from lock file +* [cd10c9d](https://github.com/creativeprojects/resticprofile/commit/cd10c9d) remove openbsd from goreleaser library github.com/shirou/gopsutil cannot be compiled for openbsd +* [8c07f35](https://github.com/creativeprojects/resticprofile/commit/8c07f35) squash merge of branch pid: should fix https://github.com/creativeprojects/resticprofile/issues/14 +* [618be92](https://github.com/creativeprojects/resticprofile/commit/618be92) use go 1.15 for ci builds +* [94f0ef1](https://github.com/creativeprojects/resticprofile/commit/94f0ef1) write down child PIDs in lock file + + + + +# 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](https://github.com/creativeprojects/resticprofile/commit/58ecde0) Merge branch run-after-fail +* [05afb52](https://github.com/creativeprojects/resticprofile/commit/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](https://github.com/creativeprojects/resticprofile/commit/c0c067e) add SUDO_USER to systemd environment +* [67e24a4](https://github.com/creativeprojects/resticprofile/commit/67e24a4) add dry-run flag +* [b31c4cf](https://github.com/creativeprojects/resticprofile/commit/b31c4cf) add file logger +* [ef87550](https://github.com/creativeprojects/resticprofile/commit/ef87550) add journalctl to status output +* [ba9d132](https://github.com/creativeprojects/resticprofile/commit/ba9d132) add schedule documentation to README +* [db4fd20](https://github.com/creativeprojects/resticprofile/commit/db4fd20) add schedule parameter in config +* [05d0308](https://github.com/creativeprojects/resticprofile/commit/05d0308) add windows task scheduler +* [2a03874](https://github.com/creativeprojects/resticprofile/commit/2a03874) create plist file for darwin +* [b1c12ab](https://github.com/creativeprojects/resticprofile/commit/b1c12ab) create system job on darwin +* [c73ccb3](https://github.com/creativeprojects/resticprofile/commit/c73ccb3) full implementation of systemd user unit +* [fce69a1](https://github.com/creativeprojects/resticprofile/commit/fce69a1) generate random keys +* [5ddecf0](https://github.com/creativeprojects/resticprofile/commit/5ddecf0) generate schedule for darwin +* [4647e6e](https://github.com/creativeprojects/resticprofile/commit/4647e6e) implement schedule-log +* [631038d](https://github.com/creativeprojects/resticprofile/commit/631038d) move logger into external package +* [43e7f81](https://github.com/creativeprojects/resticprofile/commit/43e7f81) only ask for the user password once +* [af04717](https://github.com/creativeprojects/resticprofile/commit/af04717) redirect terminal when elevated mode +* [b049747](https://github.com/creativeprojects/resticprofile/commit/b049747) send message from elevated process to parent process via some simple http calls +* [106ea1b](https://github.com/creativeprojects/resticprofile/commit/106ea1b) send terminal output remotely +* [fbac6f4](https://github.com/creativeprojects/resticprofile/commit/fbac6f4) sudo trick in the example configuration +* [0465a19](https://github.com/creativeprojects/resticprofile/commit/0465a19) system daemon with launchd +* [8538fce](https://github.com/creativeprojects/resticprofile/commit/8538fce) systemd user/system + + + + +# v0.8.3 (2020-07-13) + +Bug fixing release: +- restic flags were not generated for commands `forget` and `mount` https://github.com/creativeprojects/resticprofile/issues/9 + +## Changelog + +* [4e08c7b](https://github.com/creativeprojects/resticprofile/commit/4e08c7b) add restic flags for forget and mount commands +* [74d36fe](https://github.com/creativeprojects/resticprofile/commit/74d36fe) add test to verify forget flags are loaded for all configuration types +* [4b1d937](https://github.com/creativeprojects/resticprofile/commit/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](https://github.com/creativeprojects/resticprofile/commit/7a7836f) add table of contents +* [0bf1400](https://github.com/creativeprojects/resticprofile/commit/0bf1400) build 0.8.2 +* [1ecc090](https://github.com/creativeprojects/resticprofile/commit/1ecc090) document new features in README +* [e2f1d8e](https://github.com/creativeprojects/resticprofile/commit/e2f1d8e) remove armv7 packages from goreleaser +* [3183207](https://github.com/creativeprojects/resticprofile/commit/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](https://github.com/creativeprojects/resticprofile/commit/d2ebc7b) add --format flag to specify the config format +* [85a5d59](https://github.com/creativeprojects/resticprofile/commit/85a5d59) add command 'show' to display profile properties +* [b3349bc](https://github.com/creativeprojects/resticprofile/commit/b3349bc) add show command to help +* [3ac1afa](https://github.com/creativeprojects/resticprofile/commit/3ac1afa) allow spaces in directories and files +* [52c74cd](https://github.com/creativeprojects/resticprofile/commit/52c74cd) change expected structure in unit tests +* [1006fcf](https://github.com/creativeprojects/resticprofile/commit/1006fcf) display correct XDG directories in error message +* [98706fb](https://github.com/creativeprojects/resticprofile/commit/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](https://github.com/creativeprojects/resticprofile/commit/d74a5d6) Initial support for HCL configuration file +* [1e645e2](https://github.com/creativeprojects/resticprofile/commit/1e645e2) Refactoring y/n question +* [4aa7bcb](https://github.com/creativeprojects/resticprofile/commit/4aa7bcb) add OS & ARCH to panic data +* [5e417b3](https://github.com/creativeprojects/resticprofile/commit/5e417b3) add missing build info to docker image +* [254377b](https://github.com/creativeprojects/resticprofile/commit/254377b) add note with self-updating on linux/arm +* [b1a7674](https://github.com/creativeprojects/resticprofile/commit/b1a7674) add safeguard to prevent running restic when memory is running low: "min-memory" in "global" +* [e10a2ab](https://github.com/creativeprojects/resticprofile/commit/e10a2ab) add section on where to locate configuration file +* [8c548bf](https://github.com/creativeprojects/resticprofile/commit/8c548bf) bump version +* [742f6dd](https://github.com/creativeprojects/resticprofile/commit/742f6dd) example of configuration in HCL +* [69a4385](https://github.com/creativeprojects/resticprofile/commit/69a4385) refactor configuration as a dependency as opposed to a global +* [8efe9c4](https://github.com/creativeprojects/resticprofile/commit/8efe9c4) search for configuration file without an extension resticprofile will load the first file with a valid extension (conf, yaml, toml, json, hcl) +* [428fdb8](https://github.com/creativeprojects/resticprofile/commit/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](https://github.com/creativeprojects/resticprofile/commit/2321bf9) add raspberry pi to supported platforms +* [1efeb81](https://github.com/creativeprojects/resticprofile/commit/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](https://github.com/creativeprojects/resticprofile/commit/80ddc06) detect panic and display a nice message asking the user to post details on github +* [9ca91d0](https://github.com/creativeprojects/resticprofile/commit/9ca91d0) fix self-update not working on windows +* [d32c172](https://github.com/creativeprojects/resticprofile/commit/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](https://github.com/creativeprojects/resticprofile/commit/a8ff142) Bump up version +* [b499f76](https://github.com/creativeprojects/resticprofile/commit/b499f76) Fix update confirmation message +* [d71f45f](https://github.com/creativeprojects/resticprofile/commit/d71f45f) Refactoring resticprofile commands +* [ab527c0](https://github.com/creativeprojects/resticprofile/commit/ab527c0) add goreleaser target to build for raspberry pi +* [744ac5b](https://github.com/creativeprojects/resticprofile/commit/744ac5b) initial support for systemd +* [88cb74f](https://github.com/creativeprojects/resticprofile/commit/88cb74f) run shell commands before and after a profile. In previous versions, you could only run commands before and after a backup +* [c4c8d9a](https://github.com/creativeprojects/resticprofile/commit/c4c8d9a) stop creating empty configuration file at XDG config location + + + + +# v0.6.1 (2020-04-22) + + + +## Changelog + +* [b17b23c](https://github.com/creativeprojects/resticprofile/commit/b17b23c) Activate self-update flag +* [713e429](https://github.com/creativeprojects/resticprofile/commit/713e429) Add .tar.gz binary for mac os +* [4c4c0d8](https://github.com/creativeprojects/resticprofile/commit/4c4c0d8) Build tar.gz for windows so we can download it from git bash +* [a2fe661](https://github.com/creativeprojects/resticprofile/commit/a2fe661) Clean up lock file after pressing CTRL-C +* [2a76a04](https://github.com/creativeprojects/resticprofile/commit/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) + + From e2d4c6371e556fd894bb81e88e7421f0877fb66c Mon Sep 17 00:00:00 2001 From: Fred Date: Fri, 28 Feb 2025 17:43:45 +0000 Subject: [PATCH 3/8] add pageversions shortcode --- docs/hugo.toml | 17 ----------------- docs/layouts/shortcodes/pageversions.html | 9 +++++++++ 2 files changed, 9 insertions(+), 17 deletions(-) create mode 100644 docs/layouts/shortcodes/pageversions.html diff --git a/docs/hugo.toml b/docs/hugo.toml index bb40d1ba3..f6726a0bf 100644 --- a/docs/hugo.toml +++ b/docs/hugo.toml @@ -40,23 +40,6 @@ publishdir = "../public/" main = false type = 'menu' -[menu] - [[menu.version]] - name = 'A Menu Title for the Whole Menu' - -# make a list of versions here, or use this trick with one page per version: https://dannorth.net/hugo-redirects/#the-solution - [[menu.version]] - name = 'A Menu Entry Title for Child 1' - parent = 'Parent' - url = 'https://example.com/1' - weight = 1 - - [[menu.version]] - name = 'A Menu Entry Title for Child 2' - parent = 'Parent' - url = 'https://example.com/2' - weight = 2 - [[menu.shortcuts]] name = " Tags" url = "/tags" diff --git a/docs/layouts/shortcodes/pageversions.html b/docs/layouts/shortcodes/pageversions.html new file mode 100644 index 000000000..58375d806 --- /dev/null +++ b/docs/layouts/shortcodes/pageversions.html @@ -0,0 +1,9 @@ +
+
Other versions of this page
+
    +{{ range .Params }} +
  • + {{ . }} +
    • +{{ end }} +
\ No newline at end of file From f546376a5b90c9facdc686500bf57b55807246d0 Mon Sep 17 00:00:00 2001 From: Fred Date: Fri, 28 Feb 2025 17:58:39 +0000 Subject: [PATCH 4/8] add flag to ignore checking documentation on some files --- Makefile | 2 +- config/checkdoc/main.go | 10 +++++++++- 2 files changed, 10 insertions(+), 2 deletions(-) diff --git a/Makefile b/Makefile index 54c6dfc05..18ca86318 100644 --- a/Makefile +++ b/Makefile @@ -292,7 +292,7 @@ syslog-ng: checkdoc: @echo "[*] $@" - $(GOCMD) run ./config/checkdoc -r docs/content + $(GOCMD) run ./config/checkdoc -r docs/content -i changelog.md .PHONY: checklinks checklinks: diff --git a/config/checkdoc/main.go b/config/checkdoc/main.go index 8e608d7b6..2e888187f 100644 --- a/config/checkdoc/main.go +++ b/config/checkdoc/main.go @@ -39,9 +39,11 @@ func main() { var root string var verbose bool + var ignoreFiles []string pflag.StringVarP(&root, "root", "r", "", "root directory where to search for documentation files (*.md)") pflag.StringVarP(&tempDir, "temp-dir", "t", "", "temporary directory to store extracted configuration files") pflag.BoolVarP(&verbose, "verbose", "v", false, "display more information") + pflag.StringSliceVarP(&ignoreFiles, "ignore", "i", nil, "ignore files") pflag.Parse() level := clog.LevelInfo @@ -68,12 +70,18 @@ func main() { if d.IsDir() { return nil } + simplePath := strings.TrimPrefix(path, wd) + for _, ignore := range ignoreFiles { + if strings.Contains(simplePath, ignore) { + clog.Infof("* ignoring file %s", simplePath) + return nil + } + } base := filepath.Base(path) ext := filepath.Ext(base) if ext != ".md" { return nil } - simplePath := strings.TrimPrefix(path, wd) clog.Infof("* file %s", simplePath) if !extractConfigurationSnippets(path) { exitCode = 1 From 3754e3bf58ebc34e1672bc24e82092a27d5d8961 Mon Sep 17 00:00:00 2001 From: Fred Date: Fri, 28 Feb 2025 17:59:55 +0000 Subject: [PATCH 5/8] also ignore in CI --- .github/workflows/doc.yml | 2 +- .github/workflows/release-doc.yml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/doc.yml b/.github/workflows/doc.yml index 766e3d910..8bff99007 100644 --- a/.github/workflows/doc.yml +++ b/.github/workflows/doc.yml @@ -28,7 +28,7 @@ jobs: go-version: ~1.23 - name: Check configuration snippets in documentation - run: go run ./config/checkdoc -r docs/content + run: go run ./config/checkdoc -r docs/content -i changelog.md shell: bash - name: Build JSON schema & config reference diff --git a/.github/workflows/release-doc.yml b/.github/workflows/release-doc.yml index 96e03cdcc..8ae543cc6 100644 --- a/.github/workflows/release-doc.yml +++ b/.github/workflows/release-doc.yml @@ -22,7 +22,7 @@ jobs: go-version: ~1.23 - name: Check configuration snippets in documentation - run: go run ./config/checkdoc -r docs/content + run: go run ./config/checkdoc -r docs/content -i changelog.md shell: bash - name: Build JSON schema & config reference From 2da601d24233a5c34630360fe9d5de989dd08f89 Mon Sep 17 00:00:00 2001 From: Fred Date: Fri, 28 Feb 2025 20:42:19 +0000 Subject: [PATCH 6/8] changelog: remove links to old documentation --- .github/workflows/doc.yml | 2 +- .github/workflows/release-doc.yml | 2 +- Makefile | 2 +- docs/content/changelog.md | 8 ++++---- 4 files changed, 7 insertions(+), 7 deletions(-) diff --git a/.github/workflows/doc.yml b/.github/workflows/doc.yml index 8bff99007..8da0b833e 100644 --- a/.github/workflows/doc.yml +++ b/.github/workflows/doc.yml @@ -55,7 +55,7 @@ jobs: with: url: "https://${{ env.BRANCH_NAME }}.resticprofile.pages.dev/" pages_path: ./public/ - cmd_params: '--exclude="(linux.die.net|stackoverflow.com)" --buffer-size=8192 --max-connections=10 --color=always --skip-tls-verification --header="User-Agent:curl/7.54.0" --timeout=20' + cmd_params: '--exclude="(linux.die.net|stackoverflow.com|scoop.sh)" --buffer-size=8192 --max-connections=10 --color=always --skip-tls-verification --header="User-Agent:curl/7.54.0" --timeout=20' - name: Publish to pages.dev continue-on-error: true # secrets are not set for PRs from forks diff --git a/.github/workflows/release-doc.yml b/.github/workflows/release-doc.yml index 8ae543cc6..faeabf52e 100644 --- a/.github/workflows/release-doc.yml +++ b/.github/workflows/release-doc.yml @@ -49,7 +49,7 @@ jobs: with: url: https://creativeprojects.github.io/resticprofile/ pages_path: ./www/ - cmd_params: '--exclude="(linux.die.net|stackoverflow.com)" --buffer-size=8192 --max-connections-per-host=5 --rate-limit=5 --timeout=20 --header="User-Agent:curl/7.54.0" --skip-tls-verification' + cmd_params: '--exclude="(linux.die.net|stackoverflow.com|scoop.sh)" --buffer-size=8192 --max-connections-per-host=5 --rate-limit=5 --timeout=20 --header="User-Agent:curl/7.54.0" --skip-tls-verification' - name: Deploy to GitHub Pages uses: peaceiris/actions-gh-pages@v4 diff --git a/Makefile b/Makefile index 18ca86318..922b3e815 100644 --- a/Makefile +++ b/Makefile @@ -297,7 +297,7 @@ checkdoc: .PHONY: checklinks checklinks: @echo "[*] $@" - muffet -b 8192 --exclude="(linux.die.net|stackoverflow.com)" http://localhost:1313/resticprofile/ + muffet -b 8192 --max-connections=10 --exclude="(linux.die.net|stackoverflow.com|scoop.sh)" http://localhost:1313/resticprofile/ .PHONY: lint lint: $(GOBIN)/golangci-lint diff --git a/docs/content/changelog.md b/docs/content/changelog.md index 0e191da83..f9b1abb08 100644 --- a/docs/content/changelog.md +++ b/docs/content/changelog.md @@ -509,10 +509,10 @@ New maintenance version, with bug fixes: This release adds a few new features: -- support for [splitting configuration into multiple files](https://github.com/creativeprojects/resticprofile/tree/v0.16.0#includes) -- support for `run-finally` that [runs shell commands every time after restic](https://github.com/creativeprojects/resticprofile/tree/v0.16.0#run-commands-before-after-success-or-after-failure) -- ability to [define your own systemd unit and timer files](https://github.com/creativeprojects/resticprofile/tree/v0.16.0#how-to-change-the-default-systemd-unit-and-timer-file-using-a-template) (from go templates) -- support for the restic `copy` [command](https://github.com/creativeprojects/resticprofile/tree/v0.16.0#special-case-for-the-copy-command-section) +- 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 From 8609847be29b65a7e47fa0252b92a13f0a4600dd Mon Sep 17 00:00:00 2001 From: Fred Date: Fri, 28 Feb 2025 20:46:43 +0000 Subject: [PATCH 7/8] fixes from markdownlint --- docs/content/_index.md | 8 ++++---- .../content/configuration/getting_started/index.md | 14 +++++++------- 2 files changed, 11 insertions(+), 11 deletions(-) diff --git a/docs/content/_index.md b/docs/content/_index.md index 536280e8d..896aae554 100644 --- a/docs/content/_index.md +++ b/docs/content/_index.md @@ -37,7 +37,7 @@ With resticprofile: * **[new for v0.29.0]** Schedule a group of profiles (configuration `v2` only) The configuration file supports various formats: -* [TOML](https://github.com/toml-lang/toml): files with extensions _.toml_ and _.conf_ (for compatibility with versions before 0.6.0) -* [JSON](https://en.wikipedia.org/wiki/JSON): files with extension _.json_ -* [YAML](https://en.wikipedia.org/wiki/YAML): files with extension _.yaml_ -* [HCL](https://github.com/hashicorp/hcl): files with extension _.hcl_ \ No newline at end of file +* [TOML](https://github.com/toml-lang/toml): files with extensions *.toml* and *.conf* (for compatibility with versions before 0.6.0) +* [JSON](https://en.wikipedia.org/wiki/JSON): files with extension *.json* +* [YAML](https://en.wikipedia.org/wiki/YAML): files with extension *.yaml* +* [HCL](https://github.com/hashicorp/hcl): files with extension *.hcl* \ No newline at end of file diff --git a/docs/content/configuration/getting_started/index.md b/docs/content/configuration/getting_started/index.md index dc2c967dc..ba72b485d 100644 --- a/docs/content/configuration/getting_started/index.md +++ b/docs/content/configuration/getting_started/index.md @@ -14,10 +14,10 @@ Unless you're using the **resticprofile** [Docker image]({{% relref "/installati ## Choose Your Favorite Format The **resticprofile** configuration file can be written in: -* [TOML](https://github.com/toml-lang/toml): configuration file with extension _.toml_ or _.conf_ -* [YAML](https://en.wikipedia.org/wiki/YAML): configuration file with extension _.yaml_ -* [JSON](https://en.wikipedia.org/wiki/JSON): configuration file with extension _.json_ -* [HCL](https://github.com/hashicorp/hcl): configuration file with extension _.hcl_ +* [TOML](https://github.com/toml-lang/toml): configuration file with extension *.toml* or *.conf* +* [YAML](https://en.wikipedia.org/wiki/YAML): configuration file with extension *.yaml* +* [JSON](https://en.wikipedia.org/wiki/JSON): configuration file with extension *.json* +* [HCL](https://github.com/hashicorp/hcl): configuration file with extension *.hcl* We recommend using either TOML or YAML. @@ -53,9 +53,9 @@ A profile defines: * a restic repository (`repository` flag) * how to access your restic repository (e.g., `password-file`) * a list of commands (e.g., `backup`): - * files to include in a backup (`source` flag) - * when to back them up (details later) - * other restic flags for the command line (e.g., `verbose`) + * files to include in a backup (`source` flag) + * when to back them up (details later) + * other restic flags for the command line (e.g., `verbose`) In this example, we'll call our profile `default`. You don't need to specify the profile name on the command line when using `default`. From 29116b81496a5f88f93d82cb3fcd984aeea4d5b3 Mon Sep 17 00:00:00 2001 From: Fred Date: Fri, 28 Feb 2025 20:51:57 +0000 Subject: [PATCH 8/8] remove temporary profile on test config --- examples/dev.yaml | 11 ----------- 1 file changed, 11 deletions(-) diff --git a/examples/dev.yaml b/examples/dev.yaml index 6db6ca4c9..170bdf2ff 100644 --- a/examples/dev.yaml +++ b/examples/dev.yaml @@ -346,14 +346,3 @@ nopwd: repository: "/Volumes/RAMDisk/{{ .Profile.Name }}" insecure-no-password: true -with-env: - inherit: default - env-file: .env - backup: - send-before: - method: POST - url: https://healthcheck.example.org/ping/$VAR1/${PROFILE_NAME}/start - send-after: - body-template: send-body-template.json - method: POST - url: https://healthcheck.example.org/ping/$VAR2/${PROFILE_NAME}/end