contrib

Add error handling to reading of config file.

CHANGELOG.md

@@ -5,23 +5,44 @@ 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.2] - 2022-02-13
+
+### Fixed
+
+- Config loading @jjromannet
+- Making a backup of the file @jjromannet
+
+## [1.5.1] - 2021-12-06
+
+### Changed
+
+- use official docker image instead of installing rclone every time docker is used.
+- docker docs
+
+### Fixed
+
+- lock file not always next to the config file.
+- update / install bugs.
+- lock docker image tag to the current autorestic version
+- better error logging
+
 ## [1.5.0] - 2021-11-20
 
 ### Added
 
-- Support for multiple paths
-- Improved error handling
-- Allow for specific snapshot to be restored
-- Docker image
+- Support for multiple paths.
+- Improved error handling.
+- Allow for specific snapshot to be restored.
+- Docker image.
 
 ### Fixed
 
-- rclone in docker volumes
+- 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
+- [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
 
@@ -33,26 +54,26 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
-- Allow specify to specify a backend for location backup
-- Global restic flags
-- Generic ENV support for backends
+- 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`
+- 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
+- Error handling during upgrade & uninstall.
 
 ## [1.3.0] - 2021-10-26
 
 ### Added
 
-- Pass restic backup metadata as ENV to hooks
+- 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
+- Binary restic flags are now supported.
 - Pass encryption keys from env variables or files.
 
 ## [1.2.0] - 2021-08-05
@@ -60,12 +81,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 
 - Community page
-- Support for yaml references and aliases
+- Support for yaml references and aliases.
 
 ### Fixed
 
-- Better verbose output for hooks
-- Better error message for bad formatted configs
+- Better verbose output for hooks.
+- Better error message for bad formatted configs.
 
 ## [1.1.2] - 2021-07-11
 
@@ -77,24 +98,24 @@ Don't check all backend when running `forget` or `exec` commands.
 
 ### Added
 
-- Options for backends
+- Options for backends.
 
 ## [1.1.0] - 2021-05-06
 
 ### Added
 
-- use custom restic binary
-- success & failure hooks
+- use custom restic binary.
+- success & failure hooks.
 
 ### Fixed
 
-- don't skip other locations on failure
+- don't skip other locations on failure.
 
 ## [1.0.9] - 2021-05-01
 
 ### Fixed
 
-- Validation for docker volumes
+- Validation for docker volumes.
 
 ## [1.0.8] - 2021-04-28
 
@@ -117,7 +138,7 @@ Don't check all backend when running `forget` or `exec` commands.
 
 ### Added
 
-- Support for rclone
+- Support for rclone.
 
 ## [1.0.5] - 2021-04-24
 
@@ -130,17 +151,17 @@ Don't check all backend when running `forget` or `exec` commands.
 
 ### Added
 
-- Options to add rest username and password in config
+- Options to add rest username and password in config.
 
 ### Fixed
 
-- Don't add empty strings when saving config
+- Don't add empty strings when saving config.
 
 ## [1.0.3] - 2021-04-20
 
 ### Fixed
 
-- Auto upgrade script was not working on linux as linux does not support writing to the binary that is being executed
+- Auto upgrade script was not working on linux as linux does not support writing to the binary that is being executed.
 
 ## [1.0.2] - 2021-04-20
 
@@ -156,7 +177,7 @@ Don't check all backend when running `forget` or `exec` commands.
 
 ### Added
 
-- Completion command for various shells
+- Completion command for various shells.
 
 ## [1.0.0] - 2021-04-17
 

cmd/backup.go

@@ -31,7 +31,7 @@ var backupCmd = &cobra.Command{
 			location, _ := internal.GetLocation(splitted[0])
 			errs := location.Backup(false, specificBackend)
 			for _, err := range errs {
-				colors.Error.Println(err)
+				colors.Error.Printf("%s\n\n", err)
 				errors++
 			}
 		}

cmd/check.go

@@ -11,6 +11,7 @@ var checkCmd = &cobra.Command{
 	Use:   "check",
 	Short: "Check if everything is setup",
 	Run: func(cmd *cobra.Command, args []string) {
+		internal.GetConfig()
 		err := lock.Lock()
 		CheckErr(err)
 		defer lock.Unlock()

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.GetConfig()
 		internal.CRON_LEAN, _ = cmd.Flags().GetBool("lean")
 		err := lock.Lock()
 		CheckErr(err)

cmd/restore.go

@@ -13,6 +13,7 @@ var restoreCmd = &cobra.Command{
 	Short: "Restore backup for location",
 	Args:  cobra.MaximumNArgs(1),
 	Run: func(cmd *cobra.Command, args []string) {
+		internal.GetConfig()
 		err := lock.Lock()
 		CheckErr(err)
 		defer lock.Unlock()

cmd/root.go

@@ -1,8 +1,10 @@
 package cmd
 
 import (
+	"fmt"
 	"os"
 	"path/filepath"
+	"strings"
 
 	"github.com/cupcakearmy/autorestic/internal"
 	"github.com/cupcakearmy/autorestic/internal/colors"
@@ -27,7 +29,7 @@ var rootCmd = &cobra.Command{
 	Version: internal.VERSION,
 	Use:     "autorestic",
 	Short:   "CLI Wrapper for restic",
-	Long:    "Documentation: https://autorestic.vercel.app",
+	Long:    "Documentation:\thttps://autorestic.vercel.app\nSupport:\thttps://discord.gg/wS7RpYTYd2",
 }
 
 func Execute() {
@@ -49,13 +51,21 @@ func initConfig() {
 	}
 
 	if cfgFile != "" {
+		if internal.VERBOSE {
+			colors.Faint.Printf("> Using config file: %s\n", cfgFile)
+		}
 		viper.SetConfigFile(cfgFile)
+		viper.AutomaticEnv()
+		if viper.ConfigFileUsed() == "" {
+			colors.Error.Println("cannot read config file %s\n", cfgFile)
+			os.Exit(1)
+		}
 	} else {
-		viper.AddConfigPath(".")
+		configPaths := []string{"."}
 
 		// Home
 		if home, err := homedir.Dir(); err != nil {
-			viper.AddConfigPath(home)
+			configPaths = append(configPaths, home)
 		}
 
 		// XDG_CONFIG_HOME
@@ -66,10 +76,24 @@ func initConfig() {
 					prefix = filepath.Join(home, ".config")
 				}
 			}
-			viper.AddConfigPath(filepath.Join(prefix, "autorestic"))
+			xdgConfig := filepath.Join(prefix, "autorestic")
+			configPaths = append(configPaths, xdgConfig)
 		}
-
-		viper.SetConfigName(".autorestic")
+		for _, cfgPath := range configPaths {
+			if internal.VERBOSE {
+				colors.Faint.Printf("> Adding config path: '%s'\n", cfgPath)
 			}
+			viper.AddConfigPath(cfgPath)
+		}
+		cfgFileName := ".autorestic"
+		viper.SetConfigName(cfgFileName)
 		viper.AutomaticEnv()
+		if viper.ConfigFileUsed() == "" {
+			colors.Error.Println(
+				fmt.Sprintf(
+					"cannot find configuration file '%s.yml' or '%s.yaml' in config paths: ['%s']",
+					cfgFileName, cfgFileName, strings.Join(configPaths, "', '")))
+			os.Exit(1)
+		}
+	}
 }

docs/markdown/_toc.md

@@ -46,6 +46,7 @@
 > [1.4 → 1.5](/migration/1.4_1.5)
 
 [Examples](/examples)
+[Docker](/docker)
 [QA](/qa)
 [Community](/community)
 [Contributors](/contrib)

docs/markdown/backend/overview.md

@@ -3,6 +3,8 @@
 Backends are the outputs of the backup process. Each location needs at least one.
 
 ```yaml | .autorestic.yml
+version: 2
+
 backends:
   name-of-backend:
     type: local

docs/markdown/config.md

@@ -16,6 +16,8 @@ You can also specify a custom file with the `-c path/to/some/config.yml`
 ## Example configuration
 
 ```yaml | .autorestic.yml
+version: 2
+
 locations:
   home:
     from: /home/me
@@ -49,6 +51,8 @@ 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
+version: 2
+
 extras:
   hooks: &foo
     before:

docs/markdown/contrib.md

@@ -2,16 +2,18 @@
 
 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
+- @agateblue - Docs, Pruning, S3.
+- @g-a-c - Update/Install bugs.
+- @jjromannet - Bug fixes.
+- @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/docker.md

@@ -0,0 +1,28 @@
+# 🐳 Docker
+
+The docker image is build with rclone and restic already included. It's ment more as a utility image.
+
+## Remote hosts
+
+For remote backups (S3, B2, GCS, etc.) it's quite easy, as you only need to mount the config file and the data to backup.
+
+```bash
+docker run --rm \\
+  -v $(pwd):/data \\
+  cupcakearmy/autorestic \\
+  autorestic backup -va -c /data/.autorestic.yaml
+```
+
+## Rclone
+
+For rclone you will have to also mount the rclone config file to `/root/.config/rclone/rclone.conf`.
+
+To check where it is located you can run the following command: `rclone config file`.
+
+**Example**
+
+```bash
+docker run \\
+  -v /home/user/.config/rclone/rclone.conf:/root/.config/rclone/rclone.conf:ro \\
+  ...
+```

docs/markdown/installation.md

@@ -14,6 +14,8 @@ wget -qO - https://raw.githubusercontent.com/CupCakeArmy/autorestic/master/insta
 
 There is an official docker image over at [cupcakearmy/autorestic](https://hub.docker.com/r/cupcakearmy/autorestic).
 
+For some examples see [here](/docker).
+
 ### 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.

docs/markdown/location/forget.md

@@ -7,6 +7,8 @@ This is based on [Restic's snapshots policies](https://restic.readthedocs.io/en/
 > **Note** This is a full example, of course you also can specify only one of them
 
 ```yaml | .autorestic.yml
+version: 2
+
 locations:
   etc:
     from: /etc
@@ -22,4 +24,17 @@ locations:
         keep-within: '2w' # keep snapshots from the last 2 weeks
 ```
 
+## Globally
+
+You can specify global forget policies that would be applied to all locations:
+
+```yaml | .autorestic.yml
+version: 2
+
+global:
+  forget:
+    keep-daily: 30
+    keep-weekly: 52
+```
+
 > :ToCPrevNext

docs/markdown/location/overview.md

@@ -4,9 +4,15 @@ Locations can be seen as the input to the backup process. Generally this is simp
 The paths can be relative from the config file. A location can have multiple backends, so that the data is secured across multiple servers.
 
 ```yaml | .autorestic.yml
+version: 2
+
 locations:
   my-location-name:
     from: path/to/backup
+    # Or multiple
+    # from:
+    #   - /a
+    #   - /b
     to:
       - name-of-backend
       - also-backup-to-this-backend
@@ -14,7 +20,7 @@ locations:
 
 ## `from`
 
-This is the source of the location.
+This is the source of the location. Can be an `array` for multiple sources.
 
 #### How are paths resolved?
 

docs/markdown/quick.md

@@ -25,9 +25,15 @@ For a quick overview:
 > Note that the data is automatically encrypted on the server. The key will be generated and added to your config file. Every backend will have a separate key. **You should keep a copy of the keys or config file somewhere in case your server dies**. Otherwise DATA IS LOST!
 
 ```yaml | .autorestic.yml
+version: 2
+
 locations:
   home:
-    from: /home/me
+    from: /home
+    # Or multiple
+    # from:
+    #  - /foo
+    #  - /bar
     to: remote
 
   important:

internal/backend.go

@@ -194,15 +194,13 @@ func (b Backend) ExecDocker(l Location, args []string) (string, error) {
 		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", strings.Join(args, " "))
+	docker = append(docker, "cupcakearmy/autorestic:"+VERSION, "-c", strings.Join(args, " "))
 	out, err := ExecuteCommand(options, docker...)
 	return out, err
 }

internal/bins/bins.go

@@ -87,9 +87,23 @@ func downloadAndInstallAsset(body GithubRelease, name string) error {
 			}
 
 			to := path.Join(INSTALL_PATH, name)
-			defer os.Remove(to) // Delete if current, ignore error if file does not exits.
+			defer os.Remove(tmp.Name()) // Cleanup temporary file after thread exits
 			if err := os.Rename(tmp.Name(), to); err != nil {
-				return nil
+				colors.Error.Printf("os.Rename() failed (%v), retrying with io.Copy()\n", err.Error())
+				var src *os.File
+				var dst *os.File
+				if src, err = os.Open(tmp.Name()); err != nil {
+					return err
+				}
+				if dst, err = os.Create(to); err != nil {
+					return err
+				}
+				if _, err := io.Copy(dst, src); err != nil {
+					return err
+				}
+				if err := os.Chmod(to, 0755); err != nil {
+					return err
+				}
 			}
 
 			colors.Success.Printf("Successfully installed '%s' under %s\n", name, INSTALL_PATH)

internal/config.go

@@ -16,7 +16,7 @@ import (
 	"github.com/spf13/viper"
 )
 
-const VERSION = "1.5.0"
+const VERSION = "1.5.2"
 
 var CI bool = false
 var VERBOSE bool = false
@@ -259,7 +259,7 @@ func (c *Config) SaveConfig() error {
 	if err := CopyFile(file, file+".old"); err != nil {
 		return err
 	}
-	colors.Secondary.Println("Saved a backup copy of your file next the the original.")
+	colors.Secondary.Println("Saved a backup copy of your file next to the original.")
 
 	viper.Set("backends", c.Backends)
 	viper.Set("locations", c.Locations)

internal/location.go

@@ -216,7 +216,8 @@ func (l Location) Backup(cron bool, specificBackend string) []error {
 			out, err = backend.ExecDocker(l, cmd)
 		}
 		if err != nil {
-			errors = append(errors, err)
+			colors.Error.Println(out)
+			errors = append(errors, fmt.Errorf("%s@%s:\n%s%s", l.name, backend.name, out, err))
 			continue
 		}
 

internal/lock/lock.go

@@ -19,8 +19,13 @@ func getLock() *viper.Viper {
 		once.Do(func() {
 			lock = viper.New()
 			lock.SetDefault("running", false)
-			p := path.Dir(viper.ConfigFileUsed())
-			file = path.Join(p, ".autorestic.lock.yml")
+			p := viper.ConfigFileUsed()
+			if p == "" {
+				colors.Error.Println("cannot lock before reading config location")
+				os.Exit(1)
+			}
+			file = path.Join(path.Dir(p), ".autorestic.lock.yml")
+			colors.Faint.Println("Using lock:\t", file)
 			lock.SetConfigFile(file)
 			lock.SetConfigType("yml")
 			lock.ReadInConfig()

internal/utils.go

@@ -60,13 +60,13 @@ func ExecuteResticCommand(options ExecuteOptions, args ...string) (string, error
 }
 
 func CopyFile(from, to string) error {
-	original, err := os.Open("original.txt")
+	original, err := os.Open(from)
 	if err != nil {
 		return nil
 	}
 	defer original.Close()
 
-	new, err := os.Create("new.txt")
+	new, err := os.Create(to)
 	if err != nil {
 		return nil
 	}