cupcakearmy/autorestic
1
0
Fork 0
mirror of https://github.com/cupcakearmy/autorestic.git synced 2025-09-02 00:30:40 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs

Browse Source
This commit is contained in:
cupcakearmy
2020-06-28 22:48:00 +02:00
parent 8417a6e0aa
commit ebb934d1c5
27 changed files with 137 additions and 128 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/md/location/cron.md
View File

@@ -16,7 +16,11 @@ Here is a awesome website with [some examples](https://crontab.guru/examples.htm
## Installing the cron
To actually enable cron jobs you need something to call `autorestic cron` on a timed shedule. Note that the shedule has nothing to do with the `cron` attribute in each location. My advise 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 shedule it once a day.
**This has to be done only once, regadless of now many cros you have in your config file.**
To actually enable cron jobs you need something to call `autorestic cron` on a timed shedule.
Note that the shedule has nothing to do with the `cron` attribute in each location.
My advise 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 shedule it once a day.
### Crontab

7
docs/md/quick.md
View File

@@ -16,7 +16,8 @@ For a quick overview:
- `locations` can be seen as the inputs and `backends` the output where the data is stored and backed up.
- One `location` can have one or multiple `backends` for redudancy.
- One `backend` can also be the target for multiple `locations`
- One `backend` can also be the target for multiple `locations`.
- **Backup the config file as it will contain the generated keys**. If you don't have a copy of that keys, the backups are useless as they are encrypted and data will be not recoverable.
```yaml | .autorestic.yml
locations:
@@ -42,7 +43,7 @@ backends:
path: /mnt/my_external_storage
```
## Check [Optional]
## Check
```bash
autorestic check -a
@@ -50,6 +51,8 @@ autorestic check -a
This checks if the config file has any issues. If this is the first time this can take longer as autorestic will setup the backends.
Now is good time to **backup the config**. After you run autorestic at least once we will add the generated encryption keys to the config.
## Backup
```bash