bump version

update docs dependencies
fix(backend): treat all special chars as _ in env (#382 )
2025-09-06 10:30:39 +00:00 · 2024-08-28 17:32:23 +02:00 · 2024-08-28 17:28:58 +02:00 · 2024-08-28 17:25:06 +02:00 · 2024-08-28 17:21:01 +02:00 · 2024-08-28 17:19:13 +02:00
23 changed files with 2322 additions and 1958 deletions
--- a/.github/workflows/build.yml
+++ b/.github/workflows/build.yml
@@ -3,7 +3,7 @@ name: Main
 on:
  push:
    tags:
-      - "v*.*.*"
+      - 'v*.*.*'

 jobs:
  docker:
@@ -40,7 +40,7 @@ jobs:
      - uses: actions/checkout@v3
      - uses: actions/setup-go@v3
        with:
-          go-version: "^1.20"
+          go-version: '^1.21'
      - name: Build
        run: go run build/build.go
      - name: Release
--- a/6
+++ b/6
@@ -1,4 +1,4 @@
-FROM golang:1.20-alpine as builder
+FROM golang:1.22-alpine as builder

 WORKDIR /app
 COPY go.* .
@@ -6,8 +6,8 @@ RUN go mod download
 COPY . .
 RUN go build

-FROM restic/restic:0.16.0
-RUN apk add --no-cache rclone bash curl
+FROM restic/restic:0.17.0
+RUN apk add --no-cache rclone bash curl docker-cli
 COPY --from=builder /app/autorestic /usr/bin/autorestic
 ENTRYPOINT []
 CMD [ "autorestic" ]
--- a/README.md
+++ b/README.md
@@ -34,7 +34,7 @@ Autorestic is a wrapper around the amazing [restic](https://restic.net/). While
 - Backup locations to multiple backends
 - Snapshot policies and pruning
 - Fully encrypted
- Pre/After hooks
+- Before/after backup hooks
 - Exclude pattern/files
 - Cron jobs for automatic backup
 - Backup & Restore docker volume
--- a/cmd/unlock.go
+++ b/cmd/unlock.go
@@ -0,0 +1,81 @@
+package cmd
+
+import (
+	"bytes"
+	"fmt"
+	"os"
+	"os/exec"
+	"strings"
+
+	"github.com/cupcakearmy/autorestic/internal"
+	"github.com/cupcakearmy/autorestic/internal/colors"
+	"github.com/cupcakearmy/autorestic/internal/lock"
+	"github.com/spf13/cobra"
+)
+
+var unlockCmd = &cobra.Command{
+	Use:   "unlock",
+	Short: "Unlock autorestic only if you are sure that no other instance is running",
+	Long: `Unlock autorestic only if you are sure that no other instance is running.
+To check you can run "ps aux | grep autorestic".`,
+	Run: func(cmd *cobra.Command, args []string) {
+		internal.GetConfig()
+
+		force, _ := cmd.Flags().GetBool("force")
+
+		if !force && isAutoresticRunning() {
+			colors.Error.Print("Another autorestic instance is running. Are you sure you want to unlock? (yes/no): ")
+			var response string
+			fmt.Scanln(&response)
+			if strings.ToLower(response) != "yes" {
+				colors.Primary.Println("Unlocking aborted.")
+				return
+			}
+		}
+
+		err := lock.Unlock()
+		if err != nil {
+			colors.Error.Println("Could not unlock:", err)
+			return
+		}
+
+		colors.Success.Println("Unlock successful")
+	},
+}
+
+func init() {
+	rootCmd.AddCommand(unlockCmd)
+	unlockCmd.Flags().Bool("force", false, "force unlock")
+}
+
+// isAutoresticRunning checks if autorestic is running
+// and returns true if it is.
+// It also prints the processes to stdout.
+func isAutoresticRunning() bool {
+	cmd := exec.Command("sh", "-c", "ps aux | grep autorestic")
+	var out bytes.Buffer
+	cmd.Stdout = &out
+	err := cmd.Run()
+	if err != nil {
+		return false
+	}
+
+	lines := strings.Split(out.String(), "\n")
+	autoresticProcesses := []string{}
+	currentPid := fmt.Sprint(os.Getpid())
+
+	for _, line := range lines {
+		if strings.Contains(line, "autorestic") && !strings.Contains(line, "grep autorestic") && !strings.Contains(line, currentPid) {
+			autoresticProcesses = append(autoresticProcesses, line)
+		}
+	}
+
+	if len(autoresticProcesses) > 0 {
+		colors.Faint.Println("Found autorestic processes:")
+		for _, proc := range autoresticProcesses {
+			colors.Faint.Println(proc)
+		}
+		return true
+	}
+	return false
+}
--- a/docs/.nvmrc
+++ b/docs/.nvmrc
@@ -1 +1 @@
-v20.8.0
+v22.7.0
--- a/docs/package.json
+++ b/docs/package.json
@@ -4,11 +4,11 @@
    "dev": "NEXT_TELEMETRY_DISABLED=1 next"
  },
  "dependencies": {
-    "next": "^13.5.3",
-    "nextra": "^2.13.1",
-    "nextra-theme-docs": "^2.13.1",
-    "react": "^18.2.0",
-    "react-dom": "^18.2.0"
+    "next": "^14.2.7",
+    "nextra": "^2.13.4",
+    "nextra-theme-docs": "^2.13.4",
+    "react": "^18.3.1",
+    "react-dom": "^18.3.1"
  },
-  "packageManager": "pnpm@8.8.0"
+  "packageManager": "pnpm@9.9.0"
 }
--- a/docs/pages/backend/index.md
+++ b/docs/pages/backend/index.md
@@ -16,3 +16,25 @@ backends:
 ## Types

 We restic supports multiple types of backends. See the [full list](/backend/available) for details.
+
+## Avoid Generating Keys
+
+By default, `autorestic` will generate a key for every backend if none is defined. This is done by updating your config file with the key.
+
+In cases where you want to provide the key yourself, you can ensure that `autorestic` doesn't accidentally generate one for you by setting `requireKey: true`.
+
+Example:
+
+```yaml | .autorestic.yml
+version: 2
+
+backends:
+  foo:
+    type: local
+    path: /data/my/backups
+    # Alternatively, you can set the key through the `AUTORESTIC_FOO_RESTIC_PASSWORD` environment variable.
+    key: ... your key here ...
+    requireKey: true
+```
+
+With this setting, if a key is missing, `autorestic` will crash instead of generating a new key and updating your config file.
--- a/docs/pages/cli/forget.md
+++ b/docs/pages/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/options/forget).

 The `--dry-run` flag will do a dry run showing what would have been deleted, but won't touch the actual data.

--- a/docs/pages/cli/unlock.md
+++ b/docs/pages/cli/unlock.md
@@ -0,0 +1,32 @@
+# Unlock
+
+In case autorestic throws the error message `an instance is already running. exiting`, but there is no instance running you can unlock the lock.
+
+To verify that there is no instance running you can use `ps aux | grep autorestic`.
+
+Example with no instance running:
+
+```bash
+> ps aux | grep autorestic
+root       39260  0.0  0.0   6976  2696 pts/11   S+   19:41   0:00 grep autorestic
+```
+
+Example with an instance running:
+
+```bash
+> ps aux | grep autorestic
+root       29465  0.0  0.0 1162068 7380 pts/7    Sl+  19:28   0:00 autorestic --ci backup -a
+root       39260  0.0  0.0   6976  2696 pts/11   S+   19:41   0:00 grep autorestic
+```
+
+**If an instance is running you should not unlock as it could lead to data loss!**
+
+```bash
+autorestic unlock
+```
+
+Use the `--force` to prevent the confirmation prompt if an instance is running.
+
+```bash
+autorestic unlock --force
+```
--- a/docs/pages/community.md
+++ b/docs/pages/community.md
@@ -1,5 +1,7 @@
 # 🏘 Community

+## Software
+
 A list of community driven projects. (No official affiliation)

 - SystemD Units: <https://gitlab.com/py_crash/autorestic-systemd-units>
@@ -9,3 +11,7 @@ A list of community driven projects. (No official affiliation)
 - Ansible Role: <https://github.com/FuzzyMistborn/ansible-role-autorestic>
 - Ansible Role: <https://0xacab.org/varac-projects/ansible-role-autorestic>
 - Ansible Role: <https://github.com/dbrennand/ansible-role-autorestic>
+
+## Writing
+
+- [restic: excellent resource for local and cloud backup](https://notes.nicfab.eu/en/posts/restic/)
--- a/docs/pages/config.md
+++ b/docs/pages/config.md
@@ -56,6 +56,8 @@ version: 2

 extras:
  hooks: &foo
+    prevalidate:
+      - echo "Wake up!"
    before:
      - echo "Hello"
    after:
--- a/docs/pages/index.md
+++ b/docs/pages/index.md
@@ -13,7 +13,7 @@ Autorestic is a wrapper around the amazing [restic](https://restic.net/). While
 - Backup locations to multiple backends
 - Snapshot policies and pruning
 - Fully encrypted
- Pre/After hooks
+- Before/after backup hooks
 - Exclude pattern/files
 - Cron jobs for automatic backup
 - Backup & Restore docker volumes
--- a/docs/pages/location/hooks.md
+++ b/docs/pages/location/hooks.md
@@ -6,23 +6,28 @@ They consist of a list of commands that will be executed in the same directory a

 The following hooks groups are supported, none are required:

+- `prevalidate`
 - `before`
 - `after`
 - `failure`
 - `success`

+The difference between `prevalidate` and `before` hooks are that `prevalidate` is run before checking the backup location is valid, including checking that the `from` directories exist. This can be useful, for example, to mount the source filesystem that contains the directories listed in `from`.
+
 ```yml | .autorestic.yml
 locations:
  my-location:
    from: /data
    to: my-backend
    hooks:
+      prevalidate:
+        - echo "Checks"
      before:
        - echo "One"
        - echo "Two"
        - echo "Three"
      after:
-        - echo "Byte"
+        - echo "Bye"
      failure:
        - echo "Something went wrong"
      success:
@@ -31,13 +36,15 @@ locations:

 ## Flowchart

-1. `before` hook
-2. Run backup
-3. `after` hook
-4. - `success` hook if no errors were found
+1. `prevalidate` hook
+2. Check backup location
+3. `before` hook
+4. Run backup
+5. `after` hook
+6. - `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.
+If either the `prevalidate` or `before` hook encounters errors then the backup and `after` hooks will be skipped and only the `failed` hooks will run.

 ## Environment variables

--- a/docs/pnpm-lock.yaml
+++ b/docs/pnpm-lock.yaml
--- a/go.mod
+++ b/go.mod
@@ -1,6 +1,6 @@
 module github.com/cupcakearmy/autorestic

-go 1.20
+go 1.21

 require (
 	github.com/blang/semver/v4 v4.0.0
@@ -11,9 +11,11 @@ require (
 	github.com/robfig/cron v1.2.0
 	github.com/spf13/cobra v1.4.0
 	github.com/spf13/viper v1.11.0
+	github.com/stretchr/testify v1.9.0
 )

 require (
+	github.com/davecgh/go-spew v1.1.1 // indirect
 	github.com/fsnotify/fsnotify v1.5.1 // indirect
 	github.com/hashicorp/hcl v1.0.0 // indirect
 	github.com/inconshreveable/mousetrap v1.0.0 // indirect
@@ -23,6 +25,7 @@ require (
 	github.com/mitchellh/mapstructure v1.4.3 // indirect
 	github.com/pelletier/go-toml v1.9.4 // indirect
 	github.com/pelletier/go-toml/v2 v2.0.0-beta.8 // indirect
+	github.com/pmezard/go-difflib v1.0.0 // indirect
 	github.com/spf13/afero v1.8.2 // indirect
 	github.com/spf13/cast v1.4.1 // indirect
 	github.com/spf13/jwalterweatherman v1.1.0 // indirect
@@ -32,5 +35,5 @@ require (
 	golang.org/x/text v0.3.8 // indirect
 	gopkg.in/ini.v1 v1.66.4 // indirect
 	gopkg.in/yaml.v2 v2.4.0 // indirect
-	gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b // indirect
+	gopkg.in/yaml.v3 v3.0.1 // indirect
 )
--- a/go.sum
+++ b/go.sum
@@ -182,8 +182,9 @@ github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXf
 github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4=
 github.com/stretchr/testify v1.5.1/go.mod h1:5W2xD1RspED5o8YsWQXVCued0rvSQ+mT+I5cxcmMvtA=
 github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
-github.com/stretchr/testify v1.7.1 h1:5TQK59W5E3v0r2duFAb7P95B6hEeOyEnHRa8MjYSMTY=
 github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
+github.com/stretchr/testify v1.9.0 h1:HtqpIVDClZ4nwg75+f6Lvsy/wHu+3BoSGCbBAcpTsTg=
+github.com/stretchr/testify v1.9.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
 github.com/subosito/gotenv v1.2.0 h1:Slr1R9HxAlEKefgq5jn9U+DnETlIUa6HfgEzj0g5d7s=
 github.com/subosito/gotenv v1.2.0/go.mod h1:N0PQaV/YGNqwC0u51sEeR/aUtSLEXKX9iv69rRypqCw=
 github.com/yuin/goldmark v1.1.25/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74=
@@ -487,8 +488,8 @@ gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
 gopkg.in/yaml.v2 v2.4.0 h1:D8xgwECY7CYvx+Y2n4sBz93Jn9JRvxdiyyo8CTfuKaY=
 gopkg.in/yaml.v2 v2.4.0/go.mod h1:RDklbk79AGWmwhnvt/jBztapEOGDOx6ZbXqjP6csGnQ=
 gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
-gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b h1:h8qDotaEPuJATrMmW04NCwg7v22aHH28wwpauUhK9Oo=
-gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
+gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
+gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
 honnef.co/go/tools v0.0.0-20190102054323-c2f93a96b099/go.mod h1:rf3lG4BRIbNafJWhAfAdb/ePZxsR/4RtNHQocxwk9r4=
 honnef.co/go/tools v0.0.0-20190106161140-3f1c8253044a/go.mod h1:rf3lG4BRIbNafJWhAfAdb/ePZxsR/4RtNHQocxwk9r4=
 honnef.co/go/tools v0.0.0-20190418001031-e561f6794a2a/go.mod h1:rf3lG4BRIbNafJWhAfAdb/ePZxsR/4RtNHQocxwk9r4=
--- a/install.sh
+++ b/install.sh
@@ -10,6 +10,8 @@ if [[ $NATIVE_OS == *"linux"* ]]; then
    OS=linux
 elif [[ $NATIVE_OS == *"darwin"* ]]; then
    OS=darwin
+elif [[ $NATIVE_OS == *"freebsd"* ]]; then
+    OS=freebsd
 else
    echo "Could not determine OS automatically, please check the release page manually: https://github.com/cupcakearmy/autorestic/releases"
    exit 1
@@ -17,7 +19,7 @@ fi
 echo $OS

 NATIVE_ARCH=$(uname -m | tr '[:upper:]' '[:lower:]')
-if [[ $NATIVE_ARCH == *"x86_64"* ]]; then
+if [[ $NATIVE_ARCH == *"x86_64"* || $NATIVE_ARCH == *"amd64"* ]]; then
    ARCH=amd64
 elif [[ $NATIVE_ARCH == *"arm64"* || $NATIVE_ARCH == *"aarch64"* ]]; then
    ARCH=arm64
--- a/internal/backend.go
+++ b/internal/backend.go
@@ -6,6 +6,7 @@ import (
 	"fmt"
 	"net/url"
 	"os"
+	"regexp"
 	"strings"

 	"github.com/cupcakearmy/autorestic/internal/colors"
@@ -18,13 +19,14 @@ type BackendRest struct {
 }

 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"`
-	Rest    BackendRest       `mapstructure:"rest,omitempty"`
-	Options Options           `mapstructure:"options,omitempty"`
+	name       string
+	Type       string            `mapstructure:"type,omitempty"`
+	Path       string            `mapstructure:"path,omitempty"`
+	Key        string            `mapstructure:"key,omitempty"`
+	RequireKey bool              `mapstructure:"requireKey,omitempty"`
+	Env        map[string]string `mapstructure:"env,omitempty"`
+	Rest       BackendRest       `mapstructure:"rest,omitempty"`
+	Options    Options           `mapstructure:"options,omitempty"`
 }

 func GetBackend(name string) (Backend, bool) {
@@ -57,6 +59,8 @@ func (b Backend) generateRepo() (string, error) {
 	}
 }

+var nonAlphaRegex = regexp.MustCompile("[^A-Za-z0-9]")
+
 func (b Backend) getEnv() (map[string]string, error) {
 	env := make(map[string]string)
 	// Key
@@ -72,7 +76,9 @@ func (b Backend) getEnv() (map[string]string, error) {
 	}

 	// From Envfile and passed as env
-	var prefix = "AUTORESTIC_" + strings.ToUpper(b.name) + "_"
+	nameForEnv := strings.ToUpper(b.name)
+	nameForEnv = nonAlphaRegex.ReplaceAllString(nameForEnv, "_")
+	var prefix = "AUTORESTIC_" + nameForEnv + "_"
 	for _, variable := range os.Environ() {
 		var splitted = strings.SplitN(variable, "=", 2)
 		if strings.HasPrefix(splitted[0], prefix) {
@@ -104,6 +110,9 @@ func (b Backend) validate() error {
 		// Check if key is set in environment
 		env, _ := b.getEnv()
 		if _, found := env["RESTIC_PASSWORD"]; !found {
+			if b.RequireKey {
+				return fmt.Errorf("backend %s requires a key but none was provided", b.name)
+			}
 			// No key set in config file or env => generate random key and save file
 			key := generateRandomKey()
 			b.Key = key
@@ -143,6 +152,7 @@ func (b Backend) Exec(args []string) error {
 		return err
 	}
 	options := ExecuteOptions{Envs: env}
+	args = append(args, combineBackendOptions("exec", b)...)
 	_, out, err := ExecuteResticCommand(options, args...)
 	if err != nil {
 		colors.Error.Println(out)
@@ -182,6 +192,7 @@ func (b Backend) ExecDocker(l Location, args []string) (int, string, error) {
 	case "s3":
 	case "azure":
 	case "gs":
+	case "rest":
 		// No additional setup needed
 	case "rclone":
 		// Read host rclone config and mount it into the container
--- a/internal/backend_test.go
+++ b/internal/backend_test.go
@@ -6,6 +6,7 @@ import (
 	"testing"

 	"github.com/spf13/viper"
+	"github.com/stretchr/testify/assert"
 )

 func TestGenerateRepo(t *testing.T) {
@@ -194,6 +195,33 @@ func TestGetEnv(t *testing.T) {
 		assertEqual(t, result["B2_ACCOUNT_ID"], "foo123")
 		assertEqual(t, result["B2_ACCOUNT_KEY"], "foo456")
 	})
+
+	for _, char := range "@-_:/" {
+		t.Run(fmt.Sprintf("env var with special char (%c)", char), func(t *testing.T) {
+			// generate env variables
+			// TODO better way to teardown
+			defer os.Unsetenv("AUTORESTIC_FOO_BAR_RESTIC_PASSWORD")
+			defer os.Unsetenv("AUTORESTIC_FOO_BAR_B2_ACCOUNT_ID")
+			defer os.Unsetenv("AUTORESTIC_FOO_BAR_B2_ACCOUNT_KEY")
+			os.Setenv("AUTORESTIC_FOO_BAR_RESTIC_PASSWORD", "secret123")
+			os.Setenv("AUTORESTIC_FOO_BAR_B2_ACCOUNT_ID", "foo123")
+			os.Setenv("AUTORESTIC_FOO_BAR_B2_ACCOUNT_KEY", "foo456")
+
+			b := Backend{
+				name: fmt.Sprintf("foo%cbar", char),
+				Type: "local",
+				Path: "/foo/bar",
+			}
+			result, err := b.getEnv()
+			if err != nil {
+				t.Errorf("unexpected error %v", err)
+			}
+			assertEqual(t, result["RESTIC_REPOSITORY"], "/foo/bar")
+			assertEqual(t, result["RESTIC_PASSWORD"], "secret123")
+			assertEqual(t, result["B2_ACCOUNT_ID"], "foo123")
+			assertEqual(t, result["B2_ACCOUNT_KEY"], "foo456")
+		})
+	}
 }

 func TestValidate(t *testing.T) {
@@ -222,4 +250,16 @@ func TestValidate(t *testing.T) {
 		}
 		assertEqual(t, err.Error(), "Backend \"foo\" has no \"path\"")
 	})
+
+	t.Run("require key with no key", func(t *testing.T) {
+		b := Backend{
+			name:       "foo",
+			Type:       "local",
+			Path:       "~/foo/bar",
+			RequireKey: true,
+		}
+		err := b.validate()
+		fmt.Printf("error: %v\n", err)
+		assert.EqualError(t, err, "backend foo requires a key but none was provided")
+	})
 }
--- a/internal/bins/bins.go
+++ b/internal/bins/bins.go
@@ -6,7 +6,6 @@ import (
 	"errors"
 	"fmt"
 	"io"
-	"io/ioutil"
 	"net/http"
 	"os"
 	"path"
@@ -37,7 +36,7 @@ func dlJSON(url string) (GithubRelease, error) {
 		return parsed, err
 	}
 	defer resp.Body.Close()
-	body, err := ioutil.ReadAll(resp.Body)
+	body, err := io.ReadAll(resp.Body)
 	if err != nil {
 		return parsed, err

@@ -73,9 +72,10 @@ func downloadAndInstallAsset(body GithubRelease, name string) error {
 			// Uncompress
 			bz := bzip2.NewReader(resp.Body)

-			// Save to tmp
-			// Linux does not support overwriting the file that is currently being overwritten, but it can be deleted and a new one moved in its place.
-			tmp, err := ioutil.TempFile(os.TempDir(), "autorestic-")
+			// Save to tmp file in the same directory as the install directory
+			// Linux does not support overwriting the file that is currently being running
+			// But it can be delete the old one and a new one moved in its place.
+			tmp, err := os.CreateTemp(INSTALL_PATH, "autorestic-")
 			if err != nil {
 				return err
 			}
@@ -89,24 +89,26 @@ func downloadAndInstallAsset(body GithubRelease, name string) error {

 			to := path.Join(INSTALL_PATH, name)
 			defer os.Remove(tmp.Name()) // Cleanup temporary file after thread exits
-			if err := os.Rename(tmp.Name(), to); err != 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 {
+
+			mode := os.FileMode(0755)
+			if originalBin, err := os.Lstat(to); err == nil {
+				mode = originalBin.Mode()
+				err := os.Remove(to)
+				if err != nil {
 					return err
 				}
 			}

+			err = os.Rename(tmp.Name(), to)
+			if err != nil {
+				return err
+			}
+
+			err = os.Chmod(to, mode)
+			if err != nil {
+				return err
+			}
+
 			colors.Success.Printf("Successfully installed '%s' under %s\n", name, INSTALL_PATH)
 			return nil
 		}
--- a/internal/config.go
+++ b/internal/config.go
@@ -17,7 +17,7 @@ import (
 	"github.com/spf13/viper"
 )

-const VERSION = "1.7.10"
+const VERSION = "1.8.3"

 type OptionMap map[string][]interface{}
 type Options map[string]OptionMap
@@ -132,10 +132,11 @@ func (c *Config) Describe() {

 		tmp = ""
 		hooks := map[string][]string{
-			"Before":  l.Hooks.Before,
-			"After":   l.Hooks.After,
-			"Failure": l.Hooks.Failure,
-			"Success": l.Hooks.Success,
+			"PreValidate": l.Hooks.PreValidate,
+			"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 {
--- a/internal/location.go
+++ b/internal/location.go
@@ -33,11 +33,12 @@ const (
 )

 type Hooks struct {
-	Dir     string    `mapstructure:"dir"`
-	Before  HookArray `mapstructure:"before,omitempty"`
-	After   HookArray `mapstructure:"after,omitempty"`
-	Success HookArray `mapstructure:"success,omitempty"`
-	Failure HookArray `mapstructure:"failure,omitempty"`
+	Dir         string    `mapstructure:"dir"`
+	PreValidate HookArray `mapstructure:"prevalidate,omitempty"`
+	Before      HookArray `mapstructure:"before,omitempty"`
+	After       HookArray `mapstructure:"after,omitempty"`
+	Success     HookArray `mapstructure:"success,omitempty"`
+	Failure     HookArray `mapstructure:"failure,omitempty"`
 }

 type LocationCopy = map[string][]string
@@ -184,12 +185,18 @@ func (l Location) Backup(cron bool, specificBackend string) []error {
 		},
 	}

+	// Hooks before location validation
+	if err := l.ExecuteHooks(l.Hooks.PreValidate, options); err != nil {
+		errors = append(errors, err)
+		goto after
+	}
+
 	if err := l.validate(); err != nil {
 		errors = append(errors, err)
 		goto after
 	}

-	// Hooks
+	// Hooks after location validation
 	if err := l.ExecuteHooks(l.Hooks.Before, options); err != nil {
 		errors = append(errors, err)
 		goto after
@@ -289,12 +296,13 @@ func (l Location) Backup(cron bool, specificBackend string) []error {
 		}
 	}

-	// After hooks
+	// After backup hooks
 	if err := l.ExecuteHooks(l.Hooks.After, options); err != nil {
 		errors = append(errors, err)
 	}

 after:
+	// Success/failure hooks
 	var commands []string
 	var isSuccess = len(errors) == 0
 	if isSuccess {
--- a/main.go
+++ b/main.go
@@ -5,7 +5,7 @@ Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
 You may obtain a copy of the License at

-    http://www.apache.org/licenses/LICENSE-2.0
+	http://www.apache.org/licenses/LICENSE-2.0

 Unless required by applicable law or agreed to in writing, software
 distributed under the License is distributed on an "AS IS" BASIS,
Author	SHA1	Message	Date
Niccolo Borgioli	592d1093ac	bump version	2024-08-28 17:32:23 +02:00
Niccolo Borgioli	83481072bb	update docs dependencies	2024-08-28 17:28:58 +02:00
Boris Bera	776638e6fe	fix(backend): treat all special chars as `_` in env (#382 )	2024-08-28 17:25:06 +02:00
Boris Bera	bc74d3f13e	Add option to crash `autorestic` when key is missing instead of generating a new key (#383 ) * feat(backend): add requireKey option to backend This option will prevent `autorestic` from generating a key and will cause it to crash instead. This is intended for use cases where you want to provision the key yourself and don't want `autorestic` to accidentally generate one for you. * doc(backend): document requireKey	2024-08-28 17:21:01 +02:00
guest20	dd01e97cf3	install.sh: FreeBSD amd64 (#385 )	2024-08-28 17:19:13 +02:00
dependabot[bot]	aabb0989c6	Bump restic/restic from 0.16.4 to 0.17.0 (#386 ) Bumps restic/restic from 0.16.4 to 0.17.0. --- updated-dependencies: - dependency-name: restic/restic dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>	2024-08-28 17:18:01 +02:00
Nicco	62a81d1420	add blog post to community page :)	2024-05-17 19:23:54 +02:00
Nicco	e4b33cad1f	version bump	2024-03-28 09:29:39 +01:00
Tucker Kern	a82273ec13	Allow REST backend with docker volumes (#366 )	2024-03-27 20:20:13 +01:00
dependabot[bot]	2418da5636	Bump gopkg.in/yaml.v3 from 3.0.0-20210107192922-496545a6307b to 3.0.0 (#363 ) Bumps gopkg.in/yaml.v3 from 3.0.0-20210107192922-496545a6307b to 3.0.0. --- updated-dependencies: - dependency-name: gopkg.in/yaml.v3 dependency-type: indirect ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>	2024-03-25 22:47:08 +01:00
dependabot[bot]	7508df7d66	Bump katex from 0.16.8 to 0.16.10 in /docs (#364 ) Bumps [katex](https://github.com/KaTeX/KaTeX) from 0.16.8 to 0.16.10. - [Release notes](https://github.com/KaTeX/KaTeX/releases) - [Changelog](https://github.com/KaTeX/KaTeX/blob/main/CHANGELOG.md) - [Commits](https://github.com/KaTeX/KaTeX/compare/v0.16.8...v0.16.10) --- updated-dependencies: - dependency-name: katex dependency-type: indirect ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>	2024-03-25 22:46:58 +01:00
Nicco	6e34196220	Update config.go	2024-03-13 12:40:11 +01:00
Florian	dc56911a45	fix(unlock cmd): ignore process if its the current id (#360 )	2024-03-13 12:39:51 +01:00
Nicco	edb3ba35d8	Update config.go	2024-03-12 15:27:11 +01:00
Florian	12f6143bb4	fix: cli command to unlock the autorestic running value (#329 ) * fix: cli command to unlock the autorestic running value * fix(unlock cmd): get user confirmation in case an instance is still running * fix(cmd unlock): add force flag	2024-03-12 15:26:12 +01:00
Pete	a6bf1d1408	fix relative path to options forget (#331 ) /location/options/forget instead of /location/forget.	2024-03-12 15:24:25 +01:00
Stuart Hickinbottom	13aa560fda	Add PreValidate hook (#359 ) Fix #332. This adds a new "PreValidate" hook that is executed before checking the backup location. This allows, for example, mounting a remote source to make the directories of the location available. "PreValidate" is added as a new hook to avoid any breakage that might have been caused by changing the behaviour of the "before" hook. Documentataion updates included.	2024-03-12 15:22:43 +01:00
rdelaage	bbb1c85cad	Fix upgrade command (#259 ) fix #191 Co-authored-by: Romain de Laage <romain.delaage@rdelaage.ovh>	2024-02-15 14:27:37 +01:00
Natanel Shitrit	4cc44315ab	feat: add `docker-cli` package (#339 ) Co-authored-by: Nicco <hi@nicco.io>	2024-02-15 14:26:26 +01:00
dependabot[bot]	b3440cd87c	Bump golang from 1.21-alpine to 1.22-alpine (#355 ) Bumps golang from 1.21-alpine to 1.22-alpine. --- updated-dependencies: - dependency-name: golang dependency-type: direct:production ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>	2024-02-15 14:24:17 +01:00
rdelaage	4848702929	Use options on exec command (#253 ) Co-authored-by: Romain de Laage <romain.delaage@rdelaage.ovh>	2024-02-15 14:23:43 +01:00
Nicco	b5604b8b9f	update deps (#353 )	2024-02-09 14:18:24 +01:00
Alexander Zhang	24220f6b62	Fix broken link in docs (#350 )	2024-02-09 14:18:06 +01:00