chore(lockfile) change flag to --lockfile

This is more consistent with the `lockfile` config option

.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

.github/workflows/ci.yml

@@ -0,0 +1,24 @@
+name: CI
+on:
+  pull_request:
+  push:
+    branches: [master]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-go@v3
+        with:
+          go-version: '^1.21'
+      - run: go test -v ./...
+
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-go@v3
+        with:
+          go-version: '^1.21'
+      - run: go build -v .

Dockerfile

@@ -1,4 +1,4 @@
-FROM golang:1.20-alpine as builder
+FROM golang:1.23-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
+FROM restic/restic:0.17.2
+RUN apk add --no-cache rclone bash curl docker-cli
 COPY --from=builder /app/autorestic /usr/bin/autorestic
 ENTRYPOINT []
 CMD [ "autorestic" ]

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

cmd/backup.go

@@ -6,7 +6,6 @@ import (
 
 	"github.com/cupcakearmy/autorestic/internal"
 	"github.com/cupcakearmy/autorestic/internal/colors"
-	"github.com/cupcakearmy/autorestic/internal/lock"
 	"github.com/spf13/cobra"
 )
 
@@ -15,9 +14,9 @@ var backupCmd = &cobra.Command{
 	Short: "Create backups for given locations",
 	Run: func(cmd *cobra.Command, args []string) {
 		internal.GetConfig()
-		err := lock.Lock()
+		err := internal.Lock()
 		CheckErr(err)
-		defer lock.Unlock()
+		defer internal.Unlock()
 
 		selected, err := internal.GetAllOrSelected(cmd, false)
 		CheckErr(err)

cmd/check.go

@@ -3,7 +3,6 @@ package cmd
 import (
 	"github.com/cupcakearmy/autorestic/internal"
 	"github.com/cupcakearmy/autorestic/internal/colors"
-	"github.com/cupcakearmy/autorestic/internal/lock"
 	"github.com/spf13/cobra"
 )
 
@@ -12,9 +11,9 @@ var checkCmd = &cobra.Command{
 	Short: "Check if everything is setup",
 	Run: func(cmd *cobra.Command, args []string) {
 		internal.GetConfig()
-		err := lock.Lock()
+		err := internal.Lock()
 		CheckErr(err)
-		defer lock.Unlock()
+		defer internal.Unlock()
 
 		CheckErr(internal.CheckConfig())
 

cmd/cron.go

@@ -3,7 +3,6 @@ package cmd
 import (
 	"github.com/cupcakearmy/autorestic/internal"
 	"github.com/cupcakearmy/autorestic/internal/flags"
-	"github.com/cupcakearmy/autorestic/internal/lock"
 	"github.com/spf13/cobra"
 )
 
@@ -13,9 +12,9 @@ var cronCmd = &cobra.Command{
 	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()
-		err := lock.Lock()
+		err := internal.Lock()
 		CheckErr(err)
-		defer lock.Unlock()
+		defer internal.Unlock()
 
 		err = internal.RunCron()
 		CheckErr(err)

cmd/exec.go

@@ -5,7 +5,6 @@ import (
 
 	"github.com/cupcakearmy/autorestic/internal"
 	"github.com/cupcakearmy/autorestic/internal/colors"
-	"github.com/cupcakearmy/autorestic/internal/lock"
 	"github.com/spf13/cobra"
 )
 
@@ -14,9 +13,9 @@ var execCmd = &cobra.Command{
 	Short: "Execute arbitrary native restic commands for given backends",
 	Run: func(cmd *cobra.Command, args []string) {
 		internal.GetConfig()
-		err := lock.Lock()
+		err := internal.Lock()
 		CheckErr(err)
-		defer lock.Unlock()
+		defer internal.Unlock()
 
 		selected, err := internal.GetAllOrSelected(cmd, true)
 		CheckErr(err)

cmd/forget.go

@@ -2,7 +2,6 @@ package cmd
 
 import (
 	"github.com/cupcakearmy/autorestic/internal"
-	"github.com/cupcakearmy/autorestic/internal/lock"
 	"github.com/spf13/cobra"
 )
 
@@ -11,9 +10,9 @@ var forgetCmd = &cobra.Command{
 	Short: "Forget and optionally prune snapshots according the specified policies",
 	Run: func(cmd *cobra.Command, args []string) {
 		internal.GetConfig()
-		err := lock.Lock()
+		err := internal.Lock()
 		CheckErr(err)
-		defer lock.Unlock()
+		defer internal.Unlock()
 
 		selected, err := internal.GetAllOrSelected(cmd, false)
 		CheckErr(err)

cmd/restore.go

@@ -4,7 +4,6 @@ import (
 	"fmt"
 
 	"github.com/cupcakearmy/autorestic/internal"
-	"github.com/cupcakearmy/autorestic/internal/lock"
 	"github.com/spf13/cobra"
 )
 
@@ -14,9 +13,9 @@ var restoreCmd = &cobra.Command{
 	Args:  cobra.MaximumNArgs(1),
 	Run: func(cmd *cobra.Command, args []string) {
 		internal.GetConfig()
-		err := lock.Lock()
+		err := internal.Lock()
 		CheckErr(err)
-		defer lock.Unlock()
+		defer internal.Unlock()
 
 		location, _ := cmd.Flags().GetString("location")
 		l, ok := internal.GetLocation(location)

cmd/root.go

@@ -8,7 +8,6 @@ import (
 	"github.com/cupcakearmy/autorestic/internal"
 	"github.com/cupcakearmy/autorestic/internal/colors"
 	"github.com/cupcakearmy/autorestic/internal/flags"
-	"github.com/cupcakearmy/autorestic/internal/lock"
 	"github.com/spf13/cobra"
 
 	homedir "github.com/mitchellh/go-homedir"
@@ -18,7 +17,7 @@ import (
 func CheckErr(err error) {
 	if err != nil {
 		colors.Error.Fprintln(os.Stderr, "Error:", err)
-		lock.Unlock()
+		internal.Unlock()
 		os.Exit(1)
 	}
 }
@@ -42,6 +41,7 @@ func init() {
 	rootCmd.PersistentFlags().BoolVarP(&flags.VERBOSE, "verbose", "v", false, "verbose mode")
 	rootCmd.PersistentFlags().StringVar(&flags.RESTIC_BIN, "restic-bin", "restic", "specify custom restic binary")
 	rootCmd.PersistentFlags().StringVar(&flags.DOCKER_IMAGE, "docker-image", "cupcakearmy/autorestic:"+internal.VERSION, "specify a custom docker image")
+	rootCmd.PersistentFlags().StringVar(&flags.LOCKFILE, "lockfile", "", "specify a custom path for the lockfile (defaults to .autorestic.lock.yml next to the loaded autorestic config file)")
 	cobra.OnInitialize(initConfig)
 }
 
@@ -59,24 +59,7 @@ func initConfig() {
 			os.Exit(1)
 		}
 	} else {
-		configPaths := []string{"."}
-
-		// Home
-		if home, err := homedir.Dir(); err == nil {
-			configPaths = append(configPaths, 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")
-				}
-			}
-			xdgConfig := filepath.Join(prefix, "autorestic")
-			configPaths = append(configPaths, xdgConfig)
-		}
+		configPaths := getConfigPaths()
 		for _, cfgPath := range configPaths {
 			viper.AddConfigPath(cfgPath)
 		}
@@ -88,3 +71,22 @@ func initConfig() {
 		viper.AutomaticEnv()
 	}
 }
+
+func getConfigPaths() []string {
+	result := []string{"."}
+	if home, err := homedir.Dir(); err == nil {
+		result = append(result, home)
+	}
+
+	{
+		xdgConfigHome, found := os.LookupEnv("XDG_CONFIG_HOME")
+		if !found {
+			if home, err := homedir.Dir(); err == nil {
+				xdgConfigHome = filepath.Join(home, ".config")
+			}
+		}
+		xdgConfig := filepath.Join(xdgConfigHome, "autorestic")
+		result = append(result, xdgConfig)
+	}
+	return result
+}

cmd/root_test.go

@@ -0,0 +1,36 @@
+package cmd
+
+import (
+	"github.com/mitchellh/go-homedir"
+	"os"
+	"path/filepath"
+	"slices"
+	"testing"
+)
+
+const xdgConfigHome = "XDG_CONFIG_HOME"
+
+func assertContains(t *testing.T, array []string, element string) {
+	if !slices.Contains(array, element) {
+		t.Errorf("Expected %s to be contained in %s", element, array)
+	}
+}
+
+func TestConfigResolving(t *testing.T) {
+	t.Run("~/.config/autorestic is used if XDG_CONFIG_HOME is not set", func(t *testing.T) {
+		// Override env using testing so that env gets restored after test
+		t.Setenv(xdgConfigHome, "")
+		_ = os.Unsetenv("XDG_CONFIG_HOME")
+		configPaths := getConfigPaths()
+		homeDir, _ := homedir.Dir()
+		expectedConfigPath := filepath.Join(homeDir, ".config/autorestic")
+		assertContains(t, configPaths, expectedConfigPath)
+	})
+
+	t.Run("XDG_CONFIG_HOME is respected if set", func(t *testing.T) {
+		t.Setenv(xdgConfigHome, "/foo/bar")
+
+		configPaths := getConfigPaths()
+		assertContains(t, configPaths, filepath.Join("/", "foo", "bar", "autorestic"))
+	})
+}

cmd/unlock.go

@@ -0,0 +1,80 @@
+package cmd
+
+import (
+	"bytes"
+	"fmt"
+	"os"
+	"os/exec"
+	"strings"
+
+	"github.com/cupcakearmy/autorestic/internal"
+	"github.com/cupcakearmy/autorestic/internal/colors"
+	"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 := internal.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
+}

docs/.codedoc/build.ts

@@ -1,15 +0,0 @@
-import { build } from '@codedoc/core';
-
-import { config } from './config';
-import { installTheme$ } from './content/theme';
-import { content } from './content';
-
-
-build(config, content, installTheme$, {
-  resolve: {
-    modules: ['.codedoc/node_modules']
-  },
-  resolveLoader: {
-    modules: ['.codedoc/node_modules']
-  }
-});

docs/.codedoc/config.ts

@@ -1,24 +0,0 @@
-import { configuration } from '@codedoc/core'
-
-export const config = configuration({
-  src: {
-    base: 'markdown',
-  },
-  dest: {
-    html: './build',
-    assets: './build',
-    bundle: './_',
-    styles: './_',
-  },
-  page: {
-    title: {
-      base: 'Autorestic',
-    },
-  },
-  misc: {
-    github: {
-      user: 'cupcakearmy',
-      repo: 'autorestic',
-    },
-  },
-})

docs/.codedoc/content/footer.tsx

@@ -1,19 +0,0 @@
-import { CodedocConfig } from '@codedoc/core';
-import { Footer as _Footer, GitterToggle$, Watermark} from '@codedoc/core/components';
-
-
-export function Footer(config: CodedocConfig, renderer: any) {
-  let github$;
-  if (config.misc?.github)
-    github$ = <a href={`https://github.com/${config.misc.github.user}/${config.misc.github.repo}/`} 
-                target="_blank">GitHub</a>;
-
-  let community$;
-  if (config.misc?.gitter)
-    community$ = <GitterToggle$ room={config.misc.gitter.room}/>
-
-  if (github$ && community$) return <_Footer>{github$}<hr/>{community$}</_Footer>;
-  else if (github$) return <_Footer>{github$}</_Footer>;
-  else if (community$) return <_Footer>{community$}</_Footer>;
-  else return <_Footer><Watermark/></_Footer>;
-}

docs/.codedoc/content/header.tsx

@@ -1,21 +0,0 @@
-import { CodedocConfig } from '@codedoc/core';
-import { Header as _Header, GithubButton, Watermark } from '@codedoc/core/components';
-
-
-export function Header(config: CodedocConfig, renderer: any) {
-  return (
-    <_Header>{config.misc?.github ?
-      <fragment>
-        <GithubButton action={config.misc.github.action || 'Star'}
-          repo={config.misc.github.repo}
-          user={config.misc.github.user}
-          large={config.misc.github.large === true}
-          count={config.misc.github.count !== false}
-          standardIcon={config.misc.github.standardIcon !== false}/>
-        <br/><br/>
-      </fragment>
-      : ''}
-      <Watermark/>
-    </_Header>
-  )
-}

docs/.codedoc/content/index.tsx

@@ -1,57 +0,0 @@
-import { RendererLike } from '@connectv/html'
-import { File } from 'rxline/fs'
-import {
-  Page,
-  Meta,
-  ContentNav,
-  Fonts,
-  ToC,
-  GithubSearch$,
-} from '@codedoc/core/components'
-
-import { config } from '../config'
-import { Header } from './header'
-import { Footer } from './footer'
-
-export function content(
-  _content: HTMLElement,
-  toc: HTMLElement,
-  renderer: RendererLike<any, any>,
-  file: File<string>
-) {
-  return (
-    <Page
-      title={config.page.title.extractor(_content, config, file)}
-      favicon={config.page.favicon}
-      meta={<Meta {...config.page.meta} />}
-      fonts={<Fonts {...config.page.fonts} />}
-      scripts={config.page.scripts}
-      stylesheets={config.page.stylesheets}
-      header={<Header {...config} />}
-      footer={<Footer {...config} />}
-      toc={
-        <ToC
-          default={'open'}
-          search={
-            config.misc?.github ? (
-              <GithubSearch$
-                repo={config.misc.github.repo}
-                user={config.misc.github.user}
-                root={config.src.base}
-                pick={config.src.pick.source}
-                drop={config.src.drop.source}
-              />
-            ) : (
-              false
-            )
-          }
-        >
-          {toc}
-        </ToC>
-      }
-    >
-      {_content}
-      <ContentNav content={_content} />
-    </Page>
-  )
-}

docs/.codedoc/content/theme.ts

@@ -1,8 +0,0 @@
-import { funcTransport } from '@connectv/sdh/transport';
-import { useTheme } from '@codedoc/core/transport';
-
-import { theme } from '../theme';
-
-
-export function installTheme() { useTheme(theme); }
-export const installTheme$ = /*#__PURE__*/funcTransport(installTheme);

docs/.codedoc/package.json

@@ -1,5 +0,0 @@
-{
-  "dependencies": {
-    "@codedoc/core": "^0.3.2"
-  }
-}

docs/.codedoc/serve.ts

@@ -1,18 +0,0 @@
-import { join } from 'path';
-import { serve } from '@codedoc/core';
-
-import { config } from './config';
-import { content } from './content';
-import { installTheme$ } from './content/theme';
-
-
-const root = join(__dirname, '../');
-
-serve(root, config, content, installTheme$, {
-  resolve: {
-    modules: ['.codedoc/node_modules']
-  },
-  resolveLoader: {
-    modules: ['.codedoc/node_modules']
-  }
-});

docs/.codedoc/theme.ts

@@ -1,11 +0,0 @@
-import { createTheme } from '@codedoc/core/transport';
-
-
-export const theme = /*#__PURE__*/createTheme({
-  light: {
-    primary: '#1eb2a6'
-  },
-  dark: {
-    primary: '#1eb2a6'
-  }
-});

docs/.codedoc/tsconfig.json

@@ -1,26 +0,0 @@
-{
-  "compilerOptions": {
-    "target": "es6",
-    "noImplicitAny": true,
-    "declaration": false,
-    "strictNullChecks": true,
-    "strictFunctionTypes": true,
-    "noImplicitThis": true,
-    "alwaysStrict": true,
-    "sourceMap": true,
-    "moduleResolution": "node",
-    "esModuleInterop": true,
-    "allowSyntheticDefaultImports": true,
-    "experimentalDecorators": true,
-    "emitDecoratorMetadata": true,
-    "jsx": "react",
-    "jsxFactory": "renderer.create",
-    "lib": [
-      "es2017",
-      "dom"
-    ]
-  },
-  "include": [
-    "./**/*"
-  ]
-}

docs/.codedoc/watch.ts

@@ -1,22 +0,0 @@
-import { exec, spawn } from 'child_process';
-import { config } from './config';
-
-
-const cmd = 'ts-node-dev'; 
-const params = `--project .codedoc/tsconfig.json` 
-            + ` -T --watch ${config.src.base},.codedoc`
-            + ` --ignore-watch .codedoc/node_modules`
-            + ` .codedoc/serve`;
-
-
-if (process.platform === 'win32') {
-  const child = exec(cmd + ' ' + params);
-
-  child.stdout?.pipe(process.stdout);
-  child.stderr?.pipe(process.stderr);
-  child.on('close', () => {});
-}
-else {
-  const child = spawn(cmd, [params], { stdio: 'inherit', shell: 'bash' });
-  child.on('close', () => {});
-}

docs/.gitignore

@@ -1,2 +1,2 @@
 node_modules
-build
+.next

docs/.nvmrc

@@ -0,0 +1 @@
+v22.7.0

docs/markdown/_toc.md

@@ -1,54 +0,0 @@
-[Home](/)
-[Quick Start](/quick)
-[Installation](/installation)
-[Configuration](/config)
-[Upgrade](/upgrade)
-
-> :Collapse label=Locations
->
-> [Overview](/location/overview)
-> [Hooks](/location/hooks)
->
-> > :Collapse label=Options
-> > 
-> > [Overview](/location/options)
-> > [Excluding Files](/location/exclude)
-> > [Forget Policy](/location/forget)
-> > [Copy](/location/copy)
->
-> [Cron](/location/cron)
-> [Docker Volumes](/location/docker)
-
-> :Collapse label=Backend
->
-> [Overview](/backend/overview)
-> [Available Backends](/backend/available)
-> [Options](/backend/options)
-> [Environment](/backend/env)
-
-> :Collapse label=CLI
->
-> [General](/cli/general)
-> [Info](/cli/info)
-> [Check](/cli/check)
-> [Completion](/cli/completion)
-> [Backup](/cli/backup)
-> [Restore](/cli/restore)
-> [Forget](/cli/forget)
-> [Cron](/cli/cron)
-> [Exec](/cli/exec)
-> [Install](/cli/install)
-> [Uninstall](/cli/uninstall)
-> [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)
-[Docker](/docker)
-[QA](/qa)
-[Community](/community)
-[Contributors](/contrib)
-

docs/markdown/backend/overview.md

@@ -1,20 +0,0 @@
-# 💽 Backends
-
-Backends are the outputs of the backup process. Each location needs at least one.
-
-Note: names of backends MUST be lower case!
-
-```yaml | .autorestic.yml
-version: 2
-
-backends:
-  name-of-backend:
-    type: local
-    path: /data/my/backups
-```
-
-## Types
-
-We restic supports multiple types of backends. See the [full list](/backend/available) for details.
-
-> :ToCPrevNext

docs/next.config.js

@@ -0,0 +1,6 @@
+const withNextra = require('nextra')({
+  theme: 'nextra-theme-docs',
+  themeConfig: './theme.config.jsx',
+})
+
+module.exports = withNextra()

docs/package.json

@@ -1,10 +1,15 @@
 {
-  "private": true,
   "scripts": {
-    "build": "codedoc install && codedoc build",
-    "dev": "codedoc serve"
+    "build": "NEXT_TELEMETRY_DISABLED=1 next build",
+    "dev": "NEXT_TELEMETRY_DISABLED=1 next",
+    "start": "NEXT_TELEMETRY_DISABLED=1 next start"
   },
   "dependencies": {
-    "@codedoc/cli": "^0.3.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@9.9.0"
 }

docs/pages/_meta.json

@@ -0,0 +1,11 @@
+{
+  "index": "Home",
+  "quick": "Quick Start",
+  "installation": "Installation",
+  "config": "Configuration",
+  "lockfile": "Lockfile",
+  "location": "Locations",
+  "backend": "Backend",
+  "cli": "CLI",
+  "migration": "Migration"
+}

docs/pages/backend/_meta.json

@@ -0,0 +1,6 @@
+{
+  "index": "Overview",
+  "available": "Available backends",
+  "options": "Options",
+  "env": "Environment"
+}

docs/pages/backend/available.md

@@ -83,5 +83,3 @@ backends:
       user: user
       password: pass
 ```
-
-> :ToCPrevNext

docs/pages/backend/env.md

@@ -63,5 +63,3 @@ backends:
     type: b2
     path: myBucket
 ```
-
-> :ToCPrevNext

docs/pages/backend/index.md

@@ -0,0 +1,40 @@
+# 💽 Backends
+
+Backends are the outputs of the backup process. Each location needs at least one.
+
+Note: names of backends MUST be lower case!
+
+```yaml | .autorestic.yml
+version: 2
+
+backends:
+  name-of-backend:
+    type: local
+    path: /data/my/backups
+```
+
+## 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.

docs/pages/backend/options.md

@@ -15,5 +15,3 @@ backend:
 ```
 
 In this example, whenever `autorestic` runs `restic backup` it will append a `--tag abc --tag` to the native command.
-
-> :ToCPrevNext

docs/pages/cli/_meta.json

@@ -0,0 +1,3 @@
+{
+  "general": "General"
+}

docs/pages/cli/backup.md

@@ -21,5 +21,3 @@ autorestic backup -l foo -l bar
 ```bash
 autorestic backup -l location@backend
 ```
-
-> :ToCPrevNext

docs/pages/cli/check.md

@@ -7,5 +7,3 @@ autorestic check
 Checks locations and backends are configured properly and initializes them if they are not already.
 
 This is mostly an internal command, but useful to verify if a backend is configured correctly.
-
-> :ToCPrevNext

docs/pages/cli/completion.md

@@ -13,5 +13,3 @@ Supported shells are
 - powershell
 
 To see how to install run `autorestic help completion` and follow the instructions for your specific shell
-
-> :ToCPrevNext

docs/pages/cli/cron.md

@@ -9,5 +9,3 @@ This command is mostly intended to be triggered by an automated system like syst
 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/pages/cli/exec.md

@@ -11,5 +11,3 @@ 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.
-
-> :ToCPrevNext

docs/pages/cli/forget.md

@@ -4,10 +4,8 @@
 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.
 
 The `--prune` flag will also [prune the data](https://restic.readthedocs.io/en/latest/060_forget.html#removing-backup-snapshots). This is a costly operation that can take longer, however it will free up the actual space.
-
-> :ToCPrevNext

docs/pages/cli/general.md

@@ -35,4 +35,10 @@ With `--restic-bin` you can specify to run a specific restic binary. This can be
 autorestic --restic-bin /some/path/to/my/custom/restic/binary
 ```
 
-> :ToCPrevNext
+## `--lockfile`
+
+Specify the path for the [lockfile](../lockfile.md) used by `autorestic`. If omitted, this will default to `.autorestic.lock.yml` next to the loaded config file.
+
+```bash
+autorestic --lockfile /path/to/my/.autorestic.lock.yml
+```

docs/pages/cli/info.md

@@ -14,5 +14,3 @@ autorestic info
 ```bash
 autorestic -c path/to/some/config.yml info
 ```
-
-> :ToCPrevNext

docs/pages/cli/install.md

@@ -5,5 +5,3 @@ Installs both restic and autorestic to `/usr/local/bin`.
 ```bash
 autorestic install
 ```
-
-> :ToCPrevNext

docs/pages/cli/restore.md

@@ -15,5 +15,3 @@ autorestic restore -l home --from hdd --to /path/where/to/restore
 ```
 
 This will restore the location `home` to the `/path/where/to/restore` folder and taking the data from the backend `hdd`
-
-> :ToCPrevNext

docs/pages/cli/uninstall.md

@@ -5,5 +5,3 @@ Uninstalls both restic and autorestic from `/usr/local/bin`.
 ```bash
 autorestic uninstall
 ```
-
-> :ToCPrevNext

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
+```

docs/pages/cli/upgrade.md

@@ -7,5 +7,3 @@ autorestic upgrade
 ```
 
 Updates both restic and autorestic automagically.
-
-> :ToCPrevNext

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>
@@ -10,4 +12,6 @@ A list of community driven projects. (No official affiliation)
 - Ansible Role: <https://0xacab.org/varac-projects/ansible-role-autorestic>
 - Ansible Role: <https://github.com/dbrennand/ansible-role-autorestic>
 
-> :ToCPrevNext
+## Writing
+
+- [restic: excellent resource for local and cloud backup](https://notes.nicfab.eu/en/posts/restic/)

docs/pages/config.md

@@ -2,10 +2,11 @@
 
 ## Path
 
-By default autorestic searches for a `.autorestic.yml` file in the current directory and your home folder.
+By default autorestic searches for a `.autorestic.yml` file in the current directory, your home folder and your XDG config folder (`~/.config/` by default):
 
 - `./.autorestic.yml`
 - `~/.autorestic.yml`
+- `~/.config/autorestic/.autorestic.yml`
 
 You can also specify a custom file with the `-c path/to/some/config.yml`
 
@@ -55,6 +56,8 @@ version: 2
 
 extras:
   hooks: &foo
+    prevalidate:
+      - echo "Wake up!"
     before:
       - echo "Hello"
     after:
@@ -83,5 +86,3 @@ locations:
       forget:
         <<: *bar
 ```
-
-> :ToCPrevNext

docs/pages/contributors.md

@@ -17,5 +17,3 @@ This amazing people helped the project!
 - @TheForcer - Typos.
 - @themorlan - Typos.
 - @somebox - Typos.
-
-> :ToCPrevNext

docs/pages/examples.md

@@ -36,5 +36,3 @@ locations:
     to:
       - somewhere-else
 ```
-
-> :ToCPrevNext

docs/pages/index.md

@@ -13,10 +13,8 @@ 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
 - Generated completions for `[bash|zsh|fish|powershell]`
-
-> :ToCPrevNext

docs/pages/installation.md

@@ -30,6 +30,4 @@ Fedora users can install the [autorestic](https://src.fedoraproject.org/rpms/aut
 
 ### AUR
 
-~~If you are on Arch there is an [AUR Package](https://aur.archlinux.org/packages/autorestic-bin/) (looking for maintainers).~~ - Deprecated
-
-> :ToCPrevNext
+If you are on Arch there is an [AUR Package](https://aur.archlinux.org/packages/autorestic-bin/)

docs/pages/location/_meta.json

@@ -0,0 +1,7 @@
+{
+  "index": "Overview",
+  "hooks": "Hooks",
+  "options": "Options",
+  "cron": "Cronjobs",
+  "docker": "Docker volumes"
+}

docs/pages/location/cron.md

@@ -1,6 +1,6 @@
 # Cron
 
-Often it is usefully to trigger backups automatically. For this we can specify a `cron` attribute to each location.
+Often it is useful to trigger backups automatically. For this, we can specify a `cron` attribute to each location.
 
 ```yaml | .autorestic.yml
 locations:
@@ -10,15 +10,15 @@ locations:
     cron: '0 3 * * 0' # Every Sunday at 3:00
 ```
 
-Here is a awesome website with [some examples](https://crontab.guru/examples.html) and an [explorer](https://crontab.guru/)
+Here is an awesome website with [some examples](https://crontab.guru/examples.html) and an [explorer](https://crontab.guru/).
 
 ## Installing the cron
 
-**This has to be done only once, regardless of now many cron jobs you have in your config file.**
+**This has to be done only once, regardless of how many cron jobs you have in your config file.**
 
 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.
+My advice 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
 
@@ -50,6 +50,4 @@ To debug a cron job you can use
 
 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.
-
-> :ToCPrevNext
+> Also note that manually triggered backups with `autorestic backup` will not influence the cron timeline, they are intentionally not linked.

docs/pages/location/docker.md

@@ -18,7 +18,7 @@ services:
 
 ```yaml | .autorestic.yml
 locations:
-  foo:
+  hello:
     from: my-data
     type: volume
     # ...
@@ -35,5 +35,3 @@ autorestic restore -l hello
 ```
 
 The volume has to exists whenever backing up or restoring.
-
-> :ToCPrevNext

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
 
@@ -76,5 +83,3 @@ AUTORESTIC_LOCATION=bar
 AUTORESTIC_FILES_ADDED_0=42
 AUTORESTIC_FILES_ADDED_FOO=42
 ```
-
-> :ToCPrevNext

docs/pages/location/index.md

@@ -4,6 +4,7 @@ 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.
 
 Note: names of locations MUST be lower case!
+
 ```yaml | .autorestic.yml
 version: 2
 
@@ -30,5 +31,3 @@ Paths can be absolute or relative. If relative they are resolved relative to the
 ## `to`
 
 This is either a single backend or an array of backends. The backends have to be configured in the same config file.
-
-> :ToCPrevNext

docs/pages/location/options/_meta.json

@@ -0,0 +1,3 @@
+{
+  "index": "Overview"
+}

docs/pages/location/options/exclude.md

@@ -16,5 +16,3 @@ locations:
           - '*.abc'
         exclude-file: .gitignore
 ```
-
-> :ToCPrevNext

docs/pages/location/options/forget.md

@@ -53,5 +53,3 @@ locations:
       forget:
         keep-last: 5
 ```
-
-> :ToCPrevNext

docs/pages/location/options/index.md

@@ -63,5 +63,3 @@ backends:
 locations:
   # ...
 ```
-
-> :ToCPrevNext

docs/pages/lockfile.md

@@ -0,0 +1,14 @@
+# Lockfile
+
+Under the hood, `autorestic` uses a lockfile to ensure that only one instance is running and to keep track of when [cronjobs](./location/cron.md) were last run.
+
+By default, the lockfile is stored next to your [configuration file](./config.md) as `.autorestic.lock.yml`. In other words, if your config file is located at `/some/path/.autorestic.yml`, then the lockfile will be located at `/some/path/.autorestic.lock.yml`.
+
+## Customization
+
+The path to the lockfile can be customized if need be. This can be done is a few ways:
+
+1. Using the `--lockfile ...` command line flag
+1. Setting `lockfile: ...` in the configuration file
+
+Note that `autorestic` will check for a customized lockfile path in the order listed above. This means that if you specify a lockfile path in multiple places, the method that's higher in the list will win.

docs/pages/migration/0.x_1.0.md

@@ -22,5 +22,3 @@ remote:
 ```
 
 Other than the config file there is a new `-v, --verbose` flag which shows the output of native commands, which are now hidden by default.
-
-> :ToCPrevNext

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

@@ -64,5 +64,3 @@ Autorestic changed the way backups are referenced. Before we took the paths as t
 ```bash
 autorestic exec -va -- tag --add ar:location:LOCATION_NAME # Only if you have only one location
 ```
-
-> :ToCPrevNext

docs/pages/migration/_meta.json

@@ -0,0 +1,4 @@
+{
+  "0.x_1.0": "0.x → 1.0",
+  "1.4_1.5": "1.4 → 1.5"
+}

docs/pages/qa.md

@@ -6,5 +6,3 @@ This happens when autorestic needs to write to the config file: e.g. when we are
 Unfortunately during this process formatting and comments are lost because the `yaml` library used is not comment and/or format aware.
 
 That is why autorestic will place a copy of your old config next to the one we are writing to.
-
-> :ToCPrevNext

docs/pages/quick.md

@@ -82,5 +82,3 @@ autorestic restore -l home --from hdd --to /path/where/to/restore
 ```
 
 This will restore the location `home` from the backend `hdd` to the given path.
-
-> :ToCPrevNext

docs/theme.config.jsx

@@ -0,0 +1,24 @@
+export default {
+  logo: <span>Autorestic</span>,
+  docsRepositoryBase: 'https://github.com/cupcakearmy/autorestic/tree/master/docs',
+  project: {
+    link: 'https://github.com/cupcakearmy/autorestic',
+  },
+  sidebar: {
+    defaultMenuCollapseLevel: 1,
+  },
+  feedback: {
+    content: 'Question? An error? Give feedback →',
+  },
+  footer: {
+    text: (
+      <span>
+        MIT {new Date().getFullYear()} ©{' '}
+        <a href="https://github.com/cupcakearmy" target="_blank">
+          cupcakearmy
+        </a>
+        .
+      </span>
+    ),
+  },
+}

docs/vercel.json

@@ -1,3 +0,0 @@
-{
-  "cleanUrls": true
-}

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
 )

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=

install.sh

@@ -1,5 +1,5 @@
 #!/bin/bash
-
+set -e -o pipefail
 shopt -s nocaseglob
 
 OUT_FILE=/usr/local/bin/autorestic
@@ -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

internal/backend.go

@@ -6,6 +6,7 @@ import (
 	"fmt"
 	"net/url"
 	"os"
+	"regexp"
 	"strings"
 
 	"github.com/cupcakearmy/autorestic/internal/colors"
@@ -13,18 +14,19 @@ import (
 )
 
 type BackendRest struct {
-	User     string `mapstructure:"user,omitempty"`
-	Password string `mapstructure:"password,omitempty"`
+	User     string `mapstructure:"user,omitempty" yaml:"user,omitempty"`
+	Password string `mapstructure:"password,omitempty" 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"`
-	Rest    BackendRest       `mapstructure:"rest,omitempty"`
-	Options Options           `mapstructure:"options,omitempty"`
+	name       string
+	Type       string            `mapstructure:"type,omitempty" yaml:"type,omitempty"`
+	Path       string            `mapstructure:"path,omitempty" yaml:"path,omitempty"`
+	Key        string            `mapstructure:"key,omitempty" yaml:"key,omitempty"`
+	RequireKey bool              `mapstructure:"requireKey,omitempty" yaml:"requireKey,omitempty"`
+	Env        map[string]string `mapstructure:"env,omitempty" yaml:"env,omitempty"`
+	Rest       BackendRest       `mapstructure:"rest,omitempty" yaml:"rest,omitempty"`
+	Options    Options           `mapstructure:"options,omitempty" yaml:"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

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")
+	})
 }

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
 		}

internal/config.go

@@ -10,24 +10,24 @@ import (
 
 	"github.com/cupcakearmy/autorestic/internal/colors"
 	"github.com/cupcakearmy/autorestic/internal/flags"
-	"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.7.9"
+const VERSION = "1.8.3"
 
 type OptionMap map[string][]interface{}
 type Options map[string]OptionMap
 
 type Config struct {
-	Version   string              `mapstructure:"version"`
-	Extras    interface{}         `mapstructure:"extras"`
-	Locations map[string]Location `mapstructure:"locations"`
-	Backends  map[string]Backend  `mapstructure:"backends"`
-	Global    Options             `mapstructure:"global"`
+	Version   string              `mapstructure:"version" yaml:"version"`
+	Lockfile  string              `mapstructure:"lockfile,omitempty" yaml:"lockfile,omitempty"`
+	Extras    interface{}         `mapstructure:"extras" yaml:"extras"`
+	Locations map[string]Location `mapstructure:"locations" yaml:"locations"`
+	Backends  map[string]Backend  `mapstructure:"backends" yaml:"backends"`
+	Global    Options             `mapstructure:"global" yaml:"global"`
 }
 
 var once sync.Once
@@ -40,7 +40,7 @@ func exitConfig(err error, msg string) {
 	if msg != "" {
 		colors.Error.Println(msg)
 	}
-	lock.Unlock()
+	Unlock()
 	os.Exit(1)
 }
 
@@ -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 {

internal/config_test.go

@@ -1,10 +1,15 @@
 package internal
 
 import (
+	"path"
 	"reflect"
 	"strconv"
 	"strings"
+	"sync"
 	"testing"
+
+	"github.com/spf13/viper"
+	"github.com/stretchr/testify/assert"
 )
 
 func TestOptionToString(t *testing.T) {
@@ -143,6 +148,48 @@ func TestGetOptionsMultipleKeys(t *testing.T) {
 	reflect.DeepEqual(result, expected)
 }
 
+func TestSaveConfigProducesReadableConfig(t *testing.T) {
+	workDir := t.TempDir()
+	viper.SetConfigFile(path.Join(workDir, ".autorestic.yml"))
+
+	// Required to appease the config reader
+	viper.Set("version", 2)
+
+	c := Config{
+		Version: "2",
+		Locations: map[string]Location{
+			"test": {
+				Type: "local",
+				name: "test",
+				From: []string{"in-dir"},
+				To:   []string{"test"},
+				// ForgetOption & ConfigOption have previously marshalled in a way that
+				// can't get read correctly
+				ForgetOption: "foo",
+				CopyOption:   map[string][]string{"foo": {"bar"}},
+			},
+		},
+		Backends: map[string]Backend{
+			"test": {
+				name: "test",
+				Type: "local",
+				Path: "backup-target",
+				Key:  "supersecret",
+			},
+		},
+	}
+
+	err := c.SaveConfig()
+	assert.NoError(t, err)
+
+	// Ensure we the config reading logic actually runs
+	config = nil
+	once = sync.Once{}
+	readConfig := GetConfig()
+	assert.NotNil(t, readConfig)
+	assert.Equal(t, c, *readConfig)
+}
+
 func assertEqual[T comparable](t testing.TB, result, expected T) {
 	t.Helper()
 

internal/cron.go

@@ -1,12 +1,22 @@
 package internal
 
+import (
+	"errors"
+	"fmt"
+)
+
 func RunCron() error {
 	c := GetConfig()
+	var errs []error
 	for name, l := range c.Locations {
 		l.name = name
 		if err := l.RunCron(); err != nil {
-			return err
+			errs = append(errs, err)
 		}
 	}
+
+	if len(errs) > 0 {
+		return fmt.Errorf("Encountered errors during cron process:\n%w", errors.Join(errs...))
+	}
 	return nil
 }

internal/flags/flags.go

@@ -1,9 +1,10 @@
 package flags
 
 var (
-	CI         bool = false
-	VERBOSE    bool = false
-	CRON_LEAN  bool = false
-	RESTIC_BIN string
+	CI           bool = false
+	VERBOSE      bool = false
+	CRON_LEAN    bool = false
+	RESTIC_BIN   string
 	DOCKER_IMAGE string
+	LOCKFILE     string
 )

internal/location.go

@@ -1,6 +1,7 @@
 package internal
 
 import (
+	"errors"
 	"fmt"
 	"io/ioutil"
 	"os"
@@ -10,7 +11,6 @@ import (
 
 	"github.com/cupcakearmy/autorestic/internal/colors"
 	"github.com/cupcakearmy/autorestic/internal/flags"
-	"github.com/cupcakearmy/autorestic/internal/lock"
 	"github.com/cupcakearmy/autorestic/internal/metadata"
 	"github.com/robfig/cron"
 )
@@ -33,25 +33,26 @@ 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" yaml:"dir"`
+	PreValidate HookArray `mapstructure:"prevalidate,omitempty" yaml:"prevalidate,omitempty"`
+	Before      HookArray `mapstructure:"before,omitempty" yaml:"before,omitempty"`
+	After       HookArray `mapstructure:"after,omitempty" yaml:"after,omitempty"`
+	Success     HookArray `mapstructure:"success,omitempty" yaml:"success,omitempty"`
+	Failure     HookArray `mapstructure:"failure,omitempty" yaml:"failure,omitempty"`
 }
 
 type LocationCopy = map[string][]string
 
 type Location struct {
-	name         string               `mapstructure:",omitempty"`
-	From         []string             `mapstructure:"from,omitempty"`
-	Type         string               `mapstructure:"type,omitempty"`
-	To           []string             `mapstructure:"to,omitempty"`
-	Hooks        Hooks                `mapstructure:"hooks,omitempty"`
-	Cron         string               `mapstructure:"cron,omitempty"`
-	Options      Options              `mapstructure:"options,omitempty"`
-	ForgetOption LocationForgetOption `mapstructure:"forget,omitempty"`
-	CopyOption   LocationCopy         `mapstructure:"copy,omitempty"`
+	name         string               `mapstructure:",omitempty" yaml:",omitempty"`
+	From         []string             `mapstructure:"from,omitempty" yaml:"from,omitempty"`
+	Type         string               `mapstructure:"type,omitempty" yaml:"type,omitempty"`
+	To           []string             `mapstructure:"to,omitempty" yaml:"to,omitempty"`
+	Hooks        Hooks                `mapstructure:"hooks,omitempty" yaml:"hooks,omitempty"`
+	Cron         string               `mapstructure:"cron,omitempty" yaml:"cron,omitempty"`
+	Options      Options              `mapstructure:"options,omitempty" yaml:"options,omitempty"`
+	ForgetOption LocationForgetOption `mapstructure:"forget,omitempty" yaml:"forget,omitempty"`
+	CopyOption   LocationCopy         `mapstructure:"copy,omitempty" yaml:"copy,omitempty"`
 }
 
 func GetLocation(name string) (Location, bool) {
@@ -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 {
@@ -433,12 +441,15 @@ func (l Location) RunCron() error {
 	if err != nil {
 		return err
 	}
-	last := time.Unix(lock.GetCron(l.name), 0)
+	last := time.Unix(GetCron(l.name), 0)
 	next := schedule.Next(last)
 	now := time.Now()
 	if now.After(next) {
-		lock.SetCron(l.name, now.Unix())
-		l.Backup(true, "")
+		SetCron(l.name, now.Unix())
+		errs := l.Backup(true, "")
+		if len(errs) > 0 {
+			return fmt.Errorf("Failed to backup location \"%s\":\n%w", l.name, errors.Join(errs...))
+		}
 	} else {
 		if !flags.CRON_LEAN {
 			colors.Body.Printf("Skipping \"%s\", not due yet.\n", l.name)

internal/lock.go

@@ -1,8 +1,9 @@
-package lock
+package internal
 
 import (
 	"os"
 	"path"
+	"path/filepath"
 	"sync"
 
 	"github.com/cupcakearmy/autorestic/internal/colors"
@@ -12,24 +13,47 @@ import (
 
 var lock *viper.Viper
 var file string
-var once sync.Once
+var lockOnce sync.Once
 
 const (
 	RUNNING = "running"
 )
 
+// getLockfilePath returns the path to the lockfile. The path for the lockfile
+// can be sources from multiple places If flags.LOCKFILE is set, its value is
+// used; if the config has the `lockfile` option set, its value is used;
+// otherwise the path is generated relative to the config file.
+func getLockfilePath() string {
+	if flags.LOCKFILE != "" {
+		abs, err := filepath.Abs(flags.LOCKFILE)
+		if err != nil {
+			return flags.LOCKFILE
+		}
+		return abs
+	}
+
+	if lockfile := GetConfig().Lockfile; lockfile != "" {
+		abs, err := filepath.Abs(lockfile)
+		if err != nil {
+			return lockfile
+		}
+		return abs
+	}
+
+	p := viper.ConfigFileUsed()
+	if p == "" {
+		colors.Error.Println("cannot lock before reading config location")
+		os.Exit(1)
+	}
+	return path.Join(path.Dir(p), ".autorestic.lock.yml")
+}
+
 func getLock() *viper.Viper {
 	if lock == nil {
-
-		once.Do(func() {
+		lockOnce.Do(func() {
 			lock = viper.New()
 			lock.SetDefault("running", false)
-			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")
+			file = getLockfilePath()
 			if !flags.CRON_LEAN {
 				colors.Faint.Println("Using lock:\t", file)
 			}

internal/lock_test.go

@@ -1,30 +1,88 @@
-package lock
+package internal
 
 import (
-	"log"
 	"os"
 	"os/exec"
+	"path"
 	"strconv"
+	"sync"
 	"testing"
 
+	"github.com/cupcakearmy/autorestic/internal/flags"
 	"github.com/spf13/viper"
+	"github.com/stretchr/testify/assert"
 )
 
-var testDirectory = "autorestic_test_tmp"
-
 // All tests must share the same lock file as it is only initialized once
 func setup(t *testing.T) {
-	d, err := os.MkdirTemp("", testDirectory)
-	if err != nil {
-		log.Fatalf("error creating temp dir: %v", err)
-		return
-	}
-	// set config file location
-	viper.SetConfigFile(d + "/.autorestic.yml")
-
-	t.Cleanup(func() {
-		os.RemoveAll(d)
+	t.Helper()
+	cleanup := func() {
+		flags.LOCKFILE = ""
+		config = nil
+		once = sync.Once{}
 		viper.Reset()
+	}
+
+	cleanup()
+	d := t.TempDir()
+	viper.SetConfigFile(d + "/.autorestic.yml")
+	viper.Set("version", 2)
+	viper.WriteConfig()
+
+	t.Cleanup(cleanup)
+}
+
+func TestGetLockfilePath(t *testing.T) {
+	t.Run("user specified", func(t *testing.T) {
+		testCases := []struct {
+			name     string
+			flag     string
+			config   string
+			expected string
+		}{
+			{
+				name:     "flag and config",
+				flag:     "/flag.lock.yml",
+				config:   "/config.lock.yml",
+				expected: "/flag.lock.yml",
+			},
+			{
+				name:     "flag only",
+				flag:     "/flag.lock.yml",
+				config:   "",
+				expected: "/flag.lock.yml",
+			},
+			{
+				name:     "config only",
+				flag:     "",
+				config:   "/config.lock.yml",
+				expected: "/config.lock.yml",
+			},
+		}
+		for _, testCase := range testCases {
+			t.Run(testCase.name, func(t *testing.T) {
+				setup(t)
+				flags.LOCKFILE = testCase.flag
+				if testCase.config != "" {
+					viper.Set("lockfile", testCase.config)
+					err := viper.WriteConfig()
+					assert.NoError(t, err)
+				}
+
+				p := getLockfilePath()
+				assert.Equal(t, testCase.expected, p)
+			})
+		}
+	})
+
+	t.Run("default", func(t *testing.T) {
+		setup(t)
+
+		configPath := viper.ConfigFileUsed()
+		expectedLockfile := path.Join(path.Dir(configPath), ".autorestic.lock.yml")
+
+		p := getLockfilePath()
+		assert.Equal(t, expectedLockfile, p)
 	})
 }
 

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,
@@ -22,7 +22,7 @@ import (
 	"syscall"
 
 	"github.com/cupcakearmy/autorestic/cmd"
-	"github.com/cupcakearmy/autorestic/internal/lock"
+	"github.com/cupcakearmy/autorestic/internal"
 )
 
 func handleCtrlC() {
@@ -31,7 +31,7 @@ func handleCtrlC() {
 	go func() {
 		sig := <-c
 		fmt.Println("Signal:", sig)
-		lock.Unlock()
+		internal.Unlock()
 		os.Exit(0)
 	}()
 }