changelog

Update update command in docs

.github/workflows/build.yml

@@ -15,6 +15,11 @@ jobs:
           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:

CHANGELOG.md

@@ -5,6 +5,69 @@ 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.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
+
+- `--lean` flag to cron command for less output about skipping backups.
+
+### Fixed
+
+- consistent lower casing in usage descriptions.
+
+## [1.0.7] - 2021-04-26
+
+### Added
+
+- Support for `darwin/arm64` aka Apple Silicon.
+- Added support for `arm64` and `aarch64` in install scripts.
+
+## [1.0.6] - 2021-04-24
+
+### Added
+
+- Support for rclone
+
+## [1.0.5] - 2021-04-24
+
+### Fixed
+
+- Correct exit code on backup failure and better logging/output/feedback.
+- Check if `from` key is an actual directory.
+
+## [1.0.4] - 2021-04-23
+
+### Added
+
+- Options to add rest username and password in config
+
+### Fixed
+
+- Don't add empty strings when saving config
+
 ## [1.0.3] - 2021-04-20
 
 ### Fixed

DEVELOPMENT.md

@@ -0,0 +1,30 @@
+# Development
+
+## Coding
+
+The easiest way (imo) is to run [`gowatch`](https://github.com/silenceper/gowatch) in a separate terminal and the simply run `./autorestic ...`. `gowatch` will watch the code and automatically rebuild the binary when changes are saved to disk.
+
+## Building
+
+```bash
+go run build/build.go
+```
+
+This will build and compress binaries for multiple platforms. The output will be put in the `dist` folder.
+
+## Releasing
+
+Releases are automatically built by the github workflow and uploaded to the release.
+
+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.
+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

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>
 
@@ -35,4 +42,9 @@ 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
+
+PRs, feature requests, etc. are welcomed :)
+Have a look at [the dev docs](./DEVELOPMENT.md)

RELEASE.md

@@ -1,9 +0,0 @@
-# Releasing
-
-Releases are automatically built by the github workflow and uploaded to the release.
-
-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.
-5. The Github action will build the binaries, upload and mark the release as ready when done.

build/build.go

@@ -9,6 +9,7 @@ import (
 	"os/exec"
 	"path"
 	"path/filepath"
+	"sync"
 
 	"github.com/cupcakearmy/autorestic/internal"
 )
@@ -16,7 +17,7 @@ import (
 var DIR, _ = filepath.Abs("./dist")
 
 var targets = map[string][]string{
-	"darwin":  {"amd64"},
+	"darwin":  {"amd64", "arm64"},
 	"freebsd": {"386", "amd64", "arm"},
 	"linux":   {"386", "amd64", "arm", "arm64"},
 	"netbsd":  {"386", "amd64"},
@@ -27,7 +28,7 @@ type buildOptions struct {
 	Target, Arch, Version string
 }
 
-func build(options buildOptions) error {
+func build(options buildOptions, wg *sync.WaitGroup) {
 	fmt.Printf("Building %s %s\n", options.Target, options.Arch)
 	out := fmt.Sprintf("autorestic_%s_%s_%s", options.Version, options.Target, options.Arch)
 	out = path.Join(DIR, out)
@@ -46,7 +47,7 @@ func build(options buildOptions) error {
 		)
 		err := c.Run()
 		if err != nil {
-			return err
+			panic(err)
 		}
 	}
 
@@ -58,26 +59,25 @@ func build(options buildOptions) error {
 		c.Stderr = os.Stderr
 		err := c.Run()
 		if err != nil {
-			return err
+			panic(err)
 		}
 	}
-
-	return nil
+	wg.Done()
 }
 
 func main() {
 	os.RemoveAll(DIR)
 	v := internal.VERSION
+	var wg sync.WaitGroup
 	for target, archs := range targets {
 		for _, arch := range archs {
-			err := build(buildOptions{
+			wg.Add(1)
+			build(buildOptions{
 				Target:  target,
 				Arch:    arch,
 				Version: v,
-			})
-			if err != nil {
-				panic(err)
-			}
+			}, &wg)
 		}
 	}
+	wg.Wait()
 }

cmd/backup.go

@@ -1,7 +1,10 @@
 package cmd
 
 import (
+	"fmt"
+
 	"github.com/cupcakearmy/autorestic/internal"
+	"github.com/cupcakearmy/autorestic/internal/colors"
 	"github.com/cupcakearmy/autorestic/internal/lock"
 	"github.com/spf13/cobra"
 )
@@ -14,13 +17,21 @@ var backupCmd = &cobra.Command{
 		CheckErr(err)
 		defer lock.Unlock()
 
-		CheckErr(internal.CheckConfig())
+		internal.GetConfig()
 
 		selected, err := internal.GetAllOrSelected(cmd, false)
 		CheckErr(err)
+		errors := 0
 		for _, name := range selected {
 			location, _ := internal.GetLocation(name)
-			location.Backup(false)
+			errs := location.Backup(false)
+			for err := range errs {
+				colors.Error.Println(err)
+				errors++
+			}
+		}
+		if errors > 0 {
+			CheckErr(fmt.Errorf("%d errors were found", errors))
 		}
 	},
 }

cmd/check.go

@@ -17,7 +17,7 @@ var checkCmd = &cobra.Command{
 
 		CheckErr(internal.CheckConfig())
 
-		colors.Success.Println("Everyting is fine.")
+		colors.Success.Println("Everything is fine.")
 	},
 }
 

cmd/cron.go

@@ -11,6 +11,7 @@ var cronCmd = &cobra.Command{
 	Short: "Run cron job for automated backups",
 	Long:  `Intended to be mainly triggered by an automated system like systemd or crontab. For each location checks if a cron backup is due and runs it.`,
 	Run: func(cmd *cobra.Command, args []string) {
+		internal.CRON_LEAN, _ = cmd.Flags().GetBool("lean")
 		err := lock.Lock()
 		CheckErr(err)
 		defer lock.Unlock()
@@ -22,4 +23,5 @@ var cronCmd = &cobra.Command{
 
 func init() {
 	rootCmd.AddCommand(cronCmd)
+	cronCmd.Flags().Bool("lean", false, "only output information about actual backups")
 }

cmd/forget.go

@@ -31,6 +31,6 @@ var forgetCmd = &cobra.Command{
 func init() {
 	rootCmd.AddCommand(forgetCmd)
 	internal.AddFlagsToCommand(forgetCmd, false)
-	forgetCmd.Flags().Bool("prune", false, "Also prune repository")
-	forgetCmd.Flags().Bool("dry-run", false, "Do not write changes, show what would be affected")
+	forgetCmd.Flags().Bool("prune", false, "also prune repository")
+	forgetCmd.Flags().Bool("dry-run", false, "do not write changes, show what would be affected")
 }

cmd/root.go

@@ -37,6 +37,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)
 }
 
@@ -57,5 +58,4 @@ func initConfig() {
 		viper.SetConfigName(".autorestic")
 	}
 	viper.AutomaticEnv()
-	internal.GetConfig()
 }

cmd/uninstall.go

@@ -16,5 +16,5 @@ var uninstallCmd = &cobra.Command{
 
 func init() {
 	rootCmd.AddCommand(uninstallCmd)
-	uninstallCmd.Flags().Bool("no-restic", false, "Do not uninstall restic.")
+	uninstallCmd.Flags().Bool("no-restic", false, "do not uninstall restic.")
 }

cmd/upgrade.go

@@ -17,5 +17,5 @@ var upgradeCmd = &cobra.Command{
 
 func init() {
 	rootCmd.AddCommand(upgradeCmd)
-	upgradeCmd.Flags().Bool("no-restic", false, "Also update restic. Default: true")
+	upgradeCmd.Flags().Bool("no-restic", false, "also update restic")
 }

docs/.codedoc/package.json

@@ -1,5 +1,5 @@
 {
   "dependencies": {
-    "@codedoc/core": "^0.2.15"
+    "@codedoc/core": "^0.2.23"
   }
 }

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,12 +22,14 @@
 >
 > [Overview](/backend/overview)
 > [Available Backends](/backend/available)
+> [Options](/backend/options)
 
 > :Collapse label=CLI
 >
 > [General](/cli/general)
 > [Info](/cli/info)
 > [Check](/cli/check)
+> [Completion](/cli/completion)
 > [Backup](/cli/backup)
 > [Restore](/cli/restore)
 > [Forget](/cli/forget)
@@ -29,7 +37,7 @@
 > [Exec](/cli/exec)
 > [Install](/cli/install)
 > [Uninstall](/cli/uninstall)
-> [Update](/cli/update)
+> [Upgrade](/cli/upgrade)
 
 [Examples](/examples)
 

docs/markdown/backend/available.md

@@ -19,11 +19,18 @@ backends:
 backends:
   name-of-backend:
     type: b2
-    path: 'myAccount:myBucket/my/path'
-    B2_ACCOUNT_ID: backblaze_account_id
-    B2_ACCOUNT_KEY: backblaze_account_key
+    path: 'backblaze_bucketID'
+    # Or With a path
+    # path: 'backblaze_bucketID:/some/path'
+    env:
+      B2_ACCOUNT_ID: 'backblaze_keyID'
+      B2_ACCOUNT_KEY: 'backblaze_applicationKey'
 ```
 
+#### 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'`).
+
 ## S3 / Minio
 
 ```yaml
@@ -33,8 +40,9 @@ backends:
     path: s3.amazonaws.com/bucket_name
     # Minio
     # path: http://localhost:9000/bucket_name
-    AWS_ACCESS_KEY_ID: my_key
-    AWS_SECRET_ACCESS_KEY: my_secret
+    env:
+      AWS_ACCESS_KEY_ID: my_key
+      AWS_SECRET_ACCESS_KEY: my_secret
 ```
 
 ## SFTP
@@ -57,6 +65,21 @@ backends:
   name-of-backend:
     type: rest
     path: http://localhost:8000/repo_name
+    # Or authenticated
+    path: https://user:pass@host:6969/path
+```
+
+Optionally you can set user and password separately
+
+```yaml
+backends:
+  rest:
+    type: rest
+    path: http://localhost:6969/path
+    key: ...
+    rest:
+      user: user
+      password: pass
 ```
 
 > :ToCPrevNext

docs/markdown/backend/options.md

@@ -0,0 +1,23 @@
+# Options
+
+For the `backup` and `forget` commands you can pass any native flags to `restic`.
+
+> It is also possible to set options for an [a specific location](/location/options).
+
+```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.
+
+For more detail see the [location docs](/location/options) for options, as they are the same
+
+> :ToCPrevNext

docs/markdown/backend/overview.md

@@ -1,6 +1,6 @@
 # 💽 Backends
 
-Backends are the ouputs of the backup process. Each location needs at least one.
+Backends are the outputs of the backup process. Each location needs at least one.
 
 ```yaml | .autorestic.yml
 backends:

docs/markdown/cli/completion.md

@@ -0,0 +1,17 @@
+# Completion
+
+```bash
+autorestic completion [bash|zsh|fish|powershell]
+```
+
+Autorestic can generate shell completions automatically to make the experience even easier.
+Supported shells are
+
+- bash
+- zsh
+- fish
+- powershell
+
+To see how to install run `autorestic help completion` and follow the instructions for your specific shell
+
+> :ToCPrevNext

docs/markdown/cli/cron.md

@@ -1,11 +1,13 @@
 # Cron
 
 ```bash
-autorestic cron
+autorestic cron [--lean]
 ```
 
 This command is mostly intended to be triggered by an automated system like systemd or crontab.
 
-It will run cron jobs es [specified in the cron section](/locations/cron) of a specific location.
+It will run cron jobs as [specified in the cron section](/location/cron) of a specific location.
+
+The `--lean` flag will omit output like _skipping location x: not due yet_. This can be useful if you are dumping the output of the cron job to a log file and don't want to be overwhelmed by the output log.
 
 > :ToCPrevNext

docs/markdown/cli/exec.md

@@ -4,10 +4,10 @@
 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. 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 -a -- snapshots
+autorestic exec -av -- snapshots
 ```
 
 With `exec` you can basically run every cli command that you would be able to run with the restic cli. It only pre-fills path, key, etc.

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

@@ -26,3 +26,13 @@ Verbose mode will show the output of the native restic commands that are otherwi
 ```bash
 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,11 +1,13 @@
 # Restore
 
 ```bash
-autorestic restore [-l, --location] [--from backend] [--to <out dir>]
+autorestic restore [-l, --location] [--from backend] [--to <out dir>] [-f, --force]
 ```
 
 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.
 
+The `--to` path has 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.
+
 ## Example
 
 ```bash

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/contrib.md

@@ -2,7 +2,15 @@
 
 This amazing people helped the project!
 
-- @ChanceM [Docs]
-- @EliotBerriot [Docs, Pruning, S3]
+- @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
 
 > :ToCPrevNext

docs/markdown/examples.md

@@ -3,12 +3,12 @@
 ## List all the snapshots for all the backends
 
 ```bash
-autorestic exec -a -- snapshots
+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

@@ -8,4 +8,18 @@ Autorestic requires `curl`, `wget` and `bzip2` to be installed. For most systems
 curl -s https://raw.githubusercontent.com/CupCakeArmy/autorestic/master/install.sh | bash
 ```
 
+## Alternatives
+
+### 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/) by @n194.
+
 > :ToCPrevNext

docs/markdown/location/cron.md

@@ -1,6 +1,6 @@
 # Cron
 
-Often it is usefull to trigger backups autmatically. For this we can specify a `cron` attribute to each location.
+Often it is usefully to trigger backups automatically. For this we can specify a `cron` attribute to each location.
 
 ```yaml | .autorestic.yml
 locations:
@@ -14,11 +14,11 @@ Here is a awesome website with [some examples](https://crontab.guru/examples.htm
 
 ## Installing the cron
 
-**This has to be done only once, regadless of now many cros you have in your config file.**
+**This has to be done only once, regardless of now many cron jobs you have in your config file.**
 
-To actually enable cron jobs you need something to call `autorestic cron` on a timed shedule.
-Note that the shedule has nothing to do with the `cron` attribute in each location.
-My advise would be to trigger the command every 5min, but if you have a cronjob that runs only once a week, it's probably enough to shedule it once a day.
+To actually enable cron jobs you need something to call `autorestic cron` on a timed schedule.
+Note that the schedule has nothing to do with the `cron` attribute in each location.
+My advise would be to trigger the command every 5min, but if you have a cronjob that runs only once a week, it's probably enough to schedule it once a day.
 
 ### Crontab
 
@@ -30,14 +30,14 @@ First, open your crontab in edit mode
 crontab -e
 ```
 
-Then paste this at the bottom of the file and save it. Note that in this specific example the `.autorestic.yml` is located in `/srv/`. You need to modify that part of course to fit your config file.
+Then paste this at the bottom of the file and save it. Note that in this specific example the config file is located at one of the default locations (e.g. `~/.autorestic.yml`). If your config is somewhere else you'll need to specify it using the `-c` option.
 
 ```bash
 # This is required, as it otherwise cannot find restic as a command.
 PATH="/usr/local/bin:/usr/bin:/bin"
 
 # Example running every 5 minutes
-*/5 * * * * autorestic -c /srv/.autorestic.yml --ci cron
+*/5 * * * * autorestic --ci cron
 ```
 
 > The `--ci` option is not required, but recommended

docs/markdown/location/exclude.md

@@ -1,6 +1,6 @@
 # Excluding files
 
-If you want to exclude certain files or folders it done easily by specifiyng the right flags in the location you desire to filter.
+If you want to exclude certain files or folders it done easily by specifying the right flags in the location you desire to filter.
 
 The flags are taken straight from the [restic cli exclude rules](https://restic.readthedocs.io/en/latest/040_backup.html#excluding-files) so you can use any flag used there.
 

docs/markdown/location/forget.md

@@ -14,11 +14,11 @@ locations:
     options:
       forget:
         keep-last: 5 # always keep at least 5 snapshots
-        keep-hourly: 3 # keep 3 last hourly shapshots
-        keep-daily: 4 # keep 4 last daily shapshots
-        keep-weekly: 1 # keep 1 last weekly shapshots
-        keep-monthly: 12 # keep 12 last monthly shapshots
-        keep-yearly: 7 # keep 7 last yearly shapshots
+        keep-hourly: 3 # keep 3 last hourly snapshots
+        keep-daily: 4 # keep 4 last daily snapshots
+        keep-weekly: 1 # keep 1 last weekly snapshots
+        keep-monthly: 12 # keep 12 last monthly snapshots
+        keep-yearly: 7 # keep 7 last yearly snapshots
         keep-within: '2w' # keep snapshots from the last 2 weeks
 ```
 

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,25 @@ 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 error was encountered
+
+If the `before` hook encounters errors the backup and `after` hooks will be skipped and only the `failed` hooks will run.
+
 > :ToCPrevNext

docs/markdown/location/options.md

@@ -0,0 +1,21 @@
+# Options
+
+For the `backup` and `forget` commands you can pass any native flags to `restic`.
+
+> It is also possible to set options for an [entire backend](/backend/options).
+
+```yaml
+locations:
+  foo:
+    path: ...
+    to: ...
+    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/location/overview.md

@@ -22,6 +22,6 @@ Paths can be absolute or relative. If relative they are resolved relative to the
 
 ## `to`
 
-This is einther a single backend or an array of backends. The backends have to be configured in the same config file.
+This is either a single backend or an array of backends. The backends have to be configured in the same config file.
 
 > :ToCPrevNext

docs/markdown/quick.md

@@ -6,16 +6,18 @@
 curl -s https://raw.githubusercontent.com/CupCakeArmy/autorestic/master/install.sh | bash
 ```
 
+See [installation](/installation) for alternative options.
+
 ## Write a simple config file
 
 ```bash
-vim .autorestic.yml
+vim ~/.autorestic.yml
 ```
 
 For a quick overview:
 
 - `locations` can be seen as the inputs and `backends` the output where the data is stored and backed up.
-- One `location` can have one or multiple `backends` for redudancy.
+- One `location` can have one or multiple `backends` for redundancy.
 - One `backend` can also be the target for multiple `locations`.
 
 > **⚠️ WARNING ⚠️**
@@ -24,25 +26,26 @@ For a quick overview:
 
 ```yaml | .autorestic.yml
 locations:
-  - name: home
+  home:
     from: /home/me
     to: remote
 
-  - name: important
+  important:
     from: /path/to/important/stuff
     to:
       - remote
       - hdd
 
 backends:
-  - name: remote
+  remote:
     type: s3
     path: 's3.amazonaws.com/bucket_name'
     key: some-random-password-198rc79r8y1029c8yfewj8f1u0ef87yh198uoieufy
-    AWS_ACCESS_KEY_ID: account_id
-    AWS_SECRET_ACCESS_KEY: account_key
+    env:
+      AWS_ACCESS_KEY_ID: account_id
+      AWS_SECRET_ACCESS_KEY: account_key
 
-  - name: hdd
+  hdd:
     type: local
     path: /mnt/my_external_storage
     key: 'if not key is set it will be generated for you'
@@ -51,7 +54,7 @@ backends:
 ## Check
 
 ```bash
-autorestic check -a
+autorestic check
 ```
 
 This checks if the config file has any issues. If this is the first time this can take longer as autorestic will setup the backends.

docs/markdown/upgrade.md

@@ -1,4 +1,4 @@
-# Update
+# Upgrade
 
 ## From `0.x` to `1.0`
 

docs/package-lock.json

@@ -131,9 +131,9 @@
       }
     },
     "node_modules/chalk": {
-      "version": "4.1.0",
-      "resolved": "https://registry.npmjs.org/chalk/-/chalk-4.1.0.tgz",
-      "integrity": "sha512-qwx12AxXe2Q5xQ43Ac//I6v5aXTipYrSESdOgzrN+9XjgEpyjpKuvSGaN4qE93f7TQTlerQQ8S+EQ0EyDoVL1A==",
+      "version": "4.1.1",
+      "resolved": "https://registry.npmjs.org/chalk/-/chalk-4.1.1.tgz",
+      "integrity": "sha512-diHzdDKxcU+bAsUboHLPEDQiw0qEe0qd7SYUn3HgcFlWgbDcfLGswOHYeGrHKzG9z6UYf01d9VFMfZxPM1xZSg==",
       "dependencies": {
         "ansi-styles": "^4.1.0",
         "supports-color": "^7.1.0"
@@ -1153,9 +1153,9 @@
       }
     },
     "chalk": {
-      "version": "4.1.0",
-      "resolved": "https://registry.npmjs.org/chalk/-/chalk-4.1.0.tgz",
-      "integrity": "sha512-qwx12AxXe2Q5xQ43Ac//I6v5aXTipYrSESdOgzrN+9XjgEpyjpKuvSGaN4qE93f7TQTlerQQ8S+EQ0EyDoVL1A==",
+      "version": "4.1.1",
+      "resolved": "https://registry.npmjs.org/chalk/-/chalk-4.1.1.tgz",
+      "integrity": "sha512-diHzdDKxcU+bAsUboHLPEDQiw0qEe0qd7SYUn3HgcFlWgbDcfLGswOHYeGrHKzG9z6UYf01d9VFMfZxPM1xZSg==",
       "requires": {
         "ansi-styles": "^4.1.0",
         "supports-color": "^7.1.0"

install.sh

@@ -16,9 +16,11 @@ else
 fi
 echo $OS
 
-NATIVE_ARCH=$(uname -m)
+NATIVE_ARCH=$(uname -m | tr '[:upper:]' '[:lower:]')
 if [[ $NATIVE_ARCH == *"x86_64"* ]]; then
     ARCH=amd64
+elif [[ $NATIVE_ARCH == *"arm64"* || $NATIVE_ARCH == *"aarch64"* ]]; then
+    ARCH=arm64
 elif [[ $NATIVE_ARCH == *"x86"* ]]; then
     ARCH=386
 else
@@ -36,4 +38,4 @@ bzip2 -fd "${OUT_FILE}.bz2"
 chmod +x ${OUT_FILE}
 
 autorestic install
-echo "Succefsully installed autorestic"
+echo "Successfully installed autorestic"

internal/backend.go

@@ -4,19 +4,26 @@ import (
 	"crypto/rand"
 	"encoding/base64"
 	"fmt"
+	"net/url"
 	"os"
 	"strings"
 
 	"github.com/cupcakearmy/autorestic/internal/colors"
-	"github.com/spf13/viper"
 )
 
+type BackendRest struct {
+	User     string `yaml:"user,omitempty"`
+	Password string `yaml:"password,omitempty"`
+}
+
 type Backend struct {
-	name string
-	Type string            `mapstructure:"type,omitempty"`
-	Path string            `mapstructure:"path,omitempty"`
-	Key  string            `mapstructure:"key,omitempty"`
-	Env  map[string]string `mapstructure:"env,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) {
@@ -29,7 +36,20 @@ func (b Backend) generateRepo() (string, error) {
 	switch b.Type {
 	case "local":
 		return GetPathRelativeToConfig(b.Path)
-	case "b2", "azure", "gs", "s3", "sftp", "rest":
+	case "rest":
+		parsed, err := url.Parse(b.Path)
+		if err != nil {
+			return "", err
+		}
+		if b.Rest.User != "" {
+			if b.Rest.Password == "" {
+				parsed.User = url.User(b.Rest.User)
+			} else {
+				parsed.User = url.UserPassword(b.Rest.User, b.Rest.Password)
+			}
+		}
+		return fmt.Sprintf("%s:%s", b.Type, parsed.String()), nil
+	case "b2", "azure", "gs", "s3", "sftp", "rclone":
 		return fmt.Sprintf("%s:%s", b.Type, b.Path), nil
 	default:
 		return "", fmt.Errorf("backend type \"%s\" is invalid", b.Type)
@@ -70,15 +90,10 @@ func (b Backend) validate() error {
 		c := GetConfig()
 		tmp := c.Backends[b.name]
 		tmp.Key = key
-		tmp.name = ""
 		c.Backends[b.name] = tmp
-		file := viper.ConfigFileUsed()
-		if err := CopyFile(file, file+".old"); err != nil {
+		if err := c.SaveConfig(); err != nil {
 			return err
 		}
-		colors.Secondary.Println("Saved a backup copy of your file next the the original.")
-		viper.Set("backends", c.Backends)
-		viper.WriteConfig()
 	}
 	env, err := b.getEnv()
 	if err != nil {
@@ -107,16 +122,20 @@ func (b Backend) Exec(args []string) error {
 	}
 	options := ExecuteOptions{Envs: env}
 	out, err := ExecuteResticCommand(options, args...)
+	if err != nil {
+		colors.Error.Println(out)
+		return err
+	}
 	if VERBOSE {
 		colors.Faint.Println(out)
 	}
-	return err
+	return nil
 }
 
-func (b Backend) ExecDocker(l Location, args []string) error {
+func (b Backend) ExecDocker(l Location, args []string) (string, error) {
 	env, err := b.getEnv()
 	if err != nil {
-		return err
+		return "", err
 	}
 	volume := l.getVolumeName()
 	path, _ := l.getPath()
@@ -143,8 +162,5 @@ func (b Backend) ExecDocker(l Location, args []string) error {
 	}
 	docker = append(docker, "restic/restic", "-c", "restic "+strings.Join(args, " "))
 	out, err := ExecuteCommand(options, docker...)
-	if VERBOSE {
-		colors.Faint.Println(out)
-	}
-	return err
+	return out, err
 }

internal/bins/bins.go

@@ -120,7 +120,9 @@ func upgradeRestic() error {
 func Upgrade(restic bool) error {
 	// Upgrade restic
 	if restic {
-		InstallRestic()
+		if err := InstallRestic(); err != nil {
+			colors.Error.Println(err)
+		}
 		upgradeRestic()
 	}
 

internal/config.go

@@ -12,14 +12,15 @@ import (
 	"github.com/spf13/viper"
 )
 
-const VERSION = "1.0.3"
+const VERSION = "1.1.1"
 
 var CI bool = false
 var VERBOSE bool = false
+var CRON_LEAN bool = false
 
 type Config struct {
-	Locations map[string]Location `mapstructure:"locations"`
-	Backends  map[string]Backend  `mapstructure:"backends"`
+	Locations map[string]Location `yaml:"locations"`
+	Backends  map[string]Backend  `yaml:"backends"`
 }
 
 var once sync.Once
@@ -29,7 +30,9 @@ func GetConfig() *Config {
 	if config == nil {
 		once.Do(func() {
 			if err := viper.ReadInConfig(); err == nil {
-				colors.Faint.Println("Using config file:", viper.ConfigFileUsed())
+				if !CRON_LEAN {
+					colors.Faint.Println("Using config file:", viper.ConfigFileUsed())
+				}
 			} else {
 				return
 			}
@@ -72,21 +75,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)
 		}
 
@@ -126,7 +130,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
@@ -190,10 +194,39 @@ func GetAllOrSelected(cmd *cobra.Command, backends bool) ([]string, error) {
 }
 
 func AddFlagsToCommand(cmd *cobra.Command, backend bool) {
-	cmd.PersistentFlags().BoolP("all", "a", false, "Backup all locations")
+	var usage string
 	if backend {
-		cmd.PersistentFlags().StringSliceP("backend", "b", []string{}, "backends")
+		usage = "all backends"
 	} else {
-		cmd.PersistentFlags().StringSliceP("location", "l", []string{}, "Locations")
+		usage = "all locations"
+	}
+	cmd.PersistentFlags().BoolP("all", "a", false, usage)
+	if backend {
+		cmd.PersistentFlags().StringSliceP("backend", "b", []string{}, "select backends")
+	} else {
+		cmd.PersistentFlags().StringSliceP("location", "l", []string{}, "select locations")
 	}
 }
+
+func (c *Config) SaveConfig() error {
+	file := viper.ConfigFileUsed()
+	if err := CopyFile(file, file+".old"); err != nil {
+		return err
+	}
+	colors.Secondary.Println("Saved a backup copy of your file next the the original.")
+
+	viper.Set("backends", c.Backends)
+	viper.Set("locations", c.Locations)
+
+	return viper.WriteConfig()
+}
+
+func getOptions(options Options, key string) []string {
+	var selected []string
+	for k, values := range options[key] {
+		for _, value := range values {
+			selected = append(selected, fmt.Sprintf("--%s", k), value)
+		}
+	}
+	return selected
+}

internal/location.go

@@ -24,19 +24,21 @@ const (
 type HookArray = []string
 
 type Hooks struct {
-	Before HookArray `mapstructure:"before"`
-	After  HookArray `mapstructure:"after"`
+	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   `mapstructure:",omitempty"`
-	From    string   `mapstructure:"from,omitempty"`
-	To      []string `mapstructure:"to,omitempty"`
-	Hooks   Hooks    `mapstructure:"hooks,omitempty"`
-	Cron    string   `mapstructure:"cron,omitempty"`
-	Options Options  `mapstructure:"options,omitempty"`
+	name    string   `yaml:",omitempty"`
+	From    string   `yaml:"from,omitempty"`
+	To      []string `yaml:"to,omitempty"`
+	Hooks   Hooks    `yaml:"hooks,omitempty"`
+	Cron    string   `yaml:"cron,omitempty"`
+	Options Options  `yaml:"options,omitempty"`
 }
 
 func GetLocation(name string) (Location, bool) {
@@ -49,6 +51,20 @@ func (l Location) validate(c *Config) error {
 	if l.From == "" {
 		return fmt.Errorf(`Location "%s" is missing "from" key`, l.name)
 	}
+	if l.getType() == TypeLocal {
+		if from, err := GetPathRelativeToConfig(l.From); 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)
+				}
+			}
+		}
+	}
+
 	if len(l.To) == 0 {
 		return fmt.Errorf(`Location "%s" has no "to" targets`, l.name)
 	}
@@ -62,17 +78,6 @@ 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 {
 	if len(commands) == 0 {
 		return nil
@@ -81,12 +86,13 @@ func ExecuteHooks(commands []string, options ExecuteOptions) error {
 	for _, command := range commands {
 		colors.Body.Println("> " + command)
 		out, err := ExecuteCommand(options, "-c", command)
+		if err != nil {
+			colors.Error.Println(out)
+			return err
+		}
 		if VERBOSE {
 			colors.Faint.Println(out)
 		}
-		if err != nil {
-			return err
-		}
 	}
 	colors.Body.Println("")
 	return nil
@@ -118,7 +124,8 @@ func (l Location) getPath() (string, error) {
 	return "", fmt.Errorf("could not get path for location \"%s\"", l.name)
 }
 
-func (l Location) Backup(cron bool) error {
+func (l Location) Backup(cron bool) []error {
+	var errors []error
 	colors.PrimaryPrint("  Backing up location \"%s\"  ", l.name)
 	t := l.getType()
 	options := ExecuteOptions{
@@ -132,7 +139,8 @@ func (l Location) Backup(cron bool) error {
 
 	// Hooks
 	if err := ExecuteHooks(l.Hooks.Before, options); err != nil {
-		return err
+		errors = append(errors, err)
+		goto after
 	}
 
 	// Backup
@@ -141,12 +149,15 @@ func (l Location) Backup(cron bool) error {
 		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")
+		lFlags := getOptions(l.Options, "backup")
+		bFlags := getOptions(backend.Options, "backup")
 		cmd := []string{"backup"}
-		cmd = append(cmd, flags...)
+		cmd = append(cmd, lFlags...)
+		cmd = append(cmd, bFlags...)
 		if cron {
 			cmd = append(cmd, "--tag", "cron")
 		}
@@ -161,24 +172,37 @@ func (l Location) Backup(cron bool) error {
 		switch t {
 		case TypeLocal:
 			out, err = ExecuteResticCommand(backupOptions, cmd...)
-			if VERBOSE {
-				colors.Faint.Println(out)
-			}
 		case TypeVolume:
-			err = backend.ExecDocker(l, cmd)
+			out, err = backend.ExecDocker(l, cmd)
 		}
-
 		if err != nil {
-			return err
+			colors.Error.Println(out)
+			errors = append(errors, err)
+			continue
+		}
+		if VERBOSE {
+			colors.Faint.Println(out)
 		}
 	}
 
 	// After hooks
 	if err := ExecuteHooks(l.Hooks.After, options); err != nil {
-		return err
+		errors = append(errors, err)
 	}
+
+after:
+	var commands []string
+	if len(errors) > 0 {
+		commands = l.Hooks.Failure
+	} else {
+		commands = l.Hooks.Success
+	}
+	if err := ExecuteHooks(commands, options); err != nil {
+		errors = append(errors, err)
+	}
+
 	colors.Success.Println("Done")
-	return nil
+	return errors
 }
 
 func (l Location) Forget(prune bool, dry bool) error {
@@ -199,7 +223,8 @@ func (l Location) Forget(prune bool, dry bool) error {
 		options := ExecuteOptions{
 			Envs: env,
 		}
-		flags := l.getOptions("forget")
+		lFlags := getOptions(l.Options, "forget")
+		bFlags := getOptions(backend.Options, "forget")
 		cmd := []string{"forget", "--path", path}
 		if prune {
 			cmd = append(cmd, "--prune")
@@ -207,7 +232,8 @@ func (l Location) Forget(prune bool, dry bool) error {
 		if dry {
 			cmd = append(cmd, "--dry-run")
 		}
-		cmd = append(cmd, flags...)
+		cmd = append(cmd, lFlags...)
+		cmd = append(cmd, bFlags...)
 		out, err := ExecuteResticCommand(options, cmd...)
 		if VERBOSE {
 			colors.Faint.Println(out)
@@ -271,7 +297,7 @@ func (l Location) Restore(to, from string, force bool) error {
 		}
 		err = backend.Exec([]string{"restore", "--target", to, "--path", path, "latest"})
 	case TypeVolume:
-		err = backend.ExecDocker(l, []string{"restore", "--target", ".", "--path", path, "latest"})
+		_, err = backend.ExecDocker(l, []string{"restore", "--target", ".", "--path", path, "latest"})
 	}
 	if err != nil {
 		return err
@@ -296,7 +322,9 @@ func (l Location) RunCron() error {
 		lock.SetCron(l.name, now.Unix())
 		l.Backup(true)
 	} else {
-		colors.Body.Printf("Skipping \"%s\", not due yet.\n", l.name)
+		if !CRON_LEAN {
+			colors.Body.Printf("Skipping \"%s\", not due yet.\n", l.name)
+		}
 	}
 	return nil
 }

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,7 @@ func ExecuteCommand(options ExecuteOptions, args ...string) (string, error) {
 }
 
 func ExecuteResticCommand(options ExecuteOptions, args ...string) (string, error) {
-	options.Command = "restic"
+	options.Command = RESTIC_BIN
 	return ExecuteCommand(options, args...)
 }