Compare commits

...

57 Commits

Author SHA1 Message Date
86ae70672a right version 2021-08-05 21:58:48 +02:00
5c0788900f docs 2021-08-05 21:54:40 +02:00
20334a7e83 better config handling 2021-08-05 21:48:02 +02:00
7bebd04482 validate and show cwd 2021-07-12 19:10:36 +02:00
b9b8857bf4 aliases 2021-07-12 19:10:25 +02:00
dd6e618161 typo 2021-07-11 14:03:04 +02:00
a4b54f9f64 check config bugs 2021-07-11 13:51:04 +02:00
c2e88193cd Update contrib.md 2021-06-06 15:51:50 +02:00
a2ef69d96d Merge pull request #87 from somebox/patch-1
correction to B2 config in the example
2021-06-06 15:48:02 +02:00
Jeremy Seitz
d45949b028 correction to B2 config in the example
This example was missing the `env:` block in YAML, which if missing, caused `autorestic check` to compain:

``` * 'Backends[remote]' has invalid keys: b2_account_id, b2_account_key```
2021-06-06 14:27:26 +02:00
77d47cc697 add arm in install script 2021-05-25 22:57:42 +02:00
a3239c0f3b changelog 2021-05-17 22:40:27 +02:00
90cd3171e5 docs 2021-05-17 22:40:23 +02:00
61673bd88b allow options for backend 2021-05-17 22:34:14 +02:00
41736ea3c4 typos 2021-05-07 11:34:46 +02:00
a7779e04bd Merge pull request #75 from FuzzyMistborn/patch-2
Update update command in docs
2021-05-07 11:31:26 +02:00
Fuzzy
1326e7e53c Update update command in docs 2021-05-06 23:05:34 -04:00
478e193d78 forgot version bump 2021-05-06 16:17:45 +02:00
11d4c67dce docs 2021-05-06 16:14:29 +02:00
1643309957 changelog 2021-05-06 15:57:28 +02:00
e05386b0b5 add failure and success hooks 2021-05-06 15:55:32 +02:00
aebaf0a225 Merge branch 'master' of https://github.com/cupcakearmy/autorestic 2021-05-06 15:12:37 +02:00
c090013bf5 Update README.md 2021-05-06 15:12:11 +02:00
88c6949208 custom restic binary 2021-05-06 15:04:35 +02:00
9256cdc38c changelog 2021-05-01 22:57:01 +02:00
a8c611e8ce Merge branch 'master' of https://github.com/cupcakearmy/autorestic 2021-05-01 22:54:57 +02:00
d4522c7ffe fix validation for docker volumes 2021-05-01 22:54:52 +02:00
21185d894e Update contrib.md 2021-05-01 17:25:50 +02:00
b119fc7ea5 Merge pull request #72 from themorlan/master
Correcting some typos in the Documentation
2021-05-01 17:25:20 +02:00
themorlan
73f4bcfd48 missing words in sentence 2021-05-01 15:18:05 +02:00
themorlan
3567319314 typo 2021-05-01 15:16:13 +02:00
themorlan
bf19c983d1 typo 2021-05-01 15:15:44 +02:00
themorlan
12e4de110b typo 2021-05-01 15:14:50 +02:00
c9f425ef64 docs on native flags 2021-04-30 10:47:29 +02:00
974f555dff Update contrib.md 2021-04-29 15:18:03 +02:00
1688c1f3c3 add brew docs 2021-04-29 15:16:33 +02:00
29e46d3b5c brew stuff 2021-04-29 14:45:17 +02:00
0335abb669 add sign 2021-04-28 14:51:56 +02:00
b2f9b9a54e typo 2021-04-28 13:50:11 +02:00
2b13a6e13d installtion docs 2021-04-28 13:44:20 +02:00
cc293ea256 Update installation.md 2021-04-28 13:38:20 +02:00
a4ddd5bbcb Update contrib.md 2021-04-28 13:34:58 +02:00
7cbf43b75d Update README.md 2021-04-28 11:13:16 +02:00
bae77c4673 Update README.md 2021-04-28 11:10:36 +02:00
12adeb2b06 changelog 2021-04-28 10:54:33 +02:00
37b26dfc31 consistent casing 2021-04-28 10:54:30 +02:00
c1795b2acc lean flag 2021-04-28 10:54:07 +02:00
b8d12e518c completion docs 2021-04-28 10:34:43 +02:00
50060cf539 explain verbose flag 2021-04-27 18:38:51 +02:00
c33aac42dc quickstart 2021-04-27 18:35:32 +02:00
c359053e0e Update contrib.md 2021-04-27 09:02:39 +02:00
c16340ab26 Update available.md 2021-04-27 09:01:01 +02:00
edc85c4ac3 Merge pull request #60 from david-boles/backblaze
Update Backblaze docs
2021-04-27 08:59:44 +02:00
68682777f2 Merge pull request #59 from david-boles/consistent-config-location
Recommend a consistent config location
2021-04-27 08:26:22 +02:00
David Boles
b6c7922df5 Recommend a consistent config location 2021-04-26 16:47:00 -07:00
David Boles
991b8bec22 Update backblaze docs 2021-04-26 16:38:08 -07:00
bbc32568ad parallel builds 2021-04-26 13:29:26 +02:00
40 changed files with 494 additions and 904 deletions

View File

@@ -15,6 +15,11 @@ jobs:
go-version: '^1.16.3' go-version: '^1.16.3'
- name: Build - name: Build
run: go run build/build.go run: go run build/build.go
- name: Sign
uses: tristan-weil/ghaction-checksum-sign-artifact@v1.0.1
with:
path: dist/*
- name: Release - name: Release
uses: softprops/action-gh-release@v1 uses: softprops/action-gh-release@v1
with: with:

View File

@@ -5,6 +5,57 @@ 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/), 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). and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [1.2.0] - 2021-08-05
### Added
- Community page
- Support for yaml references and aliases
### Fixed
- Better verbose output for hooks
- Better error message for bad formatted configs
## [1.1.2] - 2021-07-11
### Fixes
Don't check all backend when running `forget` or `exec` commands.
## [1.1.1] - 2021-05-17
### Added
- Options for backends
## [1.1.0] - 2021-05-06
### Added
- use custom restic binary
- success & failure hooks
### Fixed
- don't skip other locations on failure
## [1.0.9] - 2021-05-01
### Fixed
- Validation for docker volumes
## [1.0.8] - 2021-04-28
### Added
- `--lean` flag to cron command for less output about skipping backups.
### Fixed
- consistent lower casing in usage descriptions.
## [1.0.7] - 2021-04-26 ## [1.0.7] - 2021-04-26
### Added ### Added

View File

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

View File

@@ -10,6 +10,13 @@
Config driven, easy backup cli for <a href="https://restic.net/">restic</a>. Config driven, easy backup cli for <a href="https://restic.net/">restic</a>.
<br> <br>
<strong><a href="https://autorestic.vercel.app/">»»» Docs & Getting Started »»»</a></strong> <strong><a href="https://autorestic.vercel.app/">»»» Docs & Getting Started »»»</a></strong>
<br><br>
<a target="_blank" href="https://discord.gg/wS7RpYTYd2">
<img src="https://img.shields.io/discord/252403122348097536" alt="discord badge" />
<img src="https://img.shields.io/github/contributors/cupcakearmy/autorestic" alt="contributor badge" />
<img src="https://img.shields.io/github/downloads/cupcakearmy/autorestic/total" alt="downloads badge" />
<img src="https://img.shields.io/github/v/release/cupcakearmy/autorestic" alt="version badge" />
</a>
</p> </p>
</p> </p>
@@ -35,7 +42,7 @@ Autorestic is a wrapper around the amazing [restic](https://restic.net/). While
### ❓ Questions / Support ### ❓ Questions / Support
Check the [discussions page](https://github.com/cupcakearmy/autorestic/discussions) Check the [discussions page](https://github.com/cupcakearmy/autorestic/discussions) or [join on discord](https://discord.gg/wS7RpYTYd2)
## Contributing / Developing ## Contributing / Developing

View File

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

View File

@@ -13,19 +13,18 @@ var backupCmd = &cobra.Command{
Use: "backup", Use: "backup",
Short: "Create backups for given locations", Short: "Create backups for given locations",
Run: func(cmd *cobra.Command, args []string) { Run: func(cmd *cobra.Command, args []string) {
internal.GetConfig()
err := lock.Lock() err := lock.Lock()
CheckErr(err) CheckErr(err)
defer lock.Unlock() defer lock.Unlock()
CheckErr(internal.CheckConfig())
selected, err := internal.GetAllOrSelected(cmd, false) selected, err := internal.GetAllOrSelected(cmd, false)
CheckErr(err) CheckErr(err)
errors := 0 errors := 0
for _, name := range selected { for _, name := range selected {
location, _ := internal.GetLocation(name) location, _ := internal.GetLocation(name)
err := location.Backup(false) errs := location.Backup(false)
if err != nil { for err := range errs {
colors.Error.Println(err) colors.Error.Println(err)
errors++ errors++
} }

View File

@@ -11,6 +11,7 @@ var cronCmd = &cobra.Command{
Short: "Run cron job for automated backups", 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.`, 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) { Run: func(cmd *cobra.Command, args []string) {
internal.CRON_LEAN, _ = cmd.Flags().GetBool("lean")
err := lock.Lock() err := lock.Lock()
CheckErr(err) CheckErr(err)
defer lock.Unlock() defer lock.Unlock()
@@ -22,4 +23,5 @@ var cronCmd = &cobra.Command{
func init() { func init() {
rootCmd.AddCommand(cronCmd) rootCmd.AddCommand(cronCmd)
cronCmd.Flags().Bool("lean", false, "only output information about actual backups")
} }

View File

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

View File

@@ -10,12 +10,11 @@ var forgetCmd = &cobra.Command{
Use: "forget", Use: "forget",
Short: "Forget and optionally prune snapshots according the specified policies", Short: "Forget and optionally prune snapshots according the specified policies",
Run: func(cmd *cobra.Command, args []string) { Run: func(cmd *cobra.Command, args []string) {
internal.GetConfig()
err := lock.Lock() err := lock.Lock()
CheckErr(err) CheckErr(err)
defer lock.Unlock() defer lock.Unlock()
CheckErr(internal.CheckConfig())
selected, err := internal.GetAllOrSelected(cmd, false) selected, err := internal.GetAllOrSelected(cmd, false)
CheckErr(err) CheckErr(err)
prune, _ := cmd.Flags().GetBool("prune") prune, _ := cmd.Flags().GetBool("prune")
@@ -31,6 +30,6 @@ var forgetCmd = &cobra.Command{
func init() { func init() {
rootCmd.AddCommand(forgetCmd) rootCmd.AddCommand(forgetCmd)
internal.AddFlagsToCommand(forgetCmd, false) internal.AddFlagsToCommand(forgetCmd, false)
forgetCmd.Flags().Bool("prune", false, "Also prune repository") forgetCmd.Flags().Bool("prune", false, "also prune repository")
forgetCmd.Flags().Bool("dry-run", false, "Do not write changes, show what would be affected") forgetCmd.Flags().Bool("dry-run", false, "do not write changes, show what would be affected")
} }

View File

@@ -37,6 +37,7 @@ func init() {
rootCmd.PersistentFlags().StringVarP(&cfgFile, "config", "c", "", "config file (default is $HOME/.autorestic.yml or ./.autorestic.yml)") rootCmd.PersistentFlags().StringVarP(&cfgFile, "config", "c", "", "config file (default is $HOME/.autorestic.yml or ./.autorestic.yml)")
rootCmd.PersistentFlags().BoolVar(&internal.CI, "ci", false, "CI mode disabled interactive mode and colors and enables verbosity") rootCmd.PersistentFlags().BoolVar(&internal.CI, "ci", false, "CI mode disabled interactive mode and colors and enables verbosity")
rootCmd.PersistentFlags().BoolVarP(&internal.VERBOSE, "verbose", "v", false, "verbose mode") rootCmd.PersistentFlags().BoolVarP(&internal.VERBOSE, "verbose", "v", false, "verbose mode")
rootCmd.PersistentFlags().StringVar(&internal.RESTIC_BIN, "restic-bin", "restic", "specify custom restic binary")
cobra.OnInitialize(initConfig) cobra.OnInitialize(initConfig)
} }
@@ -57,5 +58,4 @@ func initConfig() {
viper.SetConfigName(".autorestic") viper.SetConfigName(".autorestic")
} }
viper.AutomaticEnv() viper.AutomaticEnv()
internal.GetConfig()
} }

View File

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

View File

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

View File

@@ -1,5 +1,6 @@
[Home](/) [Home](/)
[Quick Start](/quick) [Quick Start](/quick)
[Installation](/installation)
[Configuration](/config) [Configuration](/config)
[Upgrade](/upgrade) [Upgrade](/upgrade)
@@ -7,8 +8,13 @@
> >
> [Overview](/location/overview) > [Overview](/location/overview)
> [Hooks](/location/hooks) > [Hooks](/location/hooks)
> [Excluding Files](/location/exclude) >
> [Forget Policy](/location/forget) > > :Collapse label=Options
> >
> > [Overview](/location/options)
> > [Excluding Files](/location/exclude)
> > [Forget Policy](/location/forget)
>
> [Cron](/location/cron) > [Cron](/location/cron)
> [Docker Volumes](/location/docker) > [Docker Volumes](/location/docker)
@@ -16,12 +22,14 @@
> >
> [Overview](/backend/overview) > [Overview](/backend/overview)
> [Available Backends](/backend/available) > [Available Backends](/backend/available)
> [Options](/backend/options)
> :Collapse label=CLI > :Collapse label=CLI
> >
> [General](/cli/general) > [General](/cli/general)
> [Info](/cli/info) > [Info](/cli/info)
> [Check](/cli/check) > [Check](/cli/check)
> [Completion](/cli/completion)
> [Backup](/cli/backup) > [Backup](/cli/backup)
> [Restore](/cli/restore) > [Restore](/cli/restore)
> [Forget](/cli/forget) > [Forget](/cli/forget)
@@ -29,10 +37,10 @@
> [Exec](/cli/exec) > [Exec](/cli/exec)
> [Install](/cli/install) > [Install](/cli/install)
> [Uninstall](/cli/uninstall) > [Uninstall](/cli/uninstall)
> [Update](/cli/update) > [Upgrade](/cli/upgrade)
[Examples](/examples) [Examples](/examples)
[QA](/qa) [QA](/qa)
[Community](/community)
[Contributors](/contrib) [Contributors](/contrib)

View File

@@ -19,16 +19,17 @@ backends:
backends: backends:
name-of-backend: name-of-backend:
type: b2 type: b2
path: 'myAccount:myBucket/my/path' path: 'backblaze_bucketID'
# Or With a path
# path: 'backblaze_bucketID:/some/path'
env: env:
B2_ACCOUNT_ID: backblaze_account_id B2_ACCOUNT_ID: 'backblaze_keyID'
B2_ACCOUNT_KEY: backblaze_account_key B2_ACCOUNT_KEY: 'backblaze_applicationKey'
``` ```
#### API Keys gotcha #### API Keys gotcha
When creating API make sure you check _Allow List All Bucket Names_ if you allow access to a single bucket only. If you use a _File name prefix_ when making the application key, do not include a leading slash. Make sure to include this prefix in the path (e.g. `path: 'backblaze_bucketID:my/path'`).
Also make sure that the _File name prefix_ (if used) does not includes a leading slash.
## S3 / Minio ## S3 / Minio

View File

@@ -0,0 +1,23 @@
# Options
For the `backup` and `forget` commands you can pass any native flags to `restic`.
> It is also possible to set options for an [a specific location](/location/options).
```yaml
backend:
foo:
type: ...
path: ...
options:
backup:
tag:
- foo
- bar
```
In this example, whenever `autorestic` runs `restic backup` it will append a `--tag abc --tag` to the native command.
For more detail see the [location docs](/location/options) for options, as they are the same
> :ToCPrevNext

View File

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

View File

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

View File

@@ -4,10 +4,10 @@
autorestic exec [-b, --backend] [-a, --all] <command> -- [native options] autorestic exec [-b, --backend] [-a, --all] <command> -- [native options]
``` ```
This is avery handy command which enables you to run any native restic command on desired backends. An example would be listing all the snapshots of all your backends: This is a very handy command which enables you to run any native restic command on desired backends. Generally you will want to include the verbose flag `-v, --verbose` to see the output. An example would be listing all the snapshots of all your backends:
```bash ```bash
autorestic exec -a -- snapshots autorestic exec -av -- snapshots
``` ```
With `exec` you can basically run every cli command that you would be able to run with the restic cli. It only pre-fills path, key, etc. 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.

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

@@ -8,4 +8,18 @@ Autorestic requires `curl`, `wget` and `bzip2` to be installed. For most systems
curl -s https://raw.githubusercontent.com/CupCakeArmy/autorestic/master/install.sh | bash curl -s https://raw.githubusercontent.com/CupCakeArmy/autorestic/master/install.sh | bash
``` ```
## Alternatives
### Manual
You can download the right binary from the release page and simply copy it to `/usr/local/bin` or whatever path you prefer. Autoupdates will still work.
### Brew
If you are on macOS you can install through brew: `brew install autorestic`.
### AUR
If you are on Arch there is an [AUR Package](https://aur.archlinux.org/packages/autorestic-bin/) by @n194.
> :ToCPrevNext > :ToCPrevNext

View File

@@ -30,14 +30,14 @@ First, open your crontab in edit mode
crontab -e crontab -e
``` ```
Then paste this at the bottom of the file and save it. Note that in this specific example the `.autorestic.yml` is located in `/srv/`. You need to modify that part of course to fit your config file. Then paste this at the bottom of the file and save it. Note that in this specific example the config file is located at one of the default locations (e.g. `~/.autorestic.yml`). If your config is somewhere else you'll need to specify it using the `-c` option.
```bash ```bash
# This is required, as it otherwise cannot find restic as a command. # This is required, as it otherwise cannot find restic as a command.
PATH="/usr/local/bin:/usr/bin:/bin" PATH="/usr/local/bin:/usr/bin:/bin"
# Example running every 5 minutes # Example running every 5 minutes
*/5 * * * * autorestic -c /srv/.autorestic.yml --ci cron */5 * * * * autorestic --ci cron
``` ```
> The `--ci` option is not required, but recommended > The `--ci` option is not required, but recommended

View File

@@ -2,7 +2,14 @@
If you want to perform some commands before and/or after a backup, you can use hooks. If you want to perform some commands before and/or after a backup, you can use hooks.
They consist of a list of `before`/`after` commands that will be executed in the same directory as the target `from`. They consist of a list of commands that will be executed in the same directory as the target `from`.
The following hooks groups are supported, none are required:
- `before`
- `after`
- `failure`
- `success`
```yml | .autorestic.yml ```yml | .autorestic.yml
locations: locations:
@@ -11,10 +18,25 @@ locations:
to: my-backend to: my-backend
hooks: hooks:
before: before:
- echo "Hello" - echo "One"
- echo "Human" - echo "Two"
- echo "Three"
after: after:
- echo "kthxbye" - echo "Byte"
failure:
- echo "Something went wrong"
success:
- echo "Well done!"
``` ```
## Flowchart
1. `before` hook
2. Run backup
3. `after` hook
4. - `success` hook if no errors were found
- `failure` hook if at least error was encountered
If the `before` hook encounters errors the backup and `after` hooks will be skipped and only the `failed` hooks will run.
> :ToCPrevNext > :ToCPrevNext

View File

@@ -0,0 +1,21 @@
# Options
For the `backup` and `forget` commands you can pass any native flags to `restic`.
> It is also possible to set options for an [entire backend](/backend/options).
```yaml
locations:
foo:
path: ...
to: ...
options:
backup:
tag:
- foo
- bar
```
In this example, whenever `autorestic` runs `restic backup` it will append a `--tag abc --tag` to the native command.
> :ToCPrevNext

View File

@@ -6,10 +6,12 @@
curl -s https://raw.githubusercontent.com/CupCakeArmy/autorestic/master/install.sh | bash curl -s https://raw.githubusercontent.com/CupCakeArmy/autorestic/master/install.sh | bash
``` ```
See [installation](/installation) for alternative options.
## Write a simple config file ## Write a simple config file
```bash ```bash
vim .autorestic.yml vim ~/.autorestic.yml
``` ```
For a quick overview: For a quick overview:
@@ -35,7 +37,7 @@ locations:
- hdd - hdd
backends: backends:
- name: remote remote:
type: s3 type: s3
path: 's3.amazonaws.com/bucket_name' path: 's3.amazonaws.com/bucket_name'
key: some-random-password-198rc79r8y1029c8yfewj8f1u0ef87yh198uoieufy key: some-random-password-198rc79r8y1029c8yfewj8f1u0ef87yh198uoieufy
@@ -43,7 +45,7 @@ backends:
AWS_ACCESS_KEY_ID: account_id AWS_ACCESS_KEY_ID: account_id
AWS_SECRET_ACCESS_KEY: account_key AWS_SECRET_ACCESS_KEY: account_key
- name: hdd hdd:
type: local type: local
path: /mnt/my_external_storage path: /mnt/my_external_storage
key: 'if not key is set it will be generated for you' key: 'if not key is set it will be generated for you'

View File

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

854
docs/package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@@ -23,6 +23,8 @@ elif [[ $NATIVE_ARCH == *"arm64"* || $NATIVE_ARCH == *"aarch64"* ]]; then
ARCH=arm64 ARCH=arm64
elif [[ $NATIVE_ARCH == *"x86"* ]]; then elif [[ $NATIVE_ARCH == *"x86"* ]]; then
ARCH=386 ARCH=386
elif [[ $NATIVE_ARCH == *"armv7"* ]]; then
ARCH=arm
else else
echo "Could not determine Architecure automatically, please check the release page manually: https://github.com/cupcakearmy/autorestic/releases" echo "Could not determine Architecure automatically, please check the release page manually: https://github.com/cupcakearmy/autorestic/releases"
exit 1 exit 1

View File

@@ -17,12 +17,13 @@ type BackendRest struct {
} }
type Backend struct { type Backend struct {
name string name string
Type string `yaml:"type,omitempty"` Type string `yaml:"type,omitempty"`
Path string `yaml:"path,omitempty"` Path string `yaml:"path,omitempty"`
Key string `yaml:"key,omitempty"` Key string `yaml:"key,omitempty"`
Env map[string]string `yaml:"env,omitempty"` Env map[string]string `yaml:"env,omitempty"`
Rest BackendRest `yaml:"rest,omitempty"` Rest BackendRest `yaml:"rest,omitempty"`
Options Options `yaml:"options,omitempty"`
} }
func GetBackend(name string) (Backend, bool) { func GetBackend(name string) (Backend, bool) {

View File

@@ -2,22 +2,27 @@ package internal
import ( import (
"fmt" "fmt"
"os"
"path" "path"
"path/filepath"
"strings" "strings"
"sync" "sync"
"github.com/cupcakearmy/autorestic/internal/colors" "github.com/cupcakearmy/autorestic/internal/colors"
"github.com/cupcakearmy/autorestic/internal/lock"
"github.com/mitchellh/go-homedir" "github.com/mitchellh/go-homedir"
"github.com/spf13/cobra" "github.com/spf13/cobra"
"github.com/spf13/viper" "github.com/spf13/viper"
) )
const VERSION = "1.0.7" const VERSION = "1.2.0"
var CI bool = false var CI bool = false
var VERBOSE bool = false var VERBOSE bool = false
var CRON_LEAN bool = false
type Config struct { type Config struct {
Extras interface{} `yaml:"extras"`
Locations map[string]Location `yaml:"locations"` Locations map[string]Location `yaml:"locations"`
Backends map[string]Backend `yaml:"backends"` Backends map[string]Backend `yaml:"backends"`
} }
@@ -29,14 +34,19 @@ func GetConfig() *Config {
if config == nil { if config == nil {
once.Do(func() { once.Do(func() {
if err := viper.ReadInConfig(); err == nil { if err := viper.ReadInConfig(); err == nil {
colors.Faint.Println("Using config file:", viper.ConfigFileUsed()) if !CRON_LEAN {
absConfig, _ := filepath.Abs(viper.ConfigFileUsed())
colors.Faint.Println("Using config file:", absConfig)
}
} else { } else {
return return
} }
config = &Config{} config = &Config{}
if err := viper.UnmarshalExact(config); err != nil { if err := viper.UnmarshalExact(config); err != nil {
panic(err) colors.Error.Println("Could not parse config file!")
lock.Unlock()
os.Exit(1)
} }
}) })
} }
@@ -72,21 +82,22 @@ func (c *Config) Describe() {
colors.PrintDescription("Cron", l.Cron) colors.PrintDescription("Cron", l.Cron)
} }
after, before := len(l.Hooks.After), len(l.Hooks.Before) tmp = ""
if after+before > 0 { hooks := map[string][]string{
tmp = "" "Before": l.Hooks.Before,
if before > 0 { "After": l.Hooks.After,
tmp += "\tBefore" "Failure": l.Hooks.Failure,
for _, cmd := range l.Hooks.Before { "Success": l.Hooks.Success,
tmp += colors.Faint.Sprintf("\n\t ▶ %s", cmd) }
} for hook, commands := range hooks {
} if len(commands) > 0 {
if after > 0 { tmp += "\n\t" + hook
tmp += "\n\tAfter" for _, cmd := range commands {
for _, cmd := range l.Hooks.After {
tmp += colors.Faint.Sprintf("\n\t ▶ %s", cmd) tmp += colors.Faint.Sprintf("\n\t ▶ %s", cmd)
} }
} }
}
if tmp != "" {
colors.PrintDescription("Hooks", tmp) colors.PrintDescription("Hooks", tmp)
} }
@@ -126,7 +137,7 @@ func CheckConfig() error {
return fmt.Errorf("config could not be loaded/found") return fmt.Errorf("config could not be loaded/found")
} }
if !CheckIfResticIsCallable() { if !CheckIfResticIsCallable() {
return fmt.Errorf(`restic was not found. Install either with "autorestic install" or manually`) return fmt.Errorf(`%s was not found. Install either with "autorestic install" or manually`, RESTIC_BIN)
} }
for name, backend := range c.Backends { for name, backend := range c.Backends {
backend.name = name backend.name = name
@@ -136,7 +147,7 @@ func CheckConfig() error {
} }
for name, location := range c.Locations { for name, location := range c.Locations {
location.name = name location.name = name
if err := location.validate(c); err != nil { if err := location.validate(); err != nil {
return err return err
} }
} }
@@ -190,11 +201,17 @@ func GetAllOrSelected(cmd *cobra.Command, backends bool) ([]string, error) {
} }
func AddFlagsToCommand(cmd *cobra.Command, backend bool) { func AddFlagsToCommand(cmd *cobra.Command, backend bool) {
cmd.PersistentFlags().BoolP("all", "a", false, "Backup all locations") var usage string
if backend { if backend {
cmd.PersistentFlags().StringSliceP("backend", "b", []string{}, "backends") usage = "all backends"
} else { } else {
cmd.PersistentFlags().StringSliceP("location", "l", []string{}, "Locations") usage = "all locations"
}
cmd.PersistentFlags().BoolP("all", "a", false, usage)
if backend {
cmd.PersistentFlags().StringSliceP("backend", "b", []string{}, "select backends")
} else {
cmd.PersistentFlags().StringSliceP("location", "l", []string{}, "select locations")
} }
} }
@@ -210,3 +227,13 @@ func (c *Config) SaveConfig() error {
return viper.WriteConfig() return viper.WriteConfig()
} }
func getOptions(options Options, key string) []string {
var selected []string
for k, values := range options[key] {
for _, value := range values {
selected = append(selected, fmt.Sprintf("--%s", k), value)
}
}
return selected
}

View File

@@ -24,8 +24,10 @@ const (
type HookArray = []string type HookArray = []string
type Hooks struct { type Hooks struct {
Before HookArray `yaml:"before"` Before HookArray `yaml:"before,omitempty"`
After HookArray `yaml:"after"` After HookArray `yaml:"after,omitempty"`
Success HookArray `yaml:"success,omitempty"`
Failure HookArray `yaml:"failure,omitempty"`
} }
type Options map[string]map[string][]string type Options map[string]map[string][]string
@@ -45,18 +47,20 @@ func GetLocation(name string) (Location, bool) {
return l, ok return l, ok
} }
func (l Location) validate(c *Config) error { func (l Location) validate() error {
if l.From == "" { if l.From == "" {
return fmt.Errorf(`Location "%s" is missing "from" key`, l.name) return fmt.Errorf(`Location "%s" is missing "from" key`, l.name)
} }
if from, err := GetPathRelativeToConfig(l.From); err != nil { if l.getType() == TypeLocal {
return err if from, err := GetPathRelativeToConfig(l.From); err != nil {
} else {
if stat, err := os.Stat(from); err != nil {
return err return err
} else { } else {
if !stat.IsDir() { if stat, err := os.Stat(from); err != nil {
return fmt.Errorf("\"%s\" is not valid directory for location \"%s\"", from, l.name) return err
} else {
if !stat.IsDir() {
return fmt.Errorf("\"%s\" is not valid directory for location \"%s\"", from, l.name)
}
} }
} }
} }
@@ -74,17 +78,6 @@ func (l Location) validate(c *Config) error {
return nil return nil
} }
func (l Location) getOptions(key string) []string {
var options []string
saved := l.Options[key]
for k, values := range saved {
for _, value := range values {
options = append(options, fmt.Sprintf("--%s", k), value)
}
}
return options
}
func ExecuteHooks(commands []string, options ExecuteOptions) error { func ExecuteHooks(commands []string, options ExecuteOptions) error {
if len(commands) == 0 { if len(commands) == 0 {
return nil return nil
@@ -131,21 +124,30 @@ func (l Location) getPath() (string, error) {
return "", fmt.Errorf("could not get path for location \"%s\"", l.name) return "", fmt.Errorf("could not get path for location \"%s\"", l.name)
} }
func (l Location) Backup(cron bool) error { func (l Location) Backup(cron bool) []error {
var errors []error
colors.PrimaryPrint(" Backing up location \"%s\" ", l.name) colors.PrimaryPrint(" Backing up location \"%s\" ", l.name)
t := l.getType() t := l.getType()
options := ExecuteOptions{ options := ExecuteOptions{
Command: "bash", Command: "bash",
} }
if err := l.validate(); err != nil {
errors = append(errors, err)
colors.Error.Print(err)
goto after
}
if t == TypeLocal { if t == TypeLocal {
dir, _ := GetPathRelativeToConfig(l.From) dir, _ := GetPathRelativeToConfig(l.From)
colors.Faint.Printf("Executing under: \"%s\"\n", dir)
options.Dir = dir options.Dir = dir
} }
// Hooks // Hooks
if err := ExecuteHooks(l.Hooks.Before, options); err != nil { if err := ExecuteHooks(l.Hooks.Before, options); err != nil {
return err errors = append(errors, err)
goto after
} }
// Backup // Backup
@@ -154,12 +156,15 @@ func (l Location) Backup(cron bool) error {
colors.Secondary.Printf("Backend: %s\n", backend.name) colors.Secondary.Printf("Backend: %s\n", backend.name)
env, err := backend.getEnv() env, err := backend.getEnv()
if err != nil { if err != nil {
return nil errors = append(errors, err)
continue
} }
flags := l.getOptions("backup") lFlags := getOptions(l.Options, "backup")
bFlags := getOptions(backend.Options, "backup")
cmd := []string{"backup"} cmd := []string{"backup"}
cmd = append(cmd, flags...) cmd = append(cmd, lFlags...)
cmd = append(cmd, bFlags...)
if cron { if cron {
cmd = append(cmd, "--tag", "cron") cmd = append(cmd, "--tag", "cron")
} }
@@ -179,7 +184,8 @@ func (l Location) Backup(cron bool) error {
} }
if err != nil { if err != nil {
colors.Error.Println(out) colors.Error.Println(out)
return err errors = append(errors, err)
continue
} }
if VERBOSE { if VERBOSE {
colors.Faint.Println(out) colors.Faint.Println(out)
@@ -188,10 +194,22 @@ func (l Location) Backup(cron bool) error {
// After hooks // After hooks
if err := ExecuteHooks(l.Hooks.After, options); err != nil { if err := ExecuteHooks(l.Hooks.After, options); err != nil {
return err errors = append(errors, err)
} }
after:
var commands []string
if len(errors) > 0 {
commands = l.Hooks.Failure
} else {
commands = l.Hooks.Success
}
if err := ExecuteHooks(commands, options); err != nil {
errors = append(errors, err)
}
colors.Success.Println("Done") colors.Success.Println("Done")
return nil return errors
} }
func (l Location) Forget(prune bool, dry bool) error { func (l Location) Forget(prune bool, dry bool) error {
@@ -212,7 +230,8 @@ func (l Location) Forget(prune bool, dry bool) error {
options := ExecuteOptions{ options := ExecuteOptions{
Envs: env, Envs: env,
} }
flags := l.getOptions("forget") lFlags := getOptions(l.Options, "forget")
bFlags := getOptions(backend.Options, "forget")
cmd := []string{"forget", "--path", path} cmd := []string{"forget", "--path", path}
if prune { if prune {
cmd = append(cmd, "--prune") cmd = append(cmd, "--prune")
@@ -220,7 +239,8 @@ func (l Location) Forget(prune bool, dry bool) error {
if dry { if dry {
cmd = append(cmd, "--dry-run") cmd = append(cmd, "--dry-run")
} }
cmd = append(cmd, flags...) cmd = append(cmd, lFlags...)
cmd = append(cmd, bFlags...)
out, err := ExecuteResticCommand(options, cmd...) out, err := ExecuteResticCommand(options, cmd...)
if VERBOSE { if VERBOSE {
colors.Faint.Println(out) colors.Faint.Println(out)
@@ -309,7 +329,9 @@ func (l Location) RunCron() error {
lock.SetCron(l.name, now.Unix()) lock.SetCron(l.name, now.Unix())
l.Backup(true) l.Backup(true)
} else { } else {
colors.Body.Printf("Skipping \"%s\", not due yet.\n", l.name) if !CRON_LEAN {
colors.Body.Printf("Skipping \"%s\", not due yet.\n", l.name)
}
} }
return nil return nil
} }

View File

@@ -10,13 +10,15 @@ import (
"github.com/cupcakearmy/autorestic/internal/colors" "github.com/cupcakearmy/autorestic/internal/colors"
) )
var RESTIC_BIN string
func CheckIfCommandIsCallable(cmd string) bool { func CheckIfCommandIsCallable(cmd string) bool {
_, err := exec.LookPath(cmd) _, err := exec.LookPath(cmd)
return err == nil return err == nil
} }
func CheckIfResticIsCallable() bool { func CheckIfResticIsCallable() bool {
return CheckIfCommandIsCallable("restic") return CheckIfCommandIsCallable(RESTIC_BIN)
} }
type ExecuteOptions struct { type ExecuteOptions struct {
@@ -50,7 +52,7 @@ func ExecuteCommand(options ExecuteOptions, args ...string) (string, error) {
} }
func ExecuteResticCommand(options ExecuteOptions, args ...string) (string, error) { func ExecuteResticCommand(options ExecuteOptions, args ...string) (string, error) {
options.Command = "restic" options.Command = RESTIC_BIN
return ExecuteCommand(options, args...) return ExecuteCommand(options, args...)
} }