mirror of
https://github.com/cupcakearmy/autorestic.git
synced 2024-07-05 12:54:44 +02:00
72 lines
1.7 KiB
Markdown
72 lines
1.7 KiB
Markdown
# autorestic
|
|
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 habe many different location that you want to backup to multiple locations. This utility is aimed at making this easier 🙂
|
|
|
|
|
|
|
|
## 🌈 Features
|
|
|
|
- Config files, no CLI
|
|
- Predictable
|
|
- Backup locations to multiple backends
|
|
- Simple interface
|
|
|
|
## Installation
|
|
|
|
```
|
|
curl -s https://raw.githubusercontent.com/CupCakeArmy/autorestic/master/install.sh | sh
|
|
```
|
|
|
|
## 🚀 Quickstart
|
|
|
|
### Setup
|
|
|
|
First we need to configure our locations and backends. Simply create a `.autorestic.yml` either in your home directory of in the folder from which you will execute `autorestic`.
|
|
|
|
Optionally you can specify the location of your config file by passing it as argument: `autorestic -c ../path/config.yml ...`
|
|
|
|
```yaml
|
|
locations:
|
|
home:
|
|
from: /home/me
|
|
to: remote
|
|
|
|
important:
|
|
from: /path/to/important/stuff
|
|
to:
|
|
- remote
|
|
- hdd
|
|
|
|
backends:
|
|
remote:
|
|
type: b2
|
|
path: 'myBucket:backup/home'
|
|
B2_ACCOUNT_ID: account_id
|
|
B2_ACCOUNT_KEY: account_key
|
|
|
|
hdd:
|
|
type: local
|
|
path: /mnt/my_external_storage
|
|
```
|
|
|
|
Then we check if everything is correct by running the `check` command. We will pass the `-a` (or `--all`) to tell autorestic to check all the locations.
|
|
|
|
```
|
|
autorestic check -a
|
|
```
|
|
|
|
If we would check only one location we could run the following: `autorestic -l home check`.
|
|
|
|
### Backup
|
|
|
|
```
|
|
autorestic backup -a
|
|
```
|
|
|
|
### Restore
|
|
|
|
```
|
|
autorestic restore -a -- --target /path/where/to/restore
|
|
```
|