mirror of
https://github.com/cupcakearmy/autorestic.git
synced 2024-12-22 08:16:25 +00:00
Update README.md
This commit is contained in:
parent
bcabd467c9
commit
fa89d2941f
60
README.md
60
README.md
@ -13,6 +13,7 @@ Autorestic is a wrapper around the amazing [restic](https://restic.net/). While
|
|||||||
- Snapshot policies and pruning
|
- Snapshot policies and pruning
|
||||||
- Simple interface
|
- Simple interface
|
||||||
- Fully encrypted
|
- Fully encrypted
|
||||||
|
- Backup & Restore docker volumes
|
||||||
|
|
||||||
### 📒 Docs
|
### 📒 Docs
|
||||||
|
|
||||||
@ -20,6 +21,7 @@ Autorestic is a wrapper around the amazing [restic](https://restic.net/). While
|
|||||||
* [Pruning & Deleting old files](#pruning-and-snapshot-policies)
|
* [Pruning & Deleting old files](#pruning-and-snapshot-policies)
|
||||||
* [Excluding files](#excluding-filesfolders)
|
* [Excluding files](#excluding-filesfolders)
|
||||||
* [Hooks](#before--after-hooks)
|
* [Hooks](#before--after-hooks)
|
||||||
|
* [Docker volumes](#-Docker-volumes)
|
||||||
* [Backends](#-backends)
|
* [Backends](#-backends)
|
||||||
* [Commands](#-commands)
|
* [Commands](#-commands)
|
||||||
* [Examples](#-examples)
|
* [Examples](#-examples)
|
||||||
@ -190,6 +192,64 @@ locations:
|
|||||||
- echo "kthxbye"
|
- echo "kthxbye"
|
||||||
```
|
```
|
||||||
|
|
||||||
|
#### 🐳 Docker volumes
|
||||||
|
|
||||||
|
Since version 0.13 autorestic supports docker volumes directly, without needing them to be mounted to the host filesystem.
|
||||||
|
|
||||||
|
Let see an example.
|
||||||
|
|
||||||
|
###### docker-compose.yml
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
version: '3.7'
|
||||||
|
|
||||||
|
volumes:
|
||||||
|
data:
|
||||||
|
name: my-data
|
||||||
|
|
||||||
|
services:
|
||||||
|
api:
|
||||||
|
image: alpine
|
||||||
|
volumes:
|
||||||
|
- data:/foo/bar
|
||||||
|
```
|
||||||
|
|
||||||
|
###### .autorestic.yml
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
locations:
|
||||||
|
hello:
|
||||||
|
from: 'volume:my-data'
|
||||||
|
to:
|
||||||
|
- remote
|
||||||
|
options:
|
||||||
|
forget:
|
||||||
|
keep-last: 2
|
||||||
|
|
||||||
|
backends:
|
||||||
|
remote:
|
||||||
|
...
|
||||||
|
```
|
||||||
|
|
||||||
|
Now you can backup and restore as always.
|
||||||
|
|
||||||
|
```sh
|
||||||
|
autorestic -l hello backup
|
||||||
|
```
|
||||||
|
|
||||||
|
```sh
|
||||||
|
autorestic -l hello restore
|
||||||
|
```
|
||||||
|
|
||||||
|
If the volume does not exist on restore, autorestic will create it for you and then fill it with the data.
|
||||||
|
|
||||||
|
### Limitations
|
||||||
|
|
||||||
|
Unfortunately there are some limitations when backing up directly from a docker volume without mounting the volume to the host. If you are curious or have ideas how to improve this, please [read more here](https://github.com/cupcakearmy/autorestic/issues/4#issuecomment-568771951). Any help is welcomed 🙂
|
||||||
|
|
||||||
|
1. Incremental updates are not possible right now due to how the current docker mounting works.
|
||||||
|
2. Exclude patterns and files also do not work as restic only sees a compressed tarball as source and not the actual data.
|
||||||
|
|
||||||
## 💽 Backends
|
## 💽 Backends
|
||||||
|
|
||||||
Backends are the place where you data will be saved. Backups are incremental and encrypted.
|
Backends are the place where you data will be saved. Backups are incremental and encrypted.
|
||||||
|
Loading…
Reference in New Issue
Block a user