mirror of
https://github.com/cupcakearmy/autorestic.git
synced 2024-12-22 16:26:25 +00:00
Update README.md
This commit is contained in:
parent
a2e0a0c9cc
commit
e016c8defc
24
README.md
24
README.md
@ -11,6 +11,7 @@ Autorestic is a wrapper around the amazing [restic](https://restic.net/). While
|
|||||||
- Predictable
|
- Predictable
|
||||||
- Backup locations to multiple backends
|
- Backup locations to multiple backends
|
||||||
- Simple interface
|
- Simple interface
|
||||||
|
- Fully encrypted
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
@ -24,7 +25,7 @@ curl -s https://raw.githubusercontent.com/CupCakeArmy/autorestic/master/install.
|
|||||||
|
|
||||||
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`.
|
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 ...`
|
Optionally you can specify the location of your config file by passing it as argument: `autorestic -c ../path/config.yml`
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
locations:
|
locations:
|
||||||
@ -69,3 +70,24 @@ autorestic backup -a
|
|||||||
```
|
```
|
||||||
autorestic restore -a -- --target /path/where/to/restore
|
autorestic restore -a -- --target /path/where/to/restore
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
|
## 🗂 Locations
|
||||||
|
|
||||||
|
A location simply a folder on your machine that restic will backup. The paths can be relative from the config file. A location can have multiple backends, so that the data is secured across multiple servers.
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
locations:
|
||||||
|
my-location-name:
|
||||||
|
from: path/to/backup
|
||||||
|
to:
|
||||||
|
- name-of-backend
|
||||||
|
- also-backup-to-this-backend
|
||||||
|
```
|
||||||
|
|
||||||
|
## 💽 Backends
|
||||||
|
|
||||||
|
###### Note
|
||||||
|
|
||||||
|
Note that the data is automatically encrypted on the server. The key will be generated and added to your config file. Every backend will have a separate key. You should keep a copy of the keys somewhere in case your server dies. Otherwise DATA IS LOST!
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user