Merge pull request #114 from cupcakearmy/1.3.0

1.3.0

docs/markdown/_toc.md

@@ -23,6 +23,7 @@
 > [Overview](/backend/overview)
 > [Available Backends](/backend/available)
 > [Options](/backend/options)
+> [Environment](/backend/env)
 
 > :Collapse label=CLI
 >

docs/markdown/backend/env.md

@@ -0,0 +1,36 @@
+# Environment
+
+> ⚠ Available since version `v1.3.0`
+
+Sometimes it's favorable not having the encryption keys in the config files.
+For that `autorestic` allows passing the backend keys as `ENV` variables, or through an env file.
+
+The syntax for the `ENV` variables is as follows: `AUTORESTIC_[BACKEND NAME]_KEY`.
+
+```yaml | autorestic.yaml
+backend:
+  foo:
+    type: ...
+    path: ...
+    key: secret123 # => AUTORESTIC_FOO_KEY=secret123
+```
+
+## Example
+
+This means we could remove `key: secret123` from `.autorestic.yaml` and execute as follows:
+
+```bash
+AUTORESTIC_FOO_KEY=secret123 autorestic backup ...
+```
+
+## Env file
+
+Alternatively `autorestic` can load an env file, located next to `autorestic.yml` called `.autorestic.env`.
+
+```| .autorestic.env
+AUTORESTIC_FOO_KEY=secret123
+```
+
+after that you can simply use `autorestic` as your are used to.
+
+> :ToCPrevNext

docs/markdown/backend/options.md

@@ -18,6 +18,8 @@ backend:
 
 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
+For more detail see the [location docs](/location/options) for options, as they are the same.
+
+> For flags without arguments you can set them to `true`. They will be handled accordingly.
 
 > :ToCPrevNext

docs/markdown/location/cron.md

@@ -37,11 +37,17 @@ Then paste this at the bottom of the file and save it. Note that in this specifi
 PATH="/usr/local/bin:/usr/bin:/bin"
 
 # Example running every 5 minutes
-*/5 * * * * autorestic --ci cron
+*/5 * * * * autorestic -c /path/to/my/.autorestic.yml --ci cron
 ```
 
 > The `--ci` option is not required, but recommended
 
+To debug a cron job you can use
+
+```bash
+*/5 * * * * autorestic -c /path/to/my/.autorestic.yml --ci cron > /tmp/autorestic.log 2>&1
+```
+
 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.

docs/markdown/location/hooks.md

@@ -35,8 +35,46 @@ locations:
 2. Run backup
 3. `after` hook
 4. - `success` hook if no errors were found
-   - `failure` hook if at least error was encountered
+   - `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.
 
+## Environment variables
+
+All hooks are exposed to the `AUTORESTIC_LOCATION` environment variable, which contains the location name.
+
+The `after` and `success` hooks have access to additional information with the following syntax:
+
+```bash
+AUTORESTIC_[TYPE]_[I]
+AUTORESTIC_[TYPE]_[BACKEND_NAME]
+```
+
+Every type of metadata is appended with both the name of the backend associated with and the number in which the backends where executed.
+
+### Available Metadata Types
+
+- `SNAPSHOT_ID`
+- `PARENT_SNAPSHOT_ID`
+- `FILES_ADDED`
+- `FILES_CHANGED`
+- `FILES_UNMODIFIED`
+- `DIRS_ADDED`
+- `DIRS_CHANGED`
+- `DIRS_UNMODIFIED`
+- `ADDED_SIZE`
+- `PROCESSED_FILES`
+- `PROCESSED_SIZE`
+- `PROCESSED_DURATION`
+
+#### Example
+
+Assuming you have a location `bar` that backs up to a single backend named `foo` you could expect the following env variables:
+
+```bash
+AUTORESTIC_LOCATION=bar
+AUTORESTIC_FILES_ADDED_0=42
+AUTORESTIC_FILES_ADDED_FOO=42
+```
+
 > :ToCPrevNext

docs/markdown/location/options.md

@@ -18,4 +18,6 @@ locations:
 
 In this example, whenever `autorestic` runs `restic backup` it will append a `--tag abc --tag` to the native command.
 
+> For flags without arguments you can set them to `true`. They will be handled accordingly.
+
 > :ToCPrevNext