https://319-merge.resticprofile.pages.dev/configuration/index.htmlRecent content in Configuration file on resticprofileHugo -- gohugo.ioen-gbhttps://319-merge.resticprofile.pages.dev/configuration/getting_started/index.htmlSat, 25 Mar 2023 14:44:47 +0000https://319-merge.resticprofile.pages.dev/configuration/getting_started/index.htmlPrerequisite resticprofile is one of many automation tools for restic, also called a wrapper. In a nutshell, resticprofile provides a configuration file and a runner that will generate all the necessary calls to restic. Unless you’re using the resticprofile Docker image, you need to have restic installed on your machine. Choose your favourite format resticprofile configuration file can be written in: TOML : configuration file with extension .toml or .conf YAML : configuration file with extension .https://319-merge.resticprofile.pages.dev/configuration/examples/index.htmlSun, 24 Apr 2022 09:44:47 +0100https://319-merge.resticprofile.pages.dev/configuration/examples/index.htmlSimple configuration using Azure storage Here’s a simple configuration file using a Microsoft Azure backend. You will notice that the env section lets you define environment variables: ​ toml yaml hcl version = "1" [default] repository = "azure:restic:/" password-file = "key" option = "azure.connections=3" [default.env] AZURE_ACCOUNT_NAME = "my_storage_account" AZURE_ACCOUNT_KEY = "my_super_secret_key" [default.backup] exclude-file = "excludes" exclude-caches = true one-file-system = true tag = [ "root" ] source = [ "/", "/var" ] schedule = "daily" schedule-after-network-online = true version: "1" default: repository: "azure:restic:/" password-file: "key" option: "azure.https://319-merge.resticprofile.pages.dev/configuration/path/index.htmlSun, 24 Apr 2022 09:44:41 +0100https://319-merge.resticprofile.pages.dev/configuration/path/index.htmlHow paths inside the configuration are resolved All file paths in the configuration are resolved relative to the configuration path, the path where the main configuration file was loaded from. The big exceptions are source in the backup section, status-file, prometheus-save-to-file and the restic repository (if it is a file). These paths are taken as specified, which means they are resolved from the current working directory where you started resticprofile from.https://319-merge.resticprofile.pages.dev/configuration/include/index.htmlMon, 02 May 2022 20:00:00 +0200https://319-merge.resticprofile.pages.dev/configuration/include/index.htmlThe configuration may be split into multiple files by adding includes = "glob-pattern" to the main configuration file. E.g. the following profiles.conf loads configurations from conf.d and profiles.d: ​ toml yaml hcl json version = "1" # Includes includes = ["conf.d/*.conf", "profiles.d/*.yaml", "profiles.d/*.toml"] # Defaults [global] initialize = true version: "1" includes: - "conf.d/*.conf" - "profiles.d/*.yaml" - "profiles.d/*.toml" global: initialize: true includes = ["conf.d/*.conf", "profiles.d/*.yaml", "profiles.d/*.toml"] global { initialize = true } { "version": "1", "includes": [ "conf.https://319-merge.resticprofile.pages.dev/configuration/inheritance/index.htmlMon, 02 May 2022 20:00:00 +0200https://319-merge.resticprofile.pages.dev/configuration/inheritance/index.htmlTip You can use resticprofile [<profile-name>.]show (or resticprofile [--name <profile-name>] show) to see the effect inheritance has on a profile Profile Inheritance Profiles can inherit from a parent profile. This allows to define the general behaviour and common configuration in a base profile while derived profiles only define what is specific, e.g. what needs to be included in the backup or which command hooks (e.g. run-before, run-after & run-finally) must be started.https://319-merge.resticprofile.pages.dev/configuration/copy/index.htmlMon, 01 Jan 0001 00:00:00 +0000https://319-merge.resticprofile.pages.dev/configuration/copy/index.htmlSpecial case for the copy command section The copy command needs two repositories (and quite likely 2 different set of keys). You can configure a copy section like this: ​ toml yaml hcl version = "1" [default] initialize = false repository = "/backup/original" password-file = "key" [default.copy] initialize = true repository = "/backup/copy" password-file = "other_key" version: "1" default: initialize: false repository: "/backup/original" password-file: key copy: initialize: true repository: "/backup/copy" password-file: other_key default { initialize = false repository = "/backup/original" password-file = "key" copy = { initialize = true repository = "/backup/copy" password-file = "other_key" } } You will note that the secondary repository doesn’t need to have a 2 behind its flags (repository2, password-file2, etc.https://319-merge.resticprofile.pages.dev/configuration/run_hooks/index.htmlMon, 16 May 2022 19:46:52 +0100https://319-merge.resticprofile.pages.dev/configuration/run_hooks/index.htmlRun commands before, after success or after failure resticprofile has 2 places where you can run commands around restic: commands that will run before and after every restic command (snapshots, backup, check, forget, prune, mount, etc.). These are placed at the root of each profile and are always considered. commands that will only run before and after specific restic commands. These are placed in supported sections of your profiles (currently supported are backup, copy, dump, find, ls, mount, restore, snapshots, stats and tag).https://319-merge.resticprofile.pages.dev/configuration/http_hooks/index.htmlMon, 16 May 2022 19:46:52 +0100https://319-merge.resticprofile.pages.dev/configuration/http_hooks/index.htmlSend HTTP messages before and after a job As well as being able to run shell commands, you can now send HTTP messages before, after (success or failure) running a restic command. The sections that allow sending HTTP hooks are: backup copy check forget prune Tip You might notice that’s the same sections that can also be scheduled Each of these commands can send 4 different types of hooks: send-before send-after send-after-fail send-finally The configuration is the same for each of these 4 types of hooks:https://319-merge.resticprofile.pages.dev/configuration/templates/index.htmlMon, 16 May 2022 20:04:35 +0100https://319-merge.resticprofile.pages.dev/configuration/templates/index.htmlTemplates are a great way to compose configuration profiles. Please keep in mind that yaml files are sensitive to the number of spaces. Also if you declare a block already declared, it overrides the previous declaration (instead of merging them). For that matter, configuration templates are probably more useful if you use the toml or hcl configuration format. Here’s a simple example {{ define "hello" }} hello = "world" {{ end }}To use the content of this template anywhere in your configuration, simply call it:https://319-merge.resticprofile.pages.dev/configuration/variables/index.htmlMon, 16 May 2022 20:04:35 +0100https://319-merge.resticprofile.pages.dev/configuration/variables/index.htmlVariable expansion in configuration file You might want to reuse the same configuration (or bits of it) on different environments. One way of doing it is to create a generic configuration where specific bits can be replaced by a variable. There are two kinds of variables: template variables: These variables are fixed once the full configuration file is loaded: includes are loaded, and inheritance is resolved. These variables are replaced by their value before the configuration is parsed.https://319-merge.resticprofile.pages.dev/configuration/warnings/index.htmlMon, 16 May 2022 20:24:23 +0100https://319-merge.resticprofile.pages.dev/configuration/warnings/index.htmlWarnings from restic Until version 0.13.0, resticprofile was always considering a restic warning as an error. This will remain the default. But the version 0.13.0 introduced a parameter to avoid this behaviour and consider that the backup was successful instead. A restic warning occurs when it cannot read some files, but a snapshot was successfully created. no-error-on-warning ​ toml yaml hcl json version = "1" [profile] [profile.backup] no-error-on-warning = true version: "1" profile: backup: no-error-on-warning: true "profile" = { "backup" = { "no-error-on-warning" = true } } { "version": "1", "profile": { "backup": { "no-error-on-warning": true } } }https://319-merge.resticprofile.pages.dev/configuration/priority/index.htmlMon, 01 Jan 0001 00:00:00 +0000https://319-merge.resticprofile.pages.dev/configuration/priority/index.htmlBy default, restic is running with the default priority. It means it will get equal share of the resources with other processes. You can lower the priority of restic to avoid slowing down other processes. This is especially useful when you run restic on a production server. Nice You can use these values for the priority parameter: String value “nice” equivalent on unixes Idle 19 Background 15 Low 10 Normal 0 High -10 Highest -20 IO Nice This setting is only available on Linux.https://319-merge.resticprofile.pages.dev/configuration/sleep/index.htmlMon, 01 Jan 0001 00:00:00 +0000https://319-merge.resticprofile.pages.dev/configuration/sleep/index.htmlThis feature is available for: macOS Windows Linux with systemd (logind) There’s a global parameter called prevent-sleep that you can set to true, and resticprofile will prevent your system from idle sleeping. Please note: it will not prevent a sleep if the system is running on batteries it will not prevent a sleep triggered by a user action: using the sleep button, closing the laptop lid, etc.https://319-merge.resticprofile.pages.dev/configuration/logs/index.htmlMon, 01 Jan 0001 00:00:00 +0000https://319-merge.resticprofile.pages.dev/configuration/logs/index.htmlBy default resticprofile will display all logs (from itself and restic) to the console. You can redirect the logs to a local file, a temporary file or a syslog server. Destination The log destination syntax is a such: - redirects all the logs to the console / stdout (is the default log destination) filename redirects all the logs to the local file called filename temp:filename redirects all the logs to a temporary file available during the whole session, and deleted afterwards.https://319-merge.resticprofile.pages.dev/configuration/reference/index.htmlTue, 13 Feb 2024 22:56:03 +0000https://319-merge.resticprofile.pages.dev/configuration/reference/index.htmlNote The configuration file reference is generated from resticprofile’s data model and restic’s manual pages. Sections Section global Profile sections Section profile Section profile.backup Section profile.cache Section profile.cat Section profile.check Section profile.copy Section profile.diff Section profile.dump Section profile.find Section profile.forget Section profile.init Section profile.key Section profile.list Section profile.ls Section profile.migrate Section profile.mount Section profile.prune Section profile.rebuild-index Section profile.recover Section profile.repair Section profile.repair-index Section profile.repair-snapshots Section profile.restore Section profile.retention Section profile.https://319-merge.resticprofile.pages.dev/configuration/jsonschema/index.htmlSun, 24 Apr 2022 09:44:47 +0100https://319-merge.resticprofile.pages.dev/configuration/jsonschema/index.htmlJSON, YAML and TOML configuration files can benefit from a JSON schema that describes the config structure depending on the selected restic and configuration file version. Schema URLs JSON schema URLs for any restic version: Config V1: https://319-merge.resticprofile.pages.dev/jsonschema/config-1.json Config V2: https://319-merge.resticprofile.pages.dev/jsonschema/config-2.json These universal schemas contain all flags and commands of all known restic versions and may allow to set flags that are not supported by a particular restic version. Descriptions and deprecation markers indicate what is supported and what should no longer be used.https://319-merge.resticprofile.pages.dev/configuration/v2/index.htmlMon, 01 Jan 0001 00:00:00 +0000https://319-merge.resticprofile.pages.dev/configuration/v2/index.htmlNote The configuration file format v2 is in preview right now. You can try to use it since v0.17.0 but it’s for testing and feedback only. Introduction The current file format was decided at the time resticprofile was only using the toml format. Nesting pieces of configuration in blocks is not the easiest as you have to specify the whole path in the block: [profile] [profile.backup] source = "some path"Since then, I believe the yaml format is preferred over toml.