delete old docs (#327)

* delete old docs

* new docs

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

@@ -0,0 +1,53 @@
+# Cron
+
+Often it is useful to trigger backups automatically. For this, we can specify a `cron` attribute to each location.
+
+```yaml | .autorestic.yml
+locations:
+  my-location:
+    from: /data
+    to: my-backend
+    cron: '0 3 * * 0' # Every Sunday at 3:00
+```
+
+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 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 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
+
+Here is an example using crontab, but systemd would do too.
+
+First, open your crontab in edit mode
+
+```bash
+crontab -e
+```
+
+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
+# This is required, as it otherwise cannot find restic as a command.
+PATH="/usr/local/bin:/usr/bin:/bin"
+
+# Example running every 5 minutes
+*/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 intentionally not linked.

docs/pages/location/docker.md

@@ -0,0 +1,37 @@
+# Docker
+
+autorestic supports docker volumes directly, without needing them to be mounted to the host filesystem.
+
+```yaml | docker-compose.yml
+version: '3.8'
+
+volumes:
+  data:
+    name: my-data
+
+services:
+  api:
+    image: alpine
+    volumes:
+      - data:/foo/bar
+```
+
+```yaml | .autorestic.yml
+locations:
+  foo:
+    from: my-data
+    type: volume
+    # ...
+```
+
+Now you can backup and restore as always.
+
+```bash
+autorestic backup -l hello
+```
+
+```bash
+autorestic restore -l hello
+```
+
+The volume has to exists whenever backing up or restoring.

docs/pages/location/hooks.md

@@ -0,0 +1,78 @@
+# Hooks
+
+If you want to perform some commands before and/or after a backup, you can use hooks.
+
+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
+locations:
+  my-location:
+    from: /data
+    to: my-backend
+    hooks:
+      before:
+        - echo "One"
+        - echo "Two"
+        - echo "Three"
+      after:
+        - 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 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
+```

docs/pages/location/index.md

@@ -0,0 +1,33 @@
+# 🗂 Locations
+
+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
+
+locations:
+  my-location-name:
+    from: path/to/backup
+    # Or multiple
+    # from:
+    #   - /a
+    #   - /b
+    to:
+      - name-of-backend
+      - also-backup-to-this-backend
+```
+
+## `from`
+
+This is the source of the location. Can be an `array` for multiple sources.
+
+#### How are paths resolved?
+
+Paths can be absolute or relative. If relative they are resolved relative to the location of the config file. Tilde `~` paths are also supported for home folder resolution.
+
+## `to`
+
+This is either a single backend or an array of backends. The backends have to be configured in the same config file.

docs/pages/location/options/_meta.json

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

docs/pages/location/options/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/pages/location/options/exclude.md

@@ -0,0 +1,18 @@
+# Excluding files
+
+If you want to exclude certain files or folders it done easily by specifying the right flags in the location you desire to filter.
+
+The flags are taken straight from the [restic cli exclude rules](https://restic.readthedocs.io/en/latest/040_backup.html#excluding-files) so you can use any flag used there.
+
+```yaml
+locations:
+  my-location:
+    from: /data
+    to: my-backend
+    options:
+      backup:
+        exclude:
+          - '*.nope'
+          - '*.abc'
+        exclude-file: .gitignore
+```

docs/pages/location/options/forget.md

@@ -0,0 +1,55 @@
+# Forget/Prune Policies
+
+Autorestic supports declaring snapshot policies for location to avoid keeping old snapshot around if you don't need them.
+
+This is based on [Restic's snapshots policies](https://restic.readthedocs.io/en/latest/060_forget.html#removing-snapshots-according-to-a-policy), and can be enabled for each location as shown below:
+
+> **Note** This is a full example, of course you also can specify only one of them
+
+```yaml | .autorestic.yml
+version: 2
+
+locations:
+  etc:
+    from: /etc
+    to: local
+    options:
+      forget:
+        keep-last: 5 # always keep at least 5 snapshots
+        keep-hourly: 3 # keep 3 last hourly snapshots
+        keep-daily: 4 # keep 4 last daily snapshots
+        keep-weekly: 1 # keep 1 last weekly snapshots
+        keep-monthly: 12 # keep 12 last monthly snapshots
+        keep-yearly: 7 # keep 7 last yearly snapshots
+        keep-within: '14d' # keep snapshots from the last 14 days
+```
+
+## Globally
+
+You can specify global forget policies that would be applied to all locations:
+
+```yaml | .autorestic.yml
+version: 2
+
+global:
+  forget:
+    keep-daily: 30
+    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
+```

docs/pages/location/options/index.md

@@ -0,0 +1,65 @@
+# Options
+
+For the `backup` and `forget` commands you can pass any native flags to `restic`. In addition you can specify flags for every command with `all`.
+
+If flags don't start with `-` they will get prefixed with `--`.
+
+Flags without arguments can be set to `true`. They will be handled accordingly.
+
+> ℹ️ It is also possible to set options for an [entire backend](/backend/options) or globally (see below).
+
+```yaml
+locations:
+  foo:
+    # ...
+    options:
+      all:
+        some-flag: 123
+        # Equivalent to
+        --some-flag: 123
+      backup:
+        boolean-flag: true
+        tag:
+          - foo
+          - bar
+```
+
+## Example
+
+In this example, whenever `autorestic` runs `restic backup` it will append a `--tag foo --tag bar` to the native command.
+
+```yaml
+locations:
+  foo:
+    path: ...
+    to: ...
+    options:
+      backup:
+        tag:
+          - foo
+          - bar
+```
+
+## Priority
+
+Options can be set globally, on the backends or on the locations.
+
+The priority is as follows: `location > backend > global`.
+
+## Global Options
+
+It is possible to specify global flags that will be run every time restic is invoked. To do so specify them under `global` in your config file.
+
+```yaml
+global:
+  all:
+    cache-dir: ~/restic
+  backup:
+    tag:
+      - foo
+
+backends:
+  # ...
+locations:
+  # ...
+```