mirror of
https://github.com/cupcakearmy/autorestic.git
synced 2024-12-22 08:16:25 +00:00
docs
This commit is contained in:
parent
e055e28cfe
commit
3029259d82
@ -3,6 +3,8 @@
|
|||||||
Backends are the outputs of the backup process. Each location needs at least one.
|
Backends are the outputs of the backup process. Each location needs at least one.
|
||||||
|
|
||||||
```yaml | .autorestic.yml
|
```yaml | .autorestic.yml
|
||||||
|
version: 2
|
||||||
|
|
||||||
backends:
|
backends:
|
||||||
name-of-backend:
|
name-of-backend:
|
||||||
type: local
|
type: local
|
||||||
|
@ -16,6 +16,8 @@ You can also specify a custom file with the `-c path/to/some/config.yml`
|
|||||||
## Example configuration
|
## Example configuration
|
||||||
|
|
||||||
```yaml | .autorestic.yml
|
```yaml | .autorestic.yml
|
||||||
|
version: 2
|
||||||
|
|
||||||
locations:
|
locations:
|
||||||
home:
|
home:
|
||||||
from: /home/me
|
from: /home/me
|
||||||
@ -49,6 +51,8 @@ Aliases allow to reuse snippets of config throughout the same file.
|
|||||||
The following example shows how the locations `a` and `b` share the same hooks and forget policies.
|
The following example shows how the locations `a` and `b` share the same hooks and forget policies.
|
||||||
|
|
||||||
```yaml | .autorestic.yml
|
```yaml | .autorestic.yml
|
||||||
|
version: 2
|
||||||
|
|
||||||
extras:
|
extras:
|
||||||
hooks: &foo
|
hooks: &foo
|
||||||
before:
|
before:
|
||||||
|
@ -7,6 +7,8 @@ This is based on [Restic's snapshots policies](https://restic.readthedocs.io/en/
|
|||||||
> **Note** This is a full example, of course you also can specify only one of them
|
> **Note** This is a full example, of course you also can specify only one of them
|
||||||
|
|
||||||
```yaml | .autorestic.yml
|
```yaml | .autorestic.yml
|
||||||
|
version: 2
|
||||||
|
|
||||||
locations:
|
locations:
|
||||||
etc:
|
etc:
|
||||||
from: /etc
|
from: /etc
|
||||||
@ -22,4 +24,17 @@ locations:
|
|||||||
keep-within: '2w' # keep snapshots from the last 2 weeks
|
keep-within: '2w' # keep snapshots from the last 2 weeks
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Globally
|
||||||
|
|
||||||
|
You can specify global forget policies that would be applied to all locations:
|
||||||
|
|
||||||
|
```yaml | .autorestic.yml
|
||||||
|
version: 2
|
||||||
|
|
||||||
|
global:
|
||||||
|
forget:
|
||||||
|
keep-daily: 30
|
||||||
|
keep-weekly: 52
|
||||||
|
```
|
||||||
|
|
||||||
> :ToCPrevNext
|
> :ToCPrevNext
|
||||||
|
@ -4,9 +4,15 @@ Locations can be seen as the input to the backup process. Generally this is simp
|
|||||||
The paths can be relative from the config file. A location can have multiple backends, so that the data is secured across multiple servers.
|
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 | .autorestic.yml
|
```yaml | .autorestic.yml
|
||||||
|
version: 2
|
||||||
|
|
||||||
locations:
|
locations:
|
||||||
my-location-name:
|
my-location-name:
|
||||||
from: path/to/backup
|
from: path/to/backup
|
||||||
|
# Or multiple
|
||||||
|
# from:
|
||||||
|
# - /a
|
||||||
|
# - /b
|
||||||
to:
|
to:
|
||||||
- name-of-backend
|
- name-of-backend
|
||||||
- also-backup-to-this-backend
|
- also-backup-to-this-backend
|
||||||
@ -14,7 +20,7 @@ locations:
|
|||||||
|
|
||||||
## `from`
|
## `from`
|
||||||
|
|
||||||
This is the source of the location.
|
This is the source of the location. Can be an `array` for multiple sources.
|
||||||
|
|
||||||
#### How are paths resolved?
|
#### How are paths resolved?
|
||||||
|
|
||||||
|
@ -25,9 +25,15 @@ For a quick overview:
|
|||||||
> 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 or config file somewhere in case your server dies**. Otherwise DATA IS LOST!
|
> 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 or config file somewhere in case your server dies**. Otherwise DATA IS LOST!
|
||||||
|
|
||||||
```yaml | .autorestic.yml
|
```yaml | .autorestic.yml
|
||||||
|
version: 2
|
||||||
|
|
||||||
locations:
|
locations:
|
||||||
home:
|
home:
|
||||||
from: /home/me
|
from: /home
|
||||||
|
# Or multiple
|
||||||
|
# from:
|
||||||
|
# - /foo
|
||||||
|
# - /bar
|
||||||
to: remote
|
to: remote
|
||||||
|
|
||||||
important:
|
important:
|
||||||
|
Loading…
Reference in New Issue
Block a user