Merge branch 'cupcakearmy:master' into master

docs/markdown/_toc.md

@@ -14,6 +14,7 @@
 > > [Overview](/location/options)
 > > [Excluding Files](/location/exclude)
 > > [Forget Policy](/location/forget)
+> > [Copy](/location/copy)
 >
 > [Cron](/location/cron)
 > [Docker Volumes](/location/docker)

docs/markdown/backend/overview.md

@@ -2,6 +2,8 @@
 
 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
 

docs/markdown/cli/general.md

@@ -2,7 +2,7 @@
 
 ## `-c, --config`
 
-Specify the config file to be used.
+Specify the config file to be used (must use .yml as an extension).
 If omitted `autorestic` will search for for a `.autorestic.yml` in the current directory and your home directory.
 
 ```bash

docs/markdown/contrib.md

@@ -9,6 +9,7 @@ This amazing people helped the project!
 - @david-boles - Docs.
 - @SebDanielsson - Brew.
 - @n194 - AUR Package.
+- @olofvndrhr - Healthchecks example.
 - @jin-park-dev - Typos.
 - @sumnerboy12 - Typos.
 - @FuzzyMistborn - Typos.

docs/markdown/examples.md

@@ -14,4 +14,27 @@ This can come in handy if a backup process crashed or if it was accidentally can
 autorestic exec -b my-backend -- unlock
 ```
 
+## Use hooks to integrate with [healthchecks](https://healthchecks.io/)
+
+> Thanks to @olofvndrhr for providing it ❤️
+
+```yaml
+extras:
+  healthchecks: &healthchecks
+    hooks:
+      before:
+        - 'curl -m 10 --retry 5 -X POST -H "Content-Type: text/plain" --data "Starting backup for location: ${AUTORESTIC_LOCATION}" https://<healthchecks-url>/ping/<uid>/start'
+      failure:
+        - 'curl -m 10 --retry 5 -X POST -H "Content-Type: text/plain" --data "Backup failed for location: ${AUTORESTIC_LOCATION}" https://<healthchecks-url>/ping/<uid>/fail'
+      success:
+        - 'curl -m 10 --retry 5 -X POST -H "Content-Type: text/plain" --data "Backup successful for location: ${AUTORESTIC_LOCATION}" https://<healthchecks-url>/ping/<uid>'
+
+locations:
+  something:
+    <<: *healthchecks
+    from: /somewhere
+    to:
+      - somewhere-else
+```
+
 > :ToCPrevNext

docs/markdown/location/copy.md

@@ -0,0 +1,31 @@
+# Copy
+
+Instead of specifying multiple `to` backends for a given `location` you can also use the `copy` option. Instead of recalculating the backup multiple times, you can copy the freshly copied snapshot from one backend to the other, avoiding recomputation.
+
+###### Example
+
+```yaml | .autorestic.yml
+locations:
+  my-location:
+    from: /data
+    to:
+      - a #Fast
+      - b #Fast
+      - c #Slow
+```
+
+Becomes
+
+```yaml | .autorestic.yml
+locations:
+  my-location:
+    from: /data
+    to:
+      - a
+      - b
+    copy:
+      a:
+        - c
+```
+
+Instead of backing up to each backend separately, you can choose that the snapshot created to `a` will be copied over to `c`, avoiding heavy computation on `c`.

docs/markdown/location/forget.md

@@ -37,4 +37,21 @@ global:
     keep-weekly: 52
 ```
 
+## Automatically forget after backup
+
+You can also configure `autorestic` to automatically run the forget command for you after every backup. You can do that by specifying the `forget` option.
+
+```yaml | .autorestic.yml
+version: 2
+
+locations:
+  etc:
+    from: /etc
+    to: local
+    forget: prune # Or only "yes" if you don't want to prune
+    options:
+      forget:
+        keep-last: 5
+```
+
 > :ToCPrevNext

docs/markdown/location/overview.md

@@ -3,6 +3,7 @@
 Locations can be seen as the input to the backup process. Generally this is simply a folder.
 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