Merge pull request #125 from cupcakearmy/1.5.0

1.5.0

.dockerignore

@@ -0,0 +1,6 @@
+*
+!**/*.go
+!build
+!cmd
+!internal
+!go.*

.github/workflows/build.yml

@@ -3,21 +3,54 @@ name: Main
 on:
   push:
     tags:
-      - 'v*.*.*'
+      - "v*.*.*"
 
 jobs:
-  build:
+  docker:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v1
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v1
+      - name: Docker Labels
+        id: meta
+        uses: crazy-max/ghaction-docker-meta@v2
+        with:
+          images: cupcakearmy/autorestic
+          tags: |
+            type=semver,pattern={{version}}
+            type=semver,pattern={{major}}.{{minor}}
+            type=semver,pattern={{major}}
+      - name: Login to DockerHub
+        uses: docker/login-action@v1
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+      - name: Build and push
+        uses: docker/build-push-action@v2
+        with:
+          platforms: linux/amd64,linux/arm64
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+
+  release:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
       - uses: actions/setup-go@v2
         with:
-          go-version: '^1.16.3'
+          go-version: "^1.16.3"
       - name: Build
         run: go run build/build.go
+
+      - name: Sign
+        uses: tristan-weil/ghaction-checksum-sign-artifact@v1.0.1
+        with:
+          path: dist/*
       - name: Release
         uses: softprops/action-gh-release@v1
         with:
           files: dist/*
         env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

CHANGELOG.md

@@ -5,6 +5,97 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.5.0] - 2021-11-20
+
+### Added
+
+- Support for multiple paths
+- Improved error handling
+- Allow for specific snapshot to be restored
+- Docker image
+
+### Fixed
+
+- rclone in docker volumes
+
+### Changed
+
+- [Breaking Change] Declaration of docker volumes. See: https://autorestic.vercel.app/migration/1.4_1.5
+- [Breaking Change] Hooks default executing directory now defaults to the config file directory. See: https://autorestic.vercel.app/migration/1.4_1.5
+
+## [1.4.1] - 2021-10-31
+
+### Fixed
+
+- Numeric values from config files not being passed to env.
+
+## [1.4.0] - 2021-10-30
+
+### Added
+
+- Allow specify to specify a backend for location backup
+- Global restic flags
+- Generic ENV support for backends
+
+### Changed
+
+- Install now only requires `wget`
+- Env variable for the `KEY` has been renamed from `AUTORESTIC_[BACKEND NAME]_KEY` -> `AUTORESTIC_[BACKEND NAME]_RESTIC_PASSWORD`
+
+### Fixed
+
+- Error handling during upgrade & uninstall
+
+## [1.3.0] - 2021-10-26
+
+### Added
+
+- Pass restic backup metadata as ENV to hooks
+- Support for `XDG_CONFIG_HOME` and `${HOME}/.config` as default locations for `.autorestic.yaml` file.
+- Binary restic flags are now supported
+- Pass encryption keys from env variables or files.
+
+## [1.2.0] - 2021-08-05
+
+### Added
+
+- Community page
+- Support for yaml references and aliases
+
+### Fixed
+
+- Better verbose output for hooks
+- Better error message for bad formatted configs
+
+## [1.1.2] - 2021-07-11
+
+### Fixes
+
+Don't check all backend when running `forget` or `exec` commands.
+
+## [1.1.1] - 2021-05-17
+
+### Added
+
+- Options for backends
+
+## [1.1.0] - 2021-05-06
+
+### Added
+
+- use custom restic binary
+- success & failure hooks
+
+### Fixed
+
+- don't skip other locations on failure
+
+## [1.0.9] - 2021-05-01
+
+### Fixed
+
+- Validation for docker volumes
+
 ## [1.0.8] - 2021-04-28
 
 ### Added

DEVELOPMENT.md

@@ -19,5 +19,12 @@ Releases are automatically built by the github workflow and uploaded to the rele
 1. Bump `VERSION` in `internal/config.go`.
 2. Update `CHANGELOG.md`
 3. Commit to master
-4. Create a new release with the `v1.2.3` tag and mark as draft.
+4. Create a new release with the `v1.2.3` tag and mark as pre-release.
 5. The Github action will build the binaries, upload and mark the release as ready when done.
+
+### Brew
+
+1. Download the latest release.
+2. Check the checksum with `shasum -a 256 autorestic-1.2.3.tar.gz`
+3. Update `url` and `sha256` in the brew repo.
+4. Submit PR

Dockerfile

@@ -0,0 +1,12 @@
+FROM golang:1.16-alpine as builder
+
+WORKDIR /app
+COPY go.* .
+RUN go mod download
+COPY . .
+RUN go build
+
+FROM alpine
+RUN apk add --no-cache restic rclone
+COPY --from=builder /app/autorestic /usr/bin/autorestic
+CMD [ "autorestic" ]

README.md

@@ -10,6 +10,13 @@
     Config driven, easy backup cli for <a href="https://restic.net/">restic</a>.
     <br>
     <strong><a href="https://autorestic.vercel.app/">»»» Docs & Getting Started »»»</a></strong>
+  <br><br>
+  <a target="_blank" href="https://discord.gg/wS7RpYTYd2">
+    <img src="https://img.shields.io/discord/252403122348097536" alt="discord badge" />
+    <img src="https://img.shields.io/github/contributors/cupcakearmy/autorestic" alt="contributor badge" />
+    <img src="https://img.shields.io/github/downloads/cupcakearmy/autorestic/total" alt="downloads badge" />
+    <img src="https://img.shields.io/github/v/release/cupcakearmy/autorestic" alt="version badge" />
+  </a>
   </p>
 </p>
 
@@ -18,7 +25,7 @@
 
 ### 💭 Why / What?
 
-Autorestic is a wrapper around the amazing [restic](https://restic.net/). While being amazing the restic cli can be a bit overwhelming and difficult to manage if you have many different location that you want to backup to multiple locations. This utility is aimed at making this easier 🙂
+Autorestic is a wrapper around the amazing [restic](https://restic.net/). While being amazing the restic cli can be a bit overwhelming and difficult to manage if you have many different locations that you want to backup to multiple locations. This utility is aimed at making this easier 🙂.
 
 ### 🌈 Features
 
@@ -35,7 +42,7 @@ Autorestic is a wrapper around the amazing [restic](https://restic.net/). While
 
 ### ❓ Questions / Support
 
-Check the [discussions page](https://github.com/cupcakearmy/autorestic/discussions)
+Check the [discussions page](https://github.com/cupcakearmy/autorestic/discussions) or [join on discord](https://discord.gg/wS7RpYTYd2)
 
 ## Contributing / Developing
 

cmd/backup.go

@@ -2,6 +2,7 @@ package cmd
 
 import (
 	"fmt"
+	"strings"
 
 	"github.com/cupcakearmy/autorestic/internal"
 	"github.com/cupcakearmy/autorestic/internal/colors"
@@ -13,19 +14,23 @@ var backupCmd = &cobra.Command{
 	Use:   "backup",
 	Short: "Create backups for given locations",
 	Run: func(cmd *cobra.Command, args []string) {
+		internal.GetConfig()
 		err := lock.Lock()
 		CheckErr(err)
 		defer lock.Unlock()
 
-		CheckErr(internal.CheckConfig())
-
 		selected, err := internal.GetAllOrSelected(cmd, false)
 		CheckErr(err)
 		errors := 0
 		for _, name := range selected {
-			location, _ := internal.GetLocation(name)
-			err := location.Backup(false)
-			if err != nil {
+			var splitted = strings.Split(name, "@")
+			var specificBackend = ""
+			if len(splitted) > 1 {
+				specificBackend = splitted[1]
+			}
+			location, _ := internal.GetLocation(splitted[0])
+			errs := location.Backup(false, specificBackend)
+			for _, err := range errs {
 				colors.Error.Println(err)
 				errors++
 			}

cmd/exec.go

@@ -11,12 +11,11 @@ var execCmd = &cobra.Command{
 	Use:   "exec",
 	Short: "Execute arbitrary native restic commands for given backends",
 	Run: func(cmd *cobra.Command, args []string) {
+		internal.GetConfig()
 		err := lock.Lock()
 		CheckErr(err)
 		defer lock.Unlock()
 
-		CheckErr(internal.CheckConfig())
-
 		selected, err := internal.GetAllOrSelected(cmd, true)
 		CheckErr(err)
 		for _, name := range selected {

cmd/forget.go

@@ -10,12 +10,11 @@ var forgetCmd = &cobra.Command{
 	Use:   "forget",
 	Short: "Forget and optionally prune snapshots according the specified policies",
 	Run: func(cmd *cobra.Command, args []string) {
+		internal.GetConfig()
 		err := lock.Lock()
 		CheckErr(err)
 		defer lock.Unlock()
 
-		CheckErr(internal.CheckConfig())
-
 		selected, err := internal.GetAllOrSelected(cmd, false)
 		CheckErr(err)
 		prune, _ := cmd.Flags().GetBool("prune")

cmd/restore.go

@@ -9,8 +9,9 @@ import (
 )
 
 var restoreCmd = &cobra.Command{
-	Use:   "restore",
+	Use:   "restore [snapshot id]",
 	Short: "Restore backup for location",
+	Args:  cobra.MaximumNArgs(1),
 	Run: func(cmd *cobra.Command, args []string) {
 		err := lock.Lock()
 		CheckErr(err)
@@ -24,7 +25,11 @@ var restoreCmd = &cobra.Command{
 		target, _ := cmd.Flags().GetString("to")
 		from, _ := cmd.Flags().GetString("from")
 		force, _ := cmd.Flags().GetBool("force")
-		err = l.Restore(target, from, force)
+		snapshot := ""
+		if len(args) > 0 {
+			snapshot = args[0]
+		}
+		err = l.Restore(target, from, force, snapshot)
 		CheckErr(err)
 	},
 }

cmd/root.go

@@ -2,6 +2,7 @@ package cmd
 
 import (
 	"os"
+	"path/filepath"
 
 	"github.com/cupcakearmy/autorestic/internal"
 	"github.com/cupcakearmy/autorestic/internal/colors"
@@ -37,6 +38,7 @@ func init() {
 	rootCmd.PersistentFlags().StringVarP(&cfgFile, "config", "c", "", "config file (default is $HOME/.autorestic.yml or ./.autorestic.yml)")
 	rootCmd.PersistentFlags().BoolVar(&internal.CI, "ci", false, "CI mode disabled interactive mode and colors and enables verbosity")
 	rootCmd.PersistentFlags().BoolVarP(&internal.VERBOSE, "verbose", "v", false, "verbose mode")
+	rootCmd.PersistentFlags().StringVar(&internal.RESTIC_BIN, "restic-bin", "restic", "specify custom restic binary")
 	cobra.OnInitialize(initConfig)
 }
 
@@ -49,11 +51,24 @@ func initConfig() {
 	if cfgFile != "" {
 		viper.SetConfigFile(cfgFile)
 	} else {
-		home, err := homedir.Dir()
-		CheckErr(err)
-
 		viper.AddConfigPath(".")
-		viper.AddConfigPath(home)
+
+		// Home
+		if home, err := homedir.Dir(); err != nil {
+			viper.AddConfigPath(home)
+		}
+
+		// XDG_CONFIG_HOME
+		{
+			prefix, found := os.LookupEnv("XDG_CONFIG_HOME")
+			if !found {
+				if home, err := homedir.Dir(); err != nil {
+					prefix = filepath.Join(home, ".config")
+				}
+			}
+			viper.AddConfigPath(filepath.Join(prefix, "autorestic"))
+		}
+
 		viper.SetConfigName(".autorestic")
 	}
 	viper.AutomaticEnv()

cmd/uninstall.go

@@ -9,12 +9,12 @@ var uninstallCmd = &cobra.Command{
 	Use:   "uninstall",
 	Short: "Uninstall restic and autorestic",
 	Run: func(cmd *cobra.Command, args []string) {
-		noRestic, _ := cmd.Flags().GetBool("no-restic")
-		bins.Uninstall(!noRestic)
+		restic, _ := cmd.Flags().GetBool("restic")
+		bins.Uninstall(restic)
 	},
 }
 
 func init() {
 	rootCmd.AddCommand(uninstallCmd)
-	uninstallCmd.Flags().Bool("no-restic", false, "do not uninstall restic.")
+	uninstallCmd.Flags().Bool("restic", false, "also uninstall restic.")
 }

cmd/upgrade.go

@@ -9,13 +9,13 @@ var upgradeCmd = &cobra.Command{
 	Use:   "upgrade",
 	Short: "Upgrade autorestic and restic",
 	Run: func(cmd *cobra.Command, args []string) {
-		noRestic, _ := cmd.Flags().GetBool("no-restic")
-		err := bins.Upgrade(!noRestic)
+		restic, _ := cmd.Flags().GetBool("restic")
+		err := bins.Upgrade(restic)
 		CheckErr(err)
 	},
 }
 
 func init() {
 	rootCmd.AddCommand(upgradeCmd)
-	upgradeCmd.Flags().Bool("no-restic", false, "also update restic")
+	upgradeCmd.Flags().Bool("restic", true, "also update restic")
 }

docs/markdown/_toc.md

@@ -1,5 +1,6 @@
 [Home](/)
 [Quick Start](/quick)
+[Installation](/installation)
 [Configuration](/config)
 [Upgrade](/upgrade)
 
@@ -7,8 +8,13 @@
 >
 > [Overview](/location/overview)
 > [Hooks](/location/hooks)
-> [Excluding Files](/location/exclude)
-> [Forget Policy](/location/forget)
+>
+> > :Collapse label=Options
+> > 
+> > [Overview](/location/options)
+> > [Excluding Files](/location/exclude)
+> > [Forget Policy](/location/forget)
+>
 > [Cron](/location/cron)
 > [Docker Volumes](/location/docker)
 
@@ -16,6 +22,8 @@
 >
 > [Overview](/backend/overview)
 > [Available Backends](/backend/available)
+> [Options](/backend/options)
+> [Environment](/backend/env)
 
 > :Collapse label=CLI
 >
@@ -30,10 +38,15 @@
 > [Exec](/cli/exec)
 > [Install](/cli/install)
 > [Uninstall](/cli/uninstall)
-> [Update](/cli/update)
+> [Upgrade](/cli/upgrade)
+
+> :Collapse label=Migration
+>
+> [0.x → 1.0](/migration/0.x_1.0)
+> [1.4 → 1.5](/migration/1.4_1.5)
 
 [Examples](/examples)
-
 [QA](/qa)
-
+[Community](/community)
 [Contributors](/contrib)
+

docs/markdown/backend/available.md

@@ -4,6 +4,8 @@ In theory [all the restic backends](https://restic.readthedocs.io/en/stable/030_
 
 Those tested are the following:
 
+> ℹ️ You can also [specify the `env` variables in a config file](/backend/env) to separate them from the config file.
+
 ## Local
 
 ```yaml
@@ -19,9 +21,9 @@ backends:
 backends:
   name-of-backend:
     type: b2
-    path: 'backblaze_bucketID'
+    path: 'bucket_name'
     # Or With a path
-    # path: 'backblaze_bucketID:/some/path'
+    # path: 'bucket_name:/some/path'
     env:
       B2_ACCOUNT_ID: 'backblaze_keyID'
       B2_ACCOUNT_KEY: 'backblaze_applicationKey'
@@ -29,7 +31,7 @@ backends:
 
 #### API Keys gotcha
 
-If you use a _File name prefix_ when making the application key, do not include a leading slash. Make sure to include this prefix in the path (e.g. `path: 'backblaze_bucketID:my/path'`).
+If you use a _File name prefix_ when making the application key, do not include a leading slash. Make sure to include this prefix in the path (e.g. `path: 'bucket_name:my/path'`).
 
 ## S3 / Minio
 

docs/markdown/backend/env.md

@@ -0,0 +1,67 @@
+# Environment
+
+> ⚠ Available since version `v1.4.0`
+
+Sometimes it's favorable not having the encryption keys in the config files.
+For that `autorestic` allows passing the env variables to backend password as `ENV` variables, or through an env file.
+You can also pass whatever `env` variable to restic by prefixing it with `AUTORESTIC_[BACKEND NAME]_`.
+
+> ℹ️ Env variables and file overwrite the config file in the following order:
+>
+> Env Variables > Env File (`.autorestic.env`) > Config file (`.autorestic.yaml`)
+
+## Env file
+
+Alternatively `autorestic` can load an env file, located next to `.autorestic.yml` called `.autorestic.env`.
+
+```
+AUTORESTIC_FOO_RESTIC_PASSWORD=secret123
+```
+
+### Example with repository password
+
+The syntax for the `ENV` variables is as follows: `AUTORESTIC_[BACKEND NAME]_RESTIC_PASSWORD`.
+
+```yaml | autorestic.yaml
+backend:
+  foo:
+    type: ...
+    path: ...
+    key: secret123 # => AUTORESTIC_FOO_RESTIC_PASSWORD=secret123
+```
+
+This means we could remove `key: secret123` from `.autorestic.yaml` and execute as follows:
+
+```bash
+AUTORESTIC_FOO_RESTIC_PASSWORD=secret123 autorestic backup ...
+```
+
+### Example with Backblaze B2
+
+```yaml | autorestic.yaml
+backends:
+  bb:
+    type: b2
+    path: myBucket
+    key: myPassword
+    env:
+      B2_ACCOUNT_ID: 123
+      B2_ACCOUNT_KEY: 456
+```
+
+You could create an `.autorestic.env` or pass the following `ENV` variables to autorestic:
+
+```
+AUTORESTIC_BB_RESTIC_PASSWORD=myPassword
+AUTORESTIC_BB_B2_ACCOUNT_ID=123
+AUTORESTIC_BB_B2_ACCOUNT_KEY=456
+```
+
+```yaml | autorestic.yaml
+backends:
+  bb:
+    type: b2
+    path: myBucket
+```
+
+> :ToCPrevNext

docs/markdown/backend/options.md

@@ -0,0 +1,19 @@
+# Options
+
+> ℹ️ For more detail see the [location docs](/location/options) for options, as they are the same.
+
+```yaml
+backend:
+  foo:
+    type: ...
+    path: ...
+    options:
+      backup:
+        tag:
+          - foo
+          - bar
+```
+
+In this example, whenever `autorestic` runs `restic backup` it will append a `--tag abc --tag` to the native command.
+
+> :ToCPrevNext

docs/markdown/cli/backup.md

@@ -14,4 +14,12 @@ autorestic backup -a
 autorestic backup -l foo -l bar
 ```
 
+## Specific location
+
+`autorestic` also allows selecting specific backends for a location with the `location@backend` syntax.
+
+```bash
+autorestic backup -l location@backend
+```
+
 > :ToCPrevNext

docs/markdown/cli/exec.md

@@ -4,7 +4,7 @@
 autorestic exec [-b, --backend]  [-a, --all] <command> -- [native options]
 ```
 
-This is avery handy command which enables you to run any native restic command on desired backends. Generally will want to include the verbose flag `-v, --verbose` to see the output. An example would be listing all the snapshots of all your backends:
+This is a very handy command which enables you to run any native restic command on desired backends. Generally you will want to include the verbose flag `-v, --verbose` to see the output. An example would be listing all the snapshots of all your backends:
 
 ```bash
 autorestic exec -av -- snapshots

docs/markdown/cli/forget.md

@@ -4,7 +4,7 @@
 autorestic forget [-l, --location] [-a, --all] [--dry-run] [--prune]
 ```
 
-This will prune and remove old data form the backends according to the [keep policy you have specified for the location](/location/forget)
+This will prune and remove old data form the backends according to the [keep policy you have specified for the location](/location/forget).
 
 The `--dry-run` flag will do a dry run showing what would have been deleted, but won't touch the actual data.
 

docs/markdown/cli/general.md

@@ -27,4 +27,12 @@ Verbose mode will show the output of the native restic commands that are otherwi
 autorestic --verbose backup -a
 ```
 
+## `--restic-bin`
+
+With `--restic-bin` you can specify to run a specific restic binary. This can be useful if you want to [create a custom binary with root access that can be executed by any user](https://restic.readthedocs.io/en/stable/080_examples.html#full-backup-without-root).
+
+```bash
+autorestic --restic-bin /some/path/to/my/custom/restic/binary
+```
+
 > :ToCPrevNext

docs/markdown/cli/restore.md

@@ -1,12 +1,12 @@
 # Restore
 
 ```bash
-autorestic restore [-l, --location] [--from backend] [--to <out dir>] [-f, --force]
+autorestic restore [-l, --location] [--from backend] [--to <out dir>] [-f, --force] [snapshot]
 ```
 
-This will restore all the locations to the selected target. If for one location there are more than one backends specified autorestic will take the first one.
+This will restore the location to the selected target. If for one location there are more than one backends specified autorestic will take the first one. If no specific snapshot is specified `autorestic` will use `latest`.
 
-The `--to` path das to be empty as no data will be overwritten by default. If you are sure you can pass the `-f, --force` flag and the data will be overwritten in the destination. However note that this will overwrite all the data existent in the backup, not only the 1 file that is missing e.g.
+If you are sure you can pass the `-f, --force` flag and the data will be overwritten in the destination. However note that this will overwrite all the data existent in the backup, not only the 1 file that is missing e.g.
 
 ## Example
 

docs/markdown/cli/uninstall.md

@@ -1,6 +1,6 @@
 # Uninstall
 
-Installs both restic and autorestic from `/usr/local/bin`.
+Uninstalls both restic and autorestic from `/usr/local/bin`.
 
 ```bash
 autorestic uninstall

docs/markdown/cli/update.md

@@ -1,11 +0,0 @@
-# Update
-
-Autorestic can update itself! Super handy right? Simply run autorestic update and we will check for you if there are updates for restic and autorestic and install them if necessary.
-
-```bash
-autorestic update
-```
-
-Updates both restic and autorestic automagically.
-
-> :ToCPrevNext

docs/markdown/cli/upgrade.md

@@ -0,0 +1,11 @@
+# Upgrade
+
+Autorestic can upgrade itself! Super handy right? Simply run autorestic upgrade and we will check for you if there are updates for restic and autorestic and install them if necessary.
+
+```bash
+autorestic upgrade
+```
+
+Updates both restic and autorestic automagically.
+
+> :ToCPrevNext

docs/markdown/community.md

@@ -0,0 +1,11 @@
+# 🏘 Community
+
+A list of community driven projects. (No official affiliation)
+
+- SystemD Units: https://gitlab.com/py_crash/autorestic-systemd-units
+- Docker image: https://github.com/pascaliske/docker-autorestic
+- Ansible Role: https://github.com/adsanz/ansible-restic-role
+- Ansible Role: https://github.com/ItsNotGoodName/ansible-role-autorestic
+- Ansible Role: https://github.com/FuzzyMistborn/ansible-role-autorestic
+
+> :ToCPrevNext

docs/markdown/config.md

@@ -31,12 +31,53 @@ backends:
   remote:
     type: b2
     path: 'myBucket:backup/home'
-    B2_ACCOUNT_ID: account_id
-    B2_ACCOUNT_KEY: account_key
+    env:
+      B2_ACCOUNT_ID: account_id
+      B2_ACCOUNT_KEY: account_key
 
   hdd:
     type: local
     path: /mnt/my_external_storage
 ```
 
+## Aliases
+
+A handy tool for more advanced configurations is to use yaml aliases.
+These must be specified under the global `extras` key in the `.autorestic.yml` config file.
+Aliases allow to reuse snippets of config throughout the same file.
+
+The following example shows how the locations `a` and `b` share the same hooks and forget policies.
+
+```yaml | .autorestic.yml
+extras:
+  hooks: &foo
+    before:
+      - echo "Hello"
+    after:
+      - echo "kthxbye"
+  policies: &bar
+    keep-daily: 14
+    keep-weekly: 52
+
+backends:
+  # ...
+locations:
+  a:
+    from: /data/a
+    to: some
+    hooks:
+      <<: *foo
+    options:
+      forget:
+        <<: *bar
+  b:
+    from: data/b
+    to: some
+    hooks:
+      <<: *foo
+    options:
+      forget:
+        <<: *bar
+```
+
 > :ToCPrevNext

docs/markdown/contrib.md

@@ -4,10 +4,14 @@ This amazing people helped the project!
 
 - @agateblue - Docs, Pruning, S3
 - @david-boles - Docs
+- @SebDanielsson - Brew
+- @n194 - AUR Package
 - @jin-park-dev - Typos
 - @sumnerboy12 - Typos
 - @FuzzyMistborn - Typos
 - @ChanceM - Typos
 - @TheForcer - Typos
+- @themorlan - Typos
+- @somebox - Typos
 
 > :ToCPrevNext

docs/markdown/examples.md

@@ -8,7 +8,7 @@ autorestic exec -av -- snapshots
 
 ## Unlock a locked repository
 
-This can come in handy if a backup process crashed or if it was accidentally cancelled. Then the repository would still be locked without an actual process using it. Only do this if you know what you are sure no other process is actually reading/writing to the repository of course.
+This can come in handy if a backup process crashed or if it was accidentally cancelled. Then the repository would still be locked without an actual process using it. Only do this if you know what you are doing and are sure no other process is actually reading/writing to the repository of course.
 
 ```bash
 autorestic exec -b my-backend -- unlock

docs/markdown/installation.md

@@ -2,10 +2,28 @@
 
 Linux & macOS. Windows is not supported. If you have problems installing please open an issue :)
 
-Autorestic requires `curl`, `wget` and `bzip2` to be installed. For most systems these should be already installed.
+Autorestic requires `bash`, `wget` and `bzip2` to be installed. For most systems these should be already installed.
 
 ```bash
-curl -s https://raw.githubusercontent.com/CupCakeArmy/autorestic/master/install.sh | bash
+wget -qO - https://raw.githubusercontent.com/CupCakeArmy/autorestic/master/install.sh | bash
 ```
 
+## Alternatives
+
+### Docker
+
+There is an official docker image over at [cupcakearmy/autorestic](https://hub.docker.com/r/cupcakearmy/autorestic).
+
+### Manual
+
+You can download the right binary from the release page and simply copy it to `/usr/local/bin` or whatever path you prefer. Autoupdates will still work.
+
+### Brew
+
+If you are on macOS you can install through brew: `brew install autorestic`.
+
+### AUR
+
+~~If you are on Arch there is an [AUR Package](https://aur.archlinux.org/packages/autorestic-bin/) (looking for maintainers).~~ - Deprecated
+
 > :ToCPrevNext

docs/markdown/location/cron.md

@@ -37,11 +37,17 @@ Then paste this at the bottom of the file and save it. Note that in this specifi
 PATH="/usr/local/bin:/usr/bin:/bin"
 
 # Example running every 5 minutes
-*/5 * * * * autorestic --ci cron
+*/5 * * * * autorestic -c /path/to/my/.autorestic.yml --ci cron
 ```
 
 > The `--ci` option is not required, but recommended
 
+To debug a cron job you can use
+
+```bash
+*/5 * * * * autorestic -c /path/to/my/.autorestic.yml --ci cron > /tmp/autorestic.log 2>&1
+```
+
 Now you can add as many `cron` attributes as you wish in the config file ⏱
 
 > Also note that manually triggered backups with `autorestic backup` will not influence the cron timeline, they are willingly not linked.

docs/markdown/location/docker.md

@@ -3,7 +3,7 @@
 autorestic supports docker volumes directly, without needing them to be mounted to the host filesystem.
 
 ```yaml | docker-compose.yml
-version: '3.7'
+version: '3.8'
 
 volumes:
   data:
@@ -18,13 +18,9 @@ services:
 
 ```yaml | .autorestic.yml
 locations:
-  - name: hello
-    from: volume:my-data
-    to:
-      - remote
-
-backends:
-  - name: remote
+  foo:
+    from: my-data
+    type: volume
     # ...
 ```
 

docs/markdown/location/hooks.md

@@ -2,7 +2,14 @@
 
 If you want to perform some commands before and/or after a backup, you can use hooks.
 
-They consist of a list of `before`/`after` commands that will be executed in the same directory as the target `from`.
+They consist of a list of commands that will be executed in the same directory as the target `from`.
+
+The following hooks groups are supported, none are required:
+
+- `before`
+- `after`
+- `failure`
+- `success`
 
 ```yml | .autorestic.yml
 locations:
@@ -11,10 +18,63 @@ locations:
     to: my-backend
     hooks:
       before:
-        - echo "Hello"
-        - echo "Human"
+        - echo "One"
+        - echo "Two"
+        - echo "Three"
       after:
-        - echo "kthxbye"
+        - echo "Byte"
+      failure:
+        - echo "Something went wrong"
+      success:
+        - echo "Well done!"
+```
+
+## Flowchart
+
+1. `before` hook
+2. Run backup
+3. `after` hook
+4. - `success` hook if no errors were found
+   - `failure` hook if at least one error was encountered
+
+If the `before` hook encounters errors the backup and `after` hooks will be skipped and only the `failed` hooks will run.
+
+## Environment variables
+
+All hooks are exposed to the `AUTORESTIC_LOCATION` environment variable, which contains the location name.
+
+The `after` and `success` hooks have access to additional information with the following syntax:
+
+```bash
+AUTORESTIC_[TYPE]_[I]
+AUTORESTIC_[TYPE]_[BACKEND_NAME]
+```
+
+Every type of metadata is appended with both the name of the backend associated with and the number in which the backends where executed.
+
+### Available Metadata Types
+
+- `SNAPSHOT_ID`
+- `PARENT_SNAPSHOT_ID`
+- `FILES_ADDED`
+- `FILES_CHANGED`
+- `FILES_UNMODIFIED`
+- `DIRS_ADDED`
+- `DIRS_CHANGED`
+- `DIRS_UNMODIFIED`
+- `ADDED_SIZE`
+- `PROCESSED_FILES`
+- `PROCESSED_SIZE`
+- `PROCESSED_DURATION`
+
+#### Example
+
+Assuming you have a location `bar` that backs up to a single backend named `foo` you could expect the following env variables:
+
+```bash
+AUTORESTIC_LOCATION=bar
+AUTORESTIC_FILES_ADDED_0=42
+AUTORESTIC_FILES_ADDED_FOO=42
 ```
 
 > :ToCPrevNext

docs/markdown/location/options.md

@@ -0,0 +1,67 @@
+# Options
+
+For the `backup` and `forget` commands you can pass any native flags to `restic`. In addition you can specify flags for every command with `all`.
+
+If flags don't start with `-` they will get prefixed with `--`.
+
+Flags without arguments can be set to `true`. They will be handled accordingly.
+
+> ℹ️ It is also possible to set options for an [entire backend](/backend/options) or globally (see below).
+
+```yaml
+locations:
+  foo:
+    # ...
+    options:
+      all:
+        some-flag: 123
+        # Equivalent to
+        --some-flag: 123
+      backup:
+        boolean-flag: true
+        tag:
+          - foo
+          - bar
+```
+
+## Example
+
+In this example, whenever `autorestic` runs `restic backup` it will append a `--tag foo --tag bar` to the native command.
+
+```yaml
+locations:
+  foo:
+    path: ...
+    to: ...
+    options:
+      backup:
+        tag:
+          - foo
+          - bar
+```
+
+## Priority
+
+Options can be set globally, on the backends or on the locations.
+
+The priority is as follows: `location > backend > global`.
+
+## Global Options
+
+It is possible to specify global flags that will be run every time restic is invoked. To do so specify them under `global` in your config file.
+
+```yaml
+global:
+  all:
+    cache-dir: ~/restic
+  backup:
+    tag:
+      - foo
+
+backends:
+  # ...
+locations:
+  # ...
+```
+
+> :ToCPrevNext

docs/markdown/migration/0.x_1.0.md

@@ -1,6 +1,4 @@
-# Update
-
-## From `0.x` to `1.0`
+# From `0.x` to `1.0`
 
 Most of the config file is remained compatible, however to clean up the backends custom environment variables were moved from the root object to an `env` object.
 

docs/markdown/migration/1.4_1.5.md

@@ -0,0 +1,60 @@
+# Migration from `1.4` to `1.5`
+
+## ⚠️ Important notes
+
+The way snapshots are referenced in the `restore` and `prune` commands has been changed. Before they were referenced by the path. Now every backup is tagged and those tags are then referenced in the cli. This means that when running restore and forget commands old backups are not taken into account anymore.
+
+## Config files
+
+- The config file now required to have a version number. This has to be added with `version: 2` at the root.
+- Hooks now optionally support `dir: /some/dir` in the [options object](https://pkg.go.dev/github.com/cupcakearmy/autorestic/internal#Hooks).
+- Docker volumes don't get prefixed with `volume:` anymore, rather you have to set the `type: volume` in the [location config](https://pkg.go.dev/github.com/cupcakearmy/autorestic/internal#Hooks).
+
+See detailed instructions below.
+
+## Config Version
+
+```yaml
+version: 2 # Added
+
+backends:
+  # ...
+```
+
+## Hooks
+
+Since `1.5` multiple sources for a location are possible.
+For this reason, while before hooks where executed in the folder of the source, now they are executed in the directory of the config `.autorestic.yaml`.
+
+You can overwrite this behavior with the new `dir` option in the hook section of the config.
+
+```yaml
+locations:
+  l1:
+    # ...
+    from: /foo/bar
+    hooks:
+      dir: /foo/bar
+      before: pwd
+```
+
+## Docker volumes
+
+The syntax with docker volumes has changed and needs to be adjusted.
+
+```yaml
+# Before
+locations:
+  foo:
+    from: volume:my-data
+```
+
+```yaml
+# After
+locations:
+  foo:
+    from: my-data
+    type: volume
+```
+
+> :ToCPrevNext

docs/markdown/migration/index.md

@@ -0,0 +1,4 @@
+# Migration
+
+- [From 0.x to 1.0](/migration/0.x_1.0)
+- [From 1.4 to 1.5](/migration/1.4_1.5)

docs/markdown/quick.md

@@ -3,9 +3,11 @@
 ## Installation
 
 ```bash
-curl -s https://raw.githubusercontent.com/CupCakeArmy/autorestic/master/install.sh | bash
+wget -qO - https://raw.githubusercontent.com/CupCakeArmy/autorestic/master/install.sh | bash
 ```
 
+See [installation](/installation) for alternative options.
+
 ## Write a simple config file
 
 ```bash

go.mod

@@ -6,6 +6,7 @@ require (
 	github.com/blang/semver/v4 v4.0.0
 	github.com/buger/goterm v1.0.0
 	github.com/fatih/color v1.10.0
+	github.com/joho/godotenv v1.4.0
 	github.com/mitchellh/go-homedir v1.1.0
 	github.com/robfig/cron v1.2.0
 	github.com/spf13/cobra v1.1.3

go.sum

@@ -101,6 +101,8 @@ github.com/hashicorp/memberlist v0.1.3/go.mod h1:ajVTdAv/9Im8oMAAj5G31PhhMCZJV2p
 github.com/hashicorp/serf v0.8.2/go.mod h1:6hOLApaqBFA1NXqRQAsxw9QxuDEvNxSQRwA/JwenrHc=
 github.com/inconshreveable/mousetrap v1.0.0 h1:Z8tu5sraLXCXIcARxBp/8cbvlwVa7Z1NHg9XEKhtSvM=
 github.com/inconshreveable/mousetrap v1.0.0/go.mod h1:PxqpIevigyE2G7u3NXJIT2ANytuPF1OarO4DADm73n8=
+github.com/joho/godotenv v1.4.0 h1:3l4+N6zfMWnkbPEXKng2o2/MR5mSwTrBih4ZEkkz1lg=
+github.com/joho/godotenv v1.4.0/go.mod h1:f4LDr5Voq0i2e/R5DDNOoa2zzDfwtkZa6DnEwAbqwq4=
 github.com/jonboulle/clockwork v0.1.0/go.mod h1:Ii8DK3G1RaLaWxj9trq07+26W01tbo22gdxWY5EU2bo=
 github.com/json-iterator/go v1.1.6/go.mod h1:+SdeFBvtyEkXs7REEP0seUULqWtbJapLOCVDaaPEHmU=
 github.com/jstemmer/go-junit-report v0.0.0-20190106144839-af01ea7f8024/go.mod h1:6v2b51hI/fHJwM22ozAgKL4VKDeJcHhJFhtBdhmNjmU=

install.sh

@@ -23,13 +23,15 @@ elif [[ $NATIVE_ARCH == *"arm64"* || $NATIVE_ARCH == *"aarch64"* ]]; then
     ARCH=arm64
 elif [[ $NATIVE_ARCH == *"x86"* ]]; then
     ARCH=386
+elif [[ $NATIVE_ARCH == *"armv7"* ]]; then
+    ARCH=arm
 else
     echo "Could not determine Architecure automatically, please check the release page manually: https://github.com/cupcakearmy/autorestic/releases"
     exit 1
 fi
 echo $ARCH
 
-curl -s https://api.github.com/repos/cupcakearmy/autorestic/releases/latest \
+wget -qO - https://api.github.com/repos/cupcakearmy/autorestic/releases/latest \
 | grep "browser_download_url.*_${OS}_${ARCH}" \
 | cut -d : -f 2,3 \
 | tr -d \" \

internal/backend.go

@@ -17,12 +17,13 @@ type BackendRest struct {
 }
 
 type Backend struct {
-	name string
-	Type string            `yaml:"type,omitempty"`
-	Path string            `yaml:"path,omitempty"`
-	Key  string            `yaml:"key,omitempty"`
-	Env  map[string]string `yaml:"env,omitempty"`
-	Rest BackendRest       `yaml:"rest,omitempty"`
+	name    string
+	Type    string            `yaml:"type,omitempty"`
+	Path    string            `yaml:"path,omitempty"`
+	Key     string            `yaml:"key,omitempty"`
+	Env     map[string]string `yaml:"env,omitempty"`
+	Rest    BackendRest       `yaml:"rest,omitempty"`
+	Options Options           `yaml:"options,omitempty"`
 }
 
 func GetBackend(name string) (Backend, bool) {
@@ -57,12 +58,27 @@ func (b Backend) generateRepo() (string, error) {
 
 func (b Backend) getEnv() (map[string]string, error) {
 	env := make(map[string]string)
-	env["RESTIC_PASSWORD"] = b.Key
+	// Key
+	if b.Key != "" {
+		env["RESTIC_PASSWORD"] = b.Key
+	}
+
+	// From config file
 	repo, err := b.generateRepo()
 	env["RESTIC_REPOSITORY"] = repo
 	for key, value := range b.Env {
 		env[strings.ToUpper(key)] = value
 	}
+
+	// From Envfile and passed as env
+	var prefix = "AUTORESTIC_" + strings.ToUpper(b.name) + "_"
+	for _, variable := range os.Environ() {
+		var splitted = strings.SplitN(variable, "=", 2)
+		if strings.HasPrefix(splitted[0], prefix) {
+			env[strings.TrimPrefix(splitted[0], prefix)] = splitted[1]
+		}
+	}
+
 	return env, err
 }
 
@@ -84,14 +100,19 @@ func (b Backend) validate() error {
 		return fmt.Errorf(`Backend "%s" has no "path"`, b.name)
 	}
 	if b.Key == "" {
-		key := generateRandomKey()
-		b.Key = key
-		c := GetConfig()
-		tmp := c.Backends[b.name]
-		tmp.Key = key
-		c.Backends[b.name] = tmp
-		if err := c.SaveConfig(); err != nil {
-			return err
+		// Check if key is set in environment
+		env, _ := b.getEnv()
+		if _, found := env["RESTIC_PASSWORD"]; !found {
+			// No key set in config file or env => generate random key and save file
+			key := generateRandomKey()
+			b.Key = key
+			c := GetConfig()
+			tmp := c.Backends[b.name]
+			tmp.Key = key
+			c.Backends[b.name] = tmp
+			if err := c.SaveConfig(); err != nil {
+				return err
+			}
 		}
 	}
 	env, err := b.getEnv()
@@ -136,30 +157,52 @@ func (b Backend) ExecDocker(l Location, args []string) (string, error) {
 	if err != nil {
 		return "", err
 	}
-	volume := l.getVolumeName()
-	path, _ := l.getPath()
+	volume := l.From[0]
 	options := ExecuteOptions{
 		Command: "docker",
 		Envs:    env,
 	}
+	dir := "/data"
+	args = append([]string{"restic"}, args...)
 	docker := []string{
 		"run", "--rm",
+		"--pull", "always",
 		"--entrypoint", "ash",
-		"--workdir", path,
-		"--volume", volume + ":" + path,
+		"--workdir", dir,
+		"--volume", volume + ":" + dir,
 	}
+	// Use of docker host, not the container host
 	if hostname, err := os.Hostname(); err == nil {
 		docker = append(docker, "--hostname", hostname)
 	}
-	if b.Type == "local" {
+	switch b.Type {
+	case "local":
 		actual := env["RESTIC_REPOSITORY"]
 		docker = append(docker, "--volume", actual+":"+"/repo")
 		env["RESTIC_REPOSITORY"] = "/repo"
+	case "b2":
+	case "s3":
+	case "azure":
+	case "gs":
+		// No additional setup needed
+	case "rclone":
+		// Read host rclone config and mount it into the container
+		configFile, err := ExecuteCommand(ExecuteOptions{Command: "rclone"}, "config", "file")
+		if err != nil {
+			return "", err
+		}
+		splitted := strings.Split(strings.TrimSpace(configFile), "\n")
+		configFilePath := splitted[len(splitted)-1]
+		docker = append(docker, "--volume", configFilePath+":"+"/root/.config/rclone/rclone.conf:ro")
+		// Install rclone in the container
+		args = append([]string{"apk", "add", "rclone", "&&"}, args...)
+	default:
+		return "", fmt.Errorf("Backend type \"%s\" is not supported as volume endpoint", b.Type)
 	}
 	for key, value := range env {
 		docker = append(docker, "--env", key+"="+value)
 	}
-	docker = append(docker, "restic/restic", "-c", "restic "+strings.Join(args, " "))
+	docker = append(docker, "restic/restic", "-c", strings.Join(args, " "))
 	out, err := ExecuteCommand(options, docker...)
 	return out, err
 }

internal/bins/bins.go

@@ -47,11 +47,11 @@ func dlJSON(url string) (GithubRelease, error) {
 
 func Uninstall(restic bool) error {
 	if err := os.Remove(path.Join(INSTALL_PATH, "autorestic")); err != nil {
-		colors.Error.Println(err)
+		return err
 	}
 	if restic {
 		if err := os.Remove(path.Join(INSTALL_PATH, "restic")); err != nil {
-			colors.Error.Println(err)
+			return err
 		}
 	}
 	return nil
@@ -79,11 +79,15 @@ func downloadAndInstallAsset(body GithubRelease, name string) error {
 				return err
 			}
 			defer tmp.Close()
-			tmp.Chmod(0755)
-			io.Copy(tmp, bz)
+			if err := tmp.Chmod(0755); err != nil {
+				return err
+			}
+			if _, err := io.Copy(tmp, bz); err != nil {
+				return err
+			}
 
 			to := path.Join(INSTALL_PATH, name)
-			os.Remove(to) // Delete if current, ignore error if file does not exits.
+			defer os.Remove(to) // Delete if current, ignore error if file does not exits.
 			if err := os.Rename(tmp.Name(), to); err != nil {
 				return nil
 			}
@@ -121,9 +125,11 @@ func Upgrade(restic bool) error {
 	// Upgrade restic
 	if restic {
 		if err := InstallRestic(); err != nil {
-			colors.Error.Println(err)
+			return err
+		}
+		if err := upgradeRestic(); err != nil {
+			return err
 		}
-		upgradeRestic()
 	}
 
 	// Upgrade self
@@ -140,7 +146,9 @@ func Upgrade(restic bool) error {
 		return err
 	}
 	if current.LT(latest) {
-		downloadAndInstallAsset(body, "autorestic")
+		if err := downloadAndInstallAsset(body, "autorestic"); err != nil {
+			return err
+		}
 		colors.Success.Println("Updated autorestic")
 	} else {
 		colors.Body.Println("Already up to date")

internal/config.go

@@ -2,44 +2,88 @@ package internal
 
 import (
 	"fmt"
+	"os"
 	"path"
+	"path/filepath"
 	"strings"
 	"sync"
 
 	"github.com/cupcakearmy/autorestic/internal/colors"
+	"github.com/cupcakearmy/autorestic/internal/lock"
+	"github.com/joho/godotenv"
 	"github.com/mitchellh/go-homedir"
 	"github.com/spf13/cobra"
 	"github.com/spf13/viper"
 )
 
-const VERSION = "1.0.8"
+const VERSION = "1.5.0"
 
 var CI bool = false
 var VERBOSE bool = false
 var CRON_LEAN bool = false
 
+type OptionMap map[string][]interface{}
+type Options map[string]OptionMap
+
 type Config struct {
+	Version   string              `yaml:"version"`
+	Extras    interface{}         `yaml:"extras"`
 	Locations map[string]Location `yaml:"locations"`
 	Backends  map[string]Backend  `yaml:"backends"`
+	Global    Options             `yaml:"global"`
 }
 
 var once sync.Once
 var config *Config
 
+func exitConfig(err error, msg string) {
+	if err != nil {
+		colors.Error.Println(err)
+	}
+	if msg != "" {
+		colors.Error.Println(msg)
+	}
+	lock.Unlock()
+	os.Exit(1)
+}
+
 func GetConfig() *Config {
+
 	if config == nil {
 		once.Do(func() {
 			if err := viper.ReadInConfig(); err == nil {
 				if !CRON_LEAN {
-					colors.Faint.Println("Using config file:", viper.ConfigFileUsed())
+					absConfig, _ := filepath.Abs(viper.ConfigFileUsed())
+					colors.Faint.Println("Using config: \t", absConfig)
+					// Load env file
+					envFile := filepath.Join(filepath.Dir(absConfig), ".autorestic.env")
+					err = godotenv.Load(envFile)
+					if err == nil {
+						colors.Faint.Println("Using env:\t", envFile)
+					}
 				}
 			} else {
 				return
 			}
 
+			var versionConfig interface{}
+			viper.UnmarshalKey("version", &versionConfig)
+			if versionConfig == nil {
+				exitConfig(nil, "no version specified in config file. please see docs on how to migrate")
+			}
+			version, ok := versionConfig.(int)
+			if !ok {
+				exitConfig(nil, "version specified in config file is not an int")
+			} else {
+				// Check for version
+				if version != 2 {
+					exitConfig(nil, "unsupported config version number. please check the docs for migration\nhttps://autorestic.vercel.app/migration/")
+				}
+			}
+
 			config = &Config{}
 			if err := viper.UnmarshalExact(config); err != nil {
-				panic(err)
+				exitConfig(err, "Could not parse config file!")
 			}
 		})
 	}
@@ -63,7 +107,11 @@ func (c *Config) Describe() {
 		var tmp string
 		colors.PrimaryPrint(`Location: "%s"`, name)
 
-		colors.PrintDescription("From", l.From)
+		tmp = ""
+		for _, path := range l.From {
+			tmp += fmt.Sprintf("\t%s %s\n", colors.Success.Sprint("←"), path)
+		}
+		colors.PrintDescription("From", tmp)
 
 		tmp = ""
 		for _, to := range l.To {
@@ -75,21 +123,22 @@ func (c *Config) Describe() {
 			colors.PrintDescription("Cron", l.Cron)
 		}
 
-		after, before := len(l.Hooks.After), len(l.Hooks.Before)
-		if after+before > 0 {
-			tmp = ""
-			if before > 0 {
-				tmp += "\tBefore"
-				for _, cmd := range l.Hooks.Before {
-					tmp += colors.Faint.Sprintf("\n\t  ▶ %s", cmd)
-				}
-			}
-			if after > 0 {
-				tmp += "\n\tAfter"
-				for _, cmd := range l.Hooks.After {
+		tmp = ""
+		hooks := map[string][]string{
+			"Before":  l.Hooks.Before,
+			"After":   l.Hooks.After,
+			"Failure": l.Hooks.Failure,
+			"Success": l.Hooks.Success,
+		}
+		for hook, commands := range hooks {
+			if len(commands) > 0 {
+				tmp += "\n\t" + hook
+				for _, cmd := range commands {
 					tmp += colors.Faint.Sprintf("\n\t  ▶ %s", cmd)
 				}
 			}
+		}
+		if tmp != "" {
 			colors.PrintDescription("Hooks", tmp)
 		}
 
@@ -129,7 +178,7 @@ func CheckConfig() error {
 		return fmt.Errorf("config could not be loaded/found")
 	}
 	if !CheckIfResticIsCallable() {
-		return fmt.Errorf(`restic was not found. Install either with "autorestic install" or manually`)
+		return fmt.Errorf(`%s was not found. Install either with "autorestic install" or manually`, RESTIC_BIN)
 	}
 	for name, backend := range c.Backends {
 		backend.name = name
@@ -139,7 +188,7 @@ func CheckConfig() error {
 	}
 	for name, location := range c.Locations {
 		location.name = name
-		if err := location.validate(c); err != nil {
+		if err := location.validate(); err != nil {
 			return err
 		}
 	}
@@ -170,20 +219,18 @@ func GetAllOrSelected(cmd *cobra.Command, backends bool) ([]string, error) {
 		selected, _ = cmd.Flags().GetStringSlice("location")
 	}
 	for _, s := range selected {
-		found := false
+		var splitted = strings.Split(s, "@")
 		for _, l := range list {
-			if l == s {
-				found = true
-				break
+			if l == splitted[0] {
+				goto found
 			}
 		}
-		if !found {
-			if backends {
-				return nil, fmt.Errorf("invalid backend \"%s\"", s)
-			} else {
-				return nil, fmt.Errorf("invalid location \"%s\"", s)
-			}
+		if backends {
+			return nil, fmt.Errorf("invalid backend \"%s\"", s)
+		} else {
+			return nil, fmt.Errorf("invalid location \"%s\"", s)
 		}
+	found:
 	}
 
 	if len(selected) == 0 {
@@ -219,3 +266,48 @@ func (c *Config) SaveConfig() error {
 
 	return viper.WriteConfig()
 }
+
+func optionToString(option string) string {
+	if !strings.HasPrefix(option, "-") {
+		return "--" + option
+	}
+	return option
+}
+
+func appendOptionsToSlice(str *[]string, options OptionMap) {
+	for key, values := range options {
+		for _, value := range values {
+			// Bool
+			asBool, ok := value.(bool)
+			if ok && asBool {
+				*str = append(*str, optionToString(key))
+				continue
+			}
+			*str = append(*str, optionToString(key), fmt.Sprint(value))
+		}
+	}
+}
+
+func getOptions(options Options, key string) []string {
+	var selected []string
+	var keys = []string{"all"}
+	if key != "" {
+		keys = append(keys, key)
+	}
+	for _, key := range keys {
+		appendOptionsToSlice(&selected, options[key])
+	}
+	return selected
+}
+
+func combineOptions(key string, l Location, b Backend) []string {
+	// Priority: location > backend > global
+	var options []string
+	gFlags := getOptions(GetConfig().Global, key)
+	bFlags := getOptions(b.Options, key)
+	lFlags := getOptions(l.Options, key)
+	options = append(options, gFlags...)
+	options = append(options, bFlags...)
+	options = append(options, lFlags...)
+	return options
+}

internal/location.go

@@ -10,29 +10,31 @@ import (
 
 	"github.com/cupcakearmy/autorestic/internal/colors"
 	"github.com/cupcakearmy/autorestic/internal/lock"
+	"github.com/cupcakearmy/autorestic/internal/metadata"
 	"github.com/robfig/cron"
 )
 
 type LocationType string
 
 const (
-	TypeLocal    LocationType = "local"
-	TypeVolume   LocationType = "volume"
-	VolumePrefix string       = "volume:"
+	TypeLocal  LocationType = "local"
+	TypeVolume LocationType = "volume"
 )
 
 type HookArray = []string
 
 type Hooks struct {
-	Before HookArray `yaml:"before"`
-	After  HookArray `yaml:"after"`
+	Dir     string    `yaml:"dir"`
+	Before  HookArray `yaml:"before,omitempty"`
+	After   HookArray `yaml:"after,omitempty"`
+	Success HookArray `yaml:"success,omitempty"`
+	Failure HookArray `yaml:"failure,omitempty"`
 }
 
-type Options map[string]map[string][]string
-
 type Location struct {
 	name    string   `yaml:",omitempty"`
-	From    string   `yaml:"from,omitempty"`
+	From    []string `yaml:"from,omitempty"`
+	Type    string   `yaml:"type,omitempty"`
 	To      []string `yaml:"to,omitempty"`
 	Hooks   Hooks    `yaml:"hooks,omitempty"`
 	Cron    string   `yaml:"cron,omitempty"`
@@ -45,20 +47,33 @@ func GetLocation(name string) (Location, bool) {
 	return l, ok
 }
 
-func (l Location) validate(c *Config) error {
-	if l.From == "" {
+func (l Location) validate() error {
+	if len(l.From) == 0 {
 		return fmt.Errorf(`Location "%s" is missing "from" key`, l.name)
 	}
-	if from, err := GetPathRelativeToConfig(l.From); err != nil {
+	t, err := l.getType()
+	if err != nil {
 		return err
-	} else {
-		if stat, err := os.Stat(from); err != nil {
-			return err
-		} else {
-			if !stat.IsDir() {
-				return fmt.Errorf("\"%s\" is not valid directory for location \"%s\"", from, l.name)
+	}
+	switch t {
+	case TypeLocal:
+		for _, path := range l.From {
+			if from, err := GetPathRelativeToConfig(path); err != nil {
+				return err
+			} else {
+				if stat, err := os.Stat(from); err != nil {
+					return err
+				} else {
+					if !stat.IsDir() {
+						return fmt.Errorf("\"%s\" is not valid directory for location \"%s\"", from, l.name)
+					}
+				}
 			}
 		}
+	case TypeVolume:
+		if len(l.From) > 1 {
+			return fmt.Errorf(`location "%s" has more than one docker volume`, l.name)
+		}
 	}
 
 	if len(l.To) == 0 {
@@ -74,21 +89,17 @@ func (l Location) validate(c *Config) error {
 	return nil
 }
 
-func (l Location) getOptions(key string) []string {
-	var options []string
-	saved := l.Options[key]
-	for k, values := range saved {
-		for _, value := range values {
-			options = append(options, fmt.Sprintf("--%s", k), value)
-		}
-	}
-	return options
-}
-
-func ExecuteHooks(commands []string, options ExecuteOptions) error {
+func (l Location) ExecuteHooks(commands []string, options ExecuteOptions) error {
 	if len(commands) == 0 {
 		return nil
 	}
+	if l.Hooks.Dir != "" {
+		if dir, err := GetPathRelativeToConfig(l.Hooks.Dir); err != nil {
+			return err
+		} else {
+			options.Dir = dir
+		}
+	}
 	colors.Secondary.Println("\nRunning hooks")
 	for _, command := range commands {
 		colors.Body.Println("> " + command)
@@ -105,81 +116,115 @@ func ExecuteHooks(commands []string, options ExecuteOptions) error {
 	return nil
 }
 
-func (l Location) getType() LocationType {
-	if strings.HasPrefix(l.From, VolumePrefix) {
-		return TypeVolume
+func (l Location) getType() (LocationType, error) {
+	t := strings.ToLower(l.Type)
+	if t == "" || t == "local" {
+		return TypeLocal, nil
+	} else if t == "volume" {
+		return TypeVolume, nil
 	}
-	return TypeLocal
+	return "", fmt.Errorf("invalid location type \"%s\"", l.Type)
 }
 
-func (l Location) getVolumeName() string {
-	return strings.TrimPrefix(l.From, VolumePrefix)
+func buildTag(parts ...string) string {
+	parts = append([]string{"ar"}, parts...)
+	return strings.Join(parts, ":")
 }
 
-func (l Location) getPath() (string, error) {
-	t := l.getType()
-	switch t {
-	case TypeLocal:
-		if path, err := GetPathRelativeToConfig(l.From); err != nil {
-			return "", err
-		} else {
-			return path, nil
-		}
-	case TypeVolume:
-		return "/volume/" + l.name + "/" + l.getVolumeName(), nil
-	}
-	return "", fmt.Errorf("could not get path for location \"%s\"", l.name)
+func (l Location) getLocationTags() string {
+	return buildTag("location", l.name)
 }
 
-func (l Location) Backup(cron bool) error {
+func (l Location) Backup(cron bool, specificBackend string) []error {
+	var errors []error
+	var backends []string
 	colors.PrimaryPrint("  Backing up location \"%s\"  ", l.name)
-	t := l.getType()
+	t, err := l.getType()
+	if err != nil {
+		errors = append(errors, err)
+		return errors
+	}
+	cwd, _ := GetPathRelativeToConfig(".")
 	options := ExecuteOptions{
 		Command: "bash",
+		Dir:     cwd,
+		Envs: map[string]string{
+			"AUTORESTIC_LOCATION": l.name,
+		},
 	}
 
-	if t == TypeLocal {
-		dir, _ := GetPathRelativeToConfig(l.From)
-		options.Dir = dir
+	if err := l.validate(); err != nil {
+		errors = append(errors, err)
+		goto after
 	}
 
 	// Hooks
-	if err := ExecuteHooks(l.Hooks.Before, options); err != nil {
-		return err
+	if err := l.ExecuteHooks(l.Hooks.Before, options); err != nil {
+		errors = append(errors, err)
+		goto after
 	}
 
 	// Backup
-	for _, to := range l.To {
+	if specificBackend == "" {
+		backends = l.To
+	} else {
+		if l.hasBackend(specificBackend) {
+			backends = []string{specificBackend}
+		} else {
+			errors = append(errors, fmt.Errorf("backup location \"%s\" has no backend \"%s\"", l.name, specificBackend))
+			return errors
+		}
+	}
+	for i, to := range backends {
 		backend, _ := GetBackend(to)
 		colors.Secondary.Printf("Backend: %s\n", backend.name)
 		env, err := backend.getEnv()
 		if err != nil {
-			return nil
+			errors = append(errors, err)
+			continue
 		}
 
-		flags := l.getOptions("backup")
 		cmd := []string{"backup"}
-		cmd = append(cmd, flags...)
+		cmd = append(cmd, combineOptions("backup", l, backend)...)
 		if cron {
-			cmd = append(cmd, "--tag", "cron")
+			cmd = append(cmd, "--tag", buildTag("cron"))
 		}
-		cmd = append(cmd, ".")
+		cmd = append(cmd, "--tag", l.getLocationTags())
 		backupOptions := ExecuteOptions{
-			Dir:  options.Dir,
 			Envs: env,
 		}
 
 		var out string
-
 		switch t {
 		case TypeLocal:
+			for _, from := range l.From {
+				path, err := GetPathRelativeToConfig(from)
+				if err != nil {
+					errors = append(errors, err)
+					goto after
+				}
+				cmd = append(cmd, path)
+			}
 			out, err = ExecuteResticCommand(backupOptions, cmd...)
 		case TypeVolume:
+			ok := CheckIfVolumeExists(l.From[0])
+			if !ok {
+				errors = append(errors, fmt.Errorf("volume \"%s\" does not exist", l.From[0]))
+				continue
+			}
+			cmd = append(cmd, "/data")
 			out, err = backend.ExecDocker(l, cmd)
 		}
 		if err != nil {
-			colors.Error.Println(out)
-			return err
+			errors = append(errors, err)
+			continue
+		}
+
+		md := metadata.ExtractMetadataFromBackupLog(out)
+		mdEnv := metadata.MakeEnvFromMetadata(&md)
+		for k, v := range mdEnv {
+			options.Envs[k+"_"+fmt.Sprint(i)] = v
+			options.Envs[k+"_"+strings.ToUpper(backend.name)] = v
 		}
 		if VERBOSE {
 			colors.Faint.Println(out)
@@ -187,21 +232,30 @@ func (l Location) Backup(cron bool) error {
 	}
 
 	// After hooks
-	if err := ExecuteHooks(l.Hooks.After, options); err != nil {
-		return err
+	if err := l.ExecuteHooks(l.Hooks.After, options); err != nil {
+		errors = append(errors, err)
 	}
-	colors.Success.Println("Done")
-	return nil
+
+after:
+	var commands []string
+	if len(errors) > 0 {
+		commands = l.Hooks.Failure
+	} else {
+		commands = l.Hooks.Success
+	}
+	if err := l.ExecuteHooks(commands, options); err != nil {
+		errors = append(errors, err)
+	}
+
+	if len(errors) == 0 {
+		colors.Success.Println("Done")
+	}
+	return errors
 }
 
 func (l Location) Forget(prune bool, dry bool) error {
 	colors.PrimaryPrint("Forgetting for location \"%s\"", l.name)
 
-	path, err := l.getPath()
-	if err != nil {
-		return err
-	}
-
 	for _, to := range l.To {
 		backend, _ := GetBackend(to)
 		colors.Secondary.Printf("For backend \"%s\"\n", backend.name)
@@ -212,15 +266,14 @@ func (l Location) Forget(prune bool, dry bool) error {
 		options := ExecuteOptions{
 			Envs: env,
 		}
-		flags := l.getOptions("forget")
-		cmd := []string{"forget", "--path", path}
+		cmd := []string{"forget", "--tag", l.getLocationTags()}
 		if prune {
 			cmd = append(cmd, "--prune")
 		}
 		if dry {
 			cmd = append(cmd, "--dry-run")
 		}
-		cmd = append(cmd, flags...)
+		cmd = append(cmd, combineOptions("forget", l, backend)...)
 		out, err := ExecuteResticCommand(options, cmd...)
 		if VERBOSE {
 			colors.Faint.Println(out)
@@ -242,7 +295,7 @@ func (l Location) hasBackend(backend string) bool {
 	return false
 }
 
-func (l Location) Restore(to, from string, force bool) error {
+func (l Location) Restore(to, from string, force bool, snapshot string) error {
 	if from == "" {
 		from = l.To[0]
 	} else if !l.hasBackend(from) {
@@ -253,16 +306,20 @@ func (l Location) Restore(to, from string, force bool) error {
 	if err != nil {
 		return err
 	}
-	colors.PrimaryPrint("Restoring location \"%s\"", l.name)
 
-	backend, _ := GetBackend(from)
-	path, err := l.getPath()
-	if err != nil {
-		return nil
+	if snapshot == "" {
+		snapshot = "latest"
 	}
-	colors.Secondary.Println("Restoring lastest snapshot")
-	colors.Body.Printf("%s → %s.\n", from, path)
-	switch l.getType() {
+
+	colors.PrimaryPrint("Restoring location \"%s\"", l.name)
+	backend, _ := GetBackend(from)
+	colors.Secondary.Printf("Restoring %s@%s → %s\n", snapshot, backend.name, to)
+
+	t, err := l.getType()
+	if err != nil {
+		return err
+	}
+	switch t {
 	case TypeLocal:
 		// Check if target is empty
 		if !force {
@@ -282,9 +339,9 @@ func (l Location) Restore(to, from string, force bool) error {
 				}
 			}
 		}
-		err = backend.Exec([]string{"restore", "--target", to, "--path", path, "latest"})
+		err = backend.Exec([]string{"restore", "--target", to, "--tag", l.getLocationTags(), snapshot})
 	case TypeVolume:
-		_, err = backend.ExecDocker(l, []string{"restore", "--target", ".", "--path", path, "latest"})
+		_, err = backend.ExecDocker(l, []string{"restore", "--target", "/", "--tag", l.getLocationTags(), snapshot})
 	}
 	if err != nil {
 		return err
@@ -307,7 +364,7 @@ func (l Location) RunCron() error {
 	now := time.Now()
 	if now.After(next) {
 		lock.SetCron(l.name, now.Unix())
-		l.Backup(true)
+		l.Backup(true, "")
 	} else {
 		if !CRON_LEAN {
 			colors.Body.Printf("Skipping \"%s\", not due yet.\n", l.name)

internal/metadata/extractor_added.go

@@ -0,0 +1,22 @@
+package metadata
+
+import (
+	"regexp"
+	"strings"
+)
+
+type addedExtractor struct {
+	re *regexp.Regexp
+}
+
+func (e addedExtractor) Matches(line string) bool {
+	return e.re.MatchString(line)
+}
+func (e addedExtractor) Extract(metadata *BackupLogMetadata, line string) {
+	// Sample line: "Added to the repo: 0 B"
+	metadata.AddedSize = strings.TrimSpace(e.re.ReplaceAllString(line, ""))
+}
+
+func NewAddedExtractor() MetadatExtractor {
+	return addedExtractor{regexp.MustCompile(`(?i)^Added to the repo:`)}
+}

internal/metadata/extractor_changeset.go

@@ -0,0 +1,57 @@
+package metadata
+
+import (
+	"regexp"
+	"strings"
+)
+
+type ChangeSetExtractor struct {
+	re      *regexp.Regexp
+	cleaner *regexp.Regexp
+	saver   changeSetSaver
+}
+
+func (e ChangeSetExtractor) Matches(line string) bool {
+	return e.re.MatchString(line)
+}
+func (e ChangeSetExtractor) Extract(metadata *BackupLogMetadata, line string) {
+	// Sample line: "Files:           0 new,     0 changed,     2 unmodified"
+	trimmed := strings.TrimSpace(e.re.ReplaceAllString(line, ""))
+	splitted := strings.Split(trimmed, ",")
+	var changeset BackupLogMetadataChangeset = BackupLogMetadataChangeset{}
+	changeset.Added = e.cleaner.ReplaceAllString(splitted[0], "")
+	changeset.Changed = e.cleaner.ReplaceAllString(splitted[1], "")
+	changeset.Unmodified = e.cleaner.ReplaceAllString(splitted[2], "")
+	e.saver.Save(metadata, changeset)
+}
+
+type changeSetSaver interface {
+	Save(metadata *BackupLogMetadata, changeset BackupLogMetadataChangeset)
+}
+
+type fileSaver struct{}
+
+func (f fileSaver) Save(metadata *BackupLogMetadata, changeset BackupLogMetadataChangeset) {
+	metadata.Files = changeset
+}
+
+type dirsSaver struct{}
+
+func (d dirsSaver) Save(metadata *BackupLogMetadata, changeset BackupLogMetadataChangeset) {
+	metadata.Dirs = changeset
+}
+
+func NewFilesExtractor() MetadatExtractor {
+	return ChangeSetExtractor{
+		re:      regexp.MustCompile(`(?i)^Files:`),
+		cleaner: regexp.MustCompile(`[^\d]`),
+		saver:   fileSaver{},
+	}
+}
+func NewDirsExtractor() MetadatExtractor {
+	return ChangeSetExtractor{
+		re:      regexp.MustCompile(`(?i)^Dirs:`),
+		cleaner: regexp.MustCompile(`[^\d]`),
+		saver:   dirsSaver{},
+	}
+}

internal/metadata/extractor_parent.go

@@ -0,0 +1,22 @@
+package metadata
+
+import (
+	"regexp"
+	"strings"
+)
+
+type parentSnapshotIDExtractor struct {
+	re *regexp.Regexp
+}
+
+func (e parentSnapshotIDExtractor) Matches(line string) bool {
+	return e.re.MatchString(line)
+}
+func (e parentSnapshotIDExtractor) Extract(metadata *BackupLogMetadata, line string) {
+	// Sample line: "using parent snapshot c65d9310"
+	metadata.ParentSnapshotID = strings.TrimSpace(e.re.ReplaceAllString(line, ""))
+}
+
+func NewParentSnapshotIDExtractor() MetadatExtractor {
+	return parentSnapshotIDExtractor{regexp.MustCompile(`(?i)^using parent snapshot`)}
+}

internal/metadata/extractor_processed.go

@@ -0,0 +1,32 @@
+package metadata
+
+import (
+	"regexp"
+	"strings"
+)
+
+type processedExtractor struct {
+	re      *regexp.Regexp
+	cleaner *regexp.Regexp
+}
+
+func (e processedExtractor) Matches(line string) bool {
+	return e.re.MatchString(line)
+}
+func (e processedExtractor) Extract(metadata *BackupLogMetadata, line string) {
+	// Sample line: "processed 2 files, 24 B in 0:00"
+	var processed = BackupLogMetadataProcessed{}
+	split := strings.Split(line, "in")
+	processed.Duration = strings.TrimSpace(split[1])
+	split = strings.Split(split[0], ",")
+	processed.Files = e.cleaner.ReplaceAllString(split[0], "")
+	processed.Size = strings.TrimSpace(split[1])
+	metadata.Processed = processed
+}
+
+func NewProcessedExtractor() MetadatExtractor {
+	return processedExtractor{
+		regexp.MustCompile(`(?i)^processed \d* files`),
+		regexp.MustCompile(`(?i)[^\d]`),
+	}
+}

internal/metadata/extractor_snapshot.go

@@ -0,0 +1,22 @@
+package metadata
+
+import (
+	"regexp"
+	"strings"
+)
+
+type snapshotExtractor struct {
+	re *regexp.Regexp
+}
+
+func (e snapshotExtractor) Matches(line string) bool {
+	return e.re.MatchString(line)
+}
+func (e snapshotExtractor) Extract(metadata *BackupLogMetadata, line string) {
+	// Sample line: "snapshot 917c7691 saved"
+	metadata.SnapshotID = strings.Split(line, " ")[1]
+}
+
+func NewSnapshotExtractor() MetadatExtractor {
+	return snapshotExtractor{regexp.MustCompile(`(?i)^snapshot \w+ saved`)}
+}

internal/metadata/metadata.go

@@ -0,0 +1,72 @@
+package metadata
+
+import (
+	"strings"
+)
+
+type BackupLogMetadataChangeset struct {
+	Added      string
+	Changed    string
+	Unmodified string
+}
+type BackupLogMetadataProcessed struct {
+	Files    string
+	Size     string
+	Duration string
+}
+type BackupLogMetadata struct {
+	ParentSnapshotID string
+	Files            BackupLogMetadataChangeset
+	Dirs             BackupLogMetadataChangeset
+	AddedSize        string
+	Processed        BackupLogMetadataProcessed
+	SnapshotID       string
+}
+
+type MetadatExtractor interface {
+	Matches(line string) bool
+	Extract(metadata *BackupLogMetadata, line string)
+}
+
+var extractors = []MetadatExtractor{
+	NewParentSnapshotIDExtractor(),
+	NewFilesExtractor(),
+	NewDirsExtractor(),
+	NewAddedExtractor(),
+	NewProcessedExtractor(),
+	NewSnapshotExtractor(),
+}
+
+func ExtractMetadataFromBackupLog(log string) BackupLogMetadata {
+	var md BackupLogMetadata
+	for _, line := range strings.Split(log, "\n") {
+		line = strings.TrimSpace(line)
+		for _, extractor := range extractors {
+			if extractor.Matches(line) {
+				extractor.Extract(&md, line)
+				continue
+			}
+		}
+	}
+	return md
+}
+
+func MakeEnvFromMetadata(metadata *BackupLogMetadata) map[string]string {
+	env := make(map[string]string)
+	var prefix = "AUTORESTIC_"
+
+	env[prefix+"SNAPSHOT_ID"] = metadata.SnapshotID
+	env[prefix+"PARENT_SNAPSHOT_ID"] = metadata.ParentSnapshotID
+	env[prefix+"FILES_ADDED"] = metadata.Files.Added
+	env[prefix+"FILES_CHANGED"] = metadata.Files.Changed
+	env[prefix+"FILES_UNMODIFIED"] = metadata.Files.Unmodified
+	env[prefix+"DIRS_ADDED"] = metadata.Dirs.Added
+	env[prefix+"DIRS_CHANGED"] = metadata.Dirs.Changed
+	env[prefix+"DIRS_UNMODIFIED"] = metadata.Dirs.Unmodified
+	env[prefix+"ADDED_SIZE"] = metadata.AddedSize
+	env[prefix+"PROCESSED_FILES"] = metadata.Processed.Files
+	env[prefix+"PROCESSED_SIZE"] = metadata.Processed.Size
+	env[prefix+"PROCESSED_DURATION"] = metadata.Processed.Duration
+
+	return env
+}

internal/utils.go

@@ -10,13 +10,15 @@ import (
 	"github.com/cupcakearmy/autorestic/internal/colors"
 )
 
+var RESTIC_BIN string
+
 func CheckIfCommandIsCallable(cmd string) bool {
 	_, err := exec.LookPath(cmd)
 	return err == nil
 }
 
 func CheckIfResticIsCallable() bool {
-	return CheckIfCommandIsCallable("restic")
+	return CheckIfCommandIsCallable(RESTIC_BIN)
 }
 
 type ExecuteOptions struct {
@@ -50,7 +52,10 @@ func ExecuteCommand(options ExecuteOptions, args ...string) (string, error) {
 }
 
 func ExecuteResticCommand(options ExecuteOptions, args ...string) (string, error) {
-	options.Command = "restic"
+	options.Command = RESTIC_BIN
+	var c = GetConfig()
+	var optionsAsString = getOptions(c.Global, "")
+	args = append(optionsAsString, args...)
 	return ExecuteCommand(options, args...)
 }
 
@@ -72,3 +77,8 @@ func CopyFile(from, to string) error {
 	}
 	return nil
 }
+
+func CheckIfVolumeExists(volume string) bool {
+	_, err := ExecuteCommand(ExecuteOptions{Command: "docker"}, "volume", "inspect", volume)
+	return err == nil
+}