From b6f7ef657774b1020badbd762610d67f23b01a18 Mon Sep 17 00:00:00 2001 From: Jin Park Date: Thu, 25 Jun 2020 01:23:31 +0100 Subject: [PATCH 1/2] Minor spell fixes in doc --- .gitignore | 1 + README.md | 2 +- docs/backend/available.html | 2 +- docs/backend/overview.html | 2 +- docs/cli/backup.html | 2 +- docs/cli/check.html | 2 +- docs/cli/cron.html | 2 +- docs/cli/exec.html | 2 +- docs/cli/forget.html | 2 +- docs/cli/info.html | 2 +- docs/cli/install.html | 2 +- docs/cli/restore.html | 2 +- docs/cli/uninstall.html | 2 +- docs/cli/update.html | 2 +- docs/config.html | 2 +- docs/contrib.html | 2 +- docs/examples.html | 2 +- docs/index.html | 4 ++-- docs/installation.html | 2 +- docs/location/cron.html | 2 +- docs/location/docker.html | 2 +- docs/location/exclude.html | 2 +- docs/location/forget.html | 2 +- docs/location/hooks.html | 2 +- docs/location/overview.html | 2 +- docs/md/_toc.md | 2 +- docs/md/index.md | 2 +- docs/md/qa.md | 2 +- docs/qa.html | 4 ++-- docs/quick.html | 2 +- 30 files changed, 32 insertions(+), 31 deletions(-) diff --git a/.gitignore b/.gitignore index 3183073..dbf4afc 100644 --- a/.gitignore +++ b/.gitignore @@ -1,5 +1,6 @@ # Editors .idea +.vscode # Node node_modules/ diff --git a/README.md b/README.md index 15f0119..eed4452 100644 --- a/README.md +++ b/README.md @@ -18,4 +18,4 @@ ### Why / What? -Autorestic is a wrapper around the amazing [restic](https://restic.net/). While being amazing the restic cli can be a bit overwhelming and difficoult to manage if you have many different location that you want to backup to multiple locations. This utility is aimed at making this easier 🙂 +Autorestic is a wrapper around the amazing [restic](https://restic.net/). While being amazing the restic cli can be a bit overwhelming and difficult to manage if you have many different location that you want to backup to multiple locations. This utility is aimed at making this easier 🙂 diff --git a/docs/backend/available.html b/docs/backend/available.html index 8efbeb5..fde19d6 100644 --- a/docs/backend/available.html +++ b/docs/backend/available.html @@ -46,7 +46,7 @@ Installation Configuration

Locationschevron_right
Backendchevron_right

Overview diff --git a/docs/backend/overview.html b/docs/backend/overview.html index 6b97c32..1fcc014 100644 --- a/docs/backend/overview.html +++ b/docs/backend/overview.html @@ -46,7 +46,7 @@ Installation Configuration

Locationschevron_right
Backendchevron_right

Overview diff --git a/docs/cli/backup.html b/docs/cli/backup.html index d9a48ca..9759b9f 100644 --- a/docs/cli/backup.html +++ b/docs/cli/backup.html @@ -46,7 +46,7 @@ Installation Configuration

Locationschevron_right
Backendchevron_right

Overview diff --git a/docs/cli/check.html b/docs/cli/check.html index 7e757df..99a079a 100644 --- a/docs/cli/check.html +++ b/docs/cli/check.html @@ -46,7 +46,7 @@ Installation Configuration

Locationschevron_right
Backendchevron_right

Overview diff --git a/docs/cli/cron.html b/docs/cli/cron.html index 75386ba..bf56eb5 100644 --- a/docs/cli/cron.html +++ b/docs/cli/cron.html @@ -46,7 +46,7 @@ Installation Configuration

Locationschevron_right
Backendchevron_right

Overview diff --git a/docs/cli/exec.html b/docs/cli/exec.html index 999872f..416db3d 100644 --- a/docs/cli/exec.html +++ b/docs/cli/exec.html @@ -46,7 +46,7 @@ Installation Configuration

Locationschevron_right
Backendchevron_right

Overview diff --git a/docs/cli/forget.html b/docs/cli/forget.html index 23e48d5..9357431 100644 --- a/docs/cli/forget.html +++ b/docs/cli/forget.html @@ -46,7 +46,7 @@ Installation Configuration

Locationschevron_right
Backendchevron_right

Overview diff --git a/docs/cli/info.html b/docs/cli/info.html index 9023764..2ed15bf 100644 --- a/docs/cli/info.html +++ b/docs/cli/info.html @@ -47,7 +47,7 @@ Usefull when you want to quickly see what locations are being backuped where.

Installation Configuration

Locationschevron_right
Backendchevron_right

Overview diff --git a/docs/cli/install.html b/docs/cli/install.html index f127f21..cd4c0bf 100644 --- a/docs/cli/install.html +++ b/docs/cli/install.html @@ -46,7 +46,7 @@ Installation Configuration

Locationschevron_right
Backendchevron_right

Overview diff --git a/docs/cli/restore.html b/docs/cli/restore.html index 999d266..25a343d 100644 --- a/docs/cli/restore.html +++ b/docs/cli/restore.html @@ -46,7 +46,7 @@ Installation Configuration

Locationschevron_right
Backendchevron_right

Overview diff --git a/docs/cli/uninstall.html b/docs/cli/uninstall.html index e8206dd..d682948 100644 --- a/docs/cli/uninstall.html +++ b/docs/cli/uninstall.html @@ -46,7 +46,7 @@ Installation Configuration

Locationschevron_right
Backendchevron_right

Overview diff --git a/docs/cli/update.html b/docs/cli/update.html index 2446d6a..0088985 100644 --- a/docs/cli/update.html +++ b/docs/cli/update.html @@ -46,7 +46,7 @@ Installation Configuration

Locationschevron_right
Backendchevron_right

Overview diff --git a/docs/config.html b/docs/config.html index 2a51787..079d5d3 100644 --- a/docs/config.html +++ b/docs/config.html @@ -46,7 +46,7 @@ Installation Configuration

Locationschevron_right
Backendchevron_right

Overview diff --git a/docs/contrib.html b/docs/contrib.html index 95a30d6..19db30a 100644 --- a/docs/contrib.html +++ b/docs/contrib.html @@ -46,7 +46,7 @@ Installation Configuration

Locationschevron_right
Backendchevron_right

Overview diff --git a/docs/examples.html b/docs/examples.html index 2d885a5..95ade5f 100644 --- a/docs/examples.html +++ b/docs/examples.html @@ -46,7 +46,7 @@ Installation Configuration

Locationschevron_right
Backendchevron_right

Overview diff --git a/docs/index.html b/docs/index.html index b136098..4fd0ad1 100644 --- a/docs/index.html +++ b/docs/index.html @@ -35,7 +35,7 @@ .icon-font.outline { font-family: 'Material Icons Outlined'; } -

linkautorestic

High backup level CLI utility for restic.

Autorestic is a wrapper around the amazing restic. While being amazing the restic cli can be a bit overwhelming and difficoult to manage if you have many different location that you want to backup to multiple locations. This utility is aimed at making this easier 🙂

+

linkautorestic

High backup level CLI utility for restic.

Autorestic is a wrapper around the amazing restic. While being amazing the restic cli can be a bit overwhelming and difficult to manage if you have many different location that you want to backup to multiple locations. This utility is aimed at making this easier 🙂

link✈️ Roadmap

I would like to make the official 1.0 release in the coming months. Until then please feel free to file issues or feature requests so that the tool is as flexible as possible :)

As of version 0.18 crons are supported wich where the last feature missing for a 1.0. Will test this for a few weeks and then it's time for the first "real" release! 🎉 Also we now have waaay better docs 📒

link🌈 Features

  • YAML config files, no CLI
  • Incremental -> Minimal space is used
  • Backup locations to multiple backends
  • Snapshot policies and pruning
  • Fully encrypted
  • Pre/After hooks
  • Exclude pattern/files
  • Cron jobs for automatic backup
  • Backup & Restore docker volumes
Locationschevron_right
Backendchevron_right

Overview diff --git a/docs/installation.html b/docs/installation.html index ab878b9..67d228f 100644 --- a/docs/installation.html +++ b/docs/installation.html @@ -46,7 +46,7 @@ Installation Configuration

Locationschevron_right
Backendchevron_right

Overview diff --git a/docs/location/cron.html b/docs/location/cron.html index cb22874..f37d4e8 100644 --- a/docs/location/cron.html +++ b/docs/location/cron.html @@ -46,7 +46,7 @@ Installation Configuration

Locationschevron_right
Backendchevron_right

Overview diff --git a/docs/location/docker.html b/docs/location/docker.html index c8f6df7..462c35a 100644 --- a/docs/location/docker.html +++ b/docs/location/docker.html @@ -46,7 +46,7 @@ Installation Configuration

Locationschevron_right
Backendchevron_right

Overview diff --git a/docs/location/exclude.html b/docs/location/exclude.html index baf84c0..647c7b1 100644 --- a/docs/location/exclude.html +++ b/docs/location/exclude.html @@ -46,7 +46,7 @@ Installation Configuration

Locationschevron_right
Backendchevron_right

Overview diff --git a/docs/location/forget.html b/docs/location/forget.html index e0ef650..4b8f8f0 100644 --- a/docs/location/forget.html +++ b/docs/location/forget.html @@ -46,7 +46,7 @@ Installation Configuration

Locationschevron_right
Backendchevron_right

Overview diff --git a/docs/location/hooks.html b/docs/location/hooks.html index 32acdef..cf10f11 100644 --- a/docs/location/hooks.html +++ b/docs/location/hooks.html @@ -46,7 +46,7 @@ Installation Configuration

Locationschevron_right
Backendchevron_right

Overview diff --git a/docs/location/overview.html b/docs/location/overview.html index a7124d8..75e9b0e 100644 --- a/docs/location/overview.html +++ b/docs/location/overview.html @@ -47,7 +47,7 @@ The paths can be relative from the config file. A location can have multiple bac Installation Configuration

Locationschevron_right
Backendchevron_right

Overview diff --git a/docs/md/_toc.md b/docs/md/_toc.md index 4e33475..829d712 100644 --- a/docs/md/_toc.md +++ b/docs/md/_toc.md @@ -7,7 +7,7 @@ > > [Overview](/location/overview) > [Hooks](/location/hooks) -> [Exluding Files](/location/exclude) +> [excluding Files](/location/exclude) > [Forget Policy](/location/forget) > [Cron](/location/cron) > [Docker Volumes](/location/docker) diff --git a/docs/md/index.md b/docs/md/index.md index 1ca634b..3d7553d 100644 --- a/docs/md/index.md +++ b/docs/md/index.md @@ -2,7 +2,7 @@ High backup level CLI utility for [restic](https://restic.net/). -Autorestic is a wrapper around the amazing [restic](https://restic.net/). While being amazing the restic cli can be a bit overwhelming and difficoult to manage if you have many different location that you want to backup to multiple locations. This utility is aimed at making this easier 🙂 +Autorestic is a wrapper around the amazing [restic](https://restic.net/). While being amazing the restic cli can be a bit overwhelming and difficult to manage if you have many different location that you want to backup to multiple locations. This utility is aimed at making this easier 🙂 diff --git a/docs/md/qa.md b/docs/md/qa.md index 0bde5ab..8446b0c 100644 --- a/docs/md/qa.md +++ b/docs/md/qa.md @@ -3,6 +3,6 @@ ## My config file was moved? This happens when autorestic needs to write to the config file. This happend e.g. when we are generating a key for you. -Unforunately during this process formatting and comments are lost. That is why autorestic will place a copy of your old config next to the one we are writing to. +Unfortunately during this process formatting and comments are lost. That is why autorestic will place a copy of your old config next to the one we are writing to. > :ToCPrevNext diff --git a/docs/qa.html b/docs/qa.html index e9d256c..8726917 100644 --- a/docs/qa.html +++ b/docs/qa.html @@ -36,7 +36,7 @@ font-family: 'Material Icons Outlined'; }

link❓ QA

linkMy config file was moved?

This happens when autorestic needs to write to the config file. This happend e.g. when we are generating a key for you. -Unforunately during this process formatting and comments are lost. That is why autorestic will place a copy of your old config next to the one we are writing to.

Locationschevron_right
Backendchevron_right

Overview diff --git a/docs/quick.html b/docs/quick.html index a4d0038..ef8a765 100644 --- a/docs/quick.html +++ b/docs/quick.html @@ -46,7 +46,7 @@ Installation Configuration

Locationschevron_right
Backendchevron_right

Overview From 52cd6fe3fda0efc33deee14ec901410afa5d9ce3 Mon Sep 17 00:00:00 2001 From: Jin Park Date: Thu, 25 Jun 2020 01:40:04 +0100 Subject: [PATCH 2/2] Fix e to E --- docs/backend/available.html | 2 +- docs/backend/overview.html | 2 +- docs/cli/backup.html | 2 +- docs/cli/check.html | 2 +- docs/cli/cron.html | 2 +- docs/cli/exec.html | 2 +- docs/cli/forget.html | 2 +- docs/cli/info.html | 2 +- docs/cli/install.html | 2 +- docs/cli/restore.html | 2 +- docs/cli/uninstall.html | 2 +- docs/cli/update.html | 2 +- docs/config.html | 2 +- docs/contrib.html | 2 +- docs/examples.html | 2 +- docs/index.html | 2 +- docs/installation.html | 2 +- docs/location/cron.html | 2 +- docs/location/docker.html | 2 +- docs/location/exclude.html | 4 ++-- docs/location/forget.html | 2 +- docs/location/hooks.html | 2 +- docs/location/overview.html | 2 +- docs/md/_toc.md | 2 +- docs/qa.html | 2 +- docs/quick.html | 2 +- 26 files changed, 27 insertions(+), 27 deletions(-) diff --git a/docs/backend/available.html b/docs/backend/available.html index fde19d6..1760652 100644 --- a/docs/backend/available.html +++ b/docs/backend/available.html @@ -46,7 +46,7 @@ Installation Configuration

Locationschevron_right
Backendchevron_right

Overview diff --git a/docs/backend/overview.html b/docs/backend/overview.html index 1fcc014..244062a 100644 --- a/docs/backend/overview.html +++ b/docs/backend/overview.html @@ -46,7 +46,7 @@ Installation Configuration

Locationschevron_right
Backendchevron_right

Overview diff --git a/docs/cli/backup.html b/docs/cli/backup.html index 9759b9f..4e1c9f8 100644 --- a/docs/cli/backup.html +++ b/docs/cli/backup.html @@ -46,7 +46,7 @@ Installation Configuration

Locationschevron_right
Backendchevron_right

Overview diff --git a/docs/cli/check.html b/docs/cli/check.html index 99a079a..9fea791 100644 --- a/docs/cli/check.html +++ b/docs/cli/check.html @@ -46,7 +46,7 @@ Installation Configuration

Locationschevron_right
Backendchevron_right

Overview diff --git a/docs/cli/cron.html b/docs/cli/cron.html index bf56eb5..03727e7 100644 --- a/docs/cli/cron.html +++ b/docs/cli/cron.html @@ -46,7 +46,7 @@ Installation Configuration

Locationschevron_right
Backendchevron_right

Overview diff --git a/docs/cli/exec.html b/docs/cli/exec.html index 416db3d..2a332d9 100644 --- a/docs/cli/exec.html +++ b/docs/cli/exec.html @@ -46,7 +46,7 @@ Installation Configuration

Locationschevron_right
Backendchevron_right

Overview diff --git a/docs/cli/forget.html b/docs/cli/forget.html index 9357431..37dab7f 100644 --- a/docs/cli/forget.html +++ b/docs/cli/forget.html @@ -46,7 +46,7 @@ Installation Configuration

Locationschevron_right
Backendchevron_right

Overview diff --git a/docs/cli/info.html b/docs/cli/info.html index 2ed15bf..3a2abd8 100644 --- a/docs/cli/info.html +++ b/docs/cli/info.html @@ -47,7 +47,7 @@ Usefull when you want to quickly see what locations are being backuped where.

Installation Configuration

Locationschevron_right
Backendchevron_right

Overview diff --git a/docs/cli/install.html b/docs/cli/install.html index cd4c0bf..81f47d3 100644 --- a/docs/cli/install.html +++ b/docs/cli/install.html @@ -46,7 +46,7 @@ Installation Configuration

Locationschevron_right
Backendchevron_right

Overview diff --git a/docs/cli/restore.html b/docs/cli/restore.html index 25a343d..7991e4f 100644 --- a/docs/cli/restore.html +++ b/docs/cli/restore.html @@ -46,7 +46,7 @@ Installation Configuration

Locationschevron_right
Backendchevron_right

Overview diff --git a/docs/cli/uninstall.html b/docs/cli/uninstall.html index d682948..13aff88 100644 --- a/docs/cli/uninstall.html +++ b/docs/cli/uninstall.html @@ -46,7 +46,7 @@ Installation Configuration

Locationschevron_right
Backendchevron_right

Overview diff --git a/docs/cli/update.html b/docs/cli/update.html index 0088985..692c6c1 100644 --- a/docs/cli/update.html +++ b/docs/cli/update.html @@ -46,7 +46,7 @@ Installation Configuration

Locationschevron_right
Backendchevron_right

Overview diff --git a/docs/config.html b/docs/config.html index 079d5d3..49c0c5e 100644 --- a/docs/config.html +++ b/docs/config.html @@ -46,7 +46,7 @@ Installation Configuration

Locationschevron_right
Backendchevron_right

Overview diff --git a/docs/contrib.html b/docs/contrib.html index 19db30a..591a114 100644 --- a/docs/contrib.html +++ b/docs/contrib.html @@ -46,7 +46,7 @@ Installation Configuration

Locationschevron_right
Backendchevron_right

Overview diff --git a/docs/examples.html b/docs/examples.html index 95ade5f..4bf6f58 100644 --- a/docs/examples.html +++ b/docs/examples.html @@ -46,7 +46,7 @@ Installation Configuration

Locationschevron_right
Backendchevron_right

Overview diff --git a/docs/index.html b/docs/index.html index 4fd0ad1..26985c7 100644 --- a/docs/index.html +++ b/docs/index.html @@ -48,7 +48,7 @@ Installation Configuration

Locationschevron_right
Backendchevron_right

Overview diff --git a/docs/installation.html b/docs/installation.html index 67d228f..894f421 100644 --- a/docs/installation.html +++ b/docs/installation.html @@ -46,7 +46,7 @@ Installation Configuration

Locationschevron_right
Backendchevron_right

Overview diff --git a/docs/location/cron.html b/docs/location/cron.html index f37d4e8..c7690a2 100644 --- a/docs/location/cron.html +++ b/docs/location/cron.html @@ -46,7 +46,7 @@ Installation Configuration

Locationschevron_right
Backendchevron_right

Overview diff --git a/docs/location/docker.html b/docs/location/docker.html index 462c35a..34a7bf5 100644 --- a/docs/location/docker.html +++ b/docs/location/docker.html @@ -46,7 +46,7 @@ Installation Configuration

Locationschevron_right
Backendchevron_right

Overview diff --git a/docs/location/exclude.html b/docs/location/exclude.html index 647c7b1..59d0f58 100644 --- a/docs/location/exclude.html +++ b/docs/location/exclude.html @@ -35,7 +35,7 @@ .icon-font.outline { font-family: 'Material Icons Outlined'; } -

linkExcluding files

If you want to exclude certain files or folders it done easily by specifiyng the right flags in the location you desire to filter.

The flags are taken straight from the restic cli exclude rules so you can use any flag used there.

1locations:

2 my-location:

3 from: /data

4 to: my-backend

5 options:

6 backup:

7 exclude:

8 - '*.nope'

9 - '*.abc'

10 exclude-file: .gitignore

linkExcluding files

If you want to exclude certain files or folders it done easily by specifiyng the right flags in the location you desire to filter.

The flags are taken straight from the restic cli exclude rules so you can use any flag used there.

1locations:

2 my-location:

3 from: /data

4 to: my-backend

5 options:

6 backup:

7 exclude:

8 - '*.nope'

9 - '*.abc'

10 exclude-file: .gitignore

Locationschevron_right
Backendchevron_right

Overview diff --git a/docs/location/forget.html b/docs/location/forget.html index 4b8f8f0..4f3d2de 100644 --- a/docs/location/forget.html +++ b/docs/location/forget.html @@ -46,7 +46,7 @@ Installation Configuration

Locationschevron_right
Backendchevron_right

Overview diff --git a/docs/location/hooks.html b/docs/location/hooks.html index cf10f11..348a53b 100644 --- a/docs/location/hooks.html +++ b/docs/location/hooks.html @@ -46,7 +46,7 @@ Installation Configuration

Locationschevron_right
Backendchevron_right

Overview diff --git a/docs/location/overview.html b/docs/location/overview.html index 75e9b0e..d244f07 100644 --- a/docs/location/overview.html +++ b/docs/location/overview.html @@ -47,7 +47,7 @@ The paths can be relative from the config file. A location can have multiple bac Installation Configuration

Locationschevron_right
Backendchevron_right

Overview diff --git a/docs/md/_toc.md b/docs/md/_toc.md index 829d712..dd7912f 100644 --- a/docs/md/_toc.md +++ b/docs/md/_toc.md @@ -7,7 +7,7 @@ > > [Overview](/location/overview) > [Hooks](/location/hooks) -> [excluding Files](/location/exclude) +> [Excluding Files](/location/exclude) > [Forget Policy](/location/forget) > [Cron](/location/cron) > [Docker Volumes](/location/docker) diff --git a/docs/qa.html b/docs/qa.html index 8726917..ff73d80 100644 --- a/docs/qa.html +++ b/docs/qa.html @@ -47,7 +47,7 @@ Unfortunately during this process formatting and comments are lost. That is why Installation Configuration

Locationschevron_right
Backendchevron_right

Overview diff --git a/docs/quick.html b/docs/quick.html index ef8a765..52f2ff5 100644 --- a/docs/quick.html +++ b/docs/quick.html @@ -46,7 +46,7 @@ Installation Configuration

Locationschevron_right
Backendchevron_right