autorestic/docs/pages/backend/available.md

86 lines
2.0 KiB
Markdown
Raw Normal View History

2020-05-17 15:30:23 +02:00
# Available Backends
In theory [all the restic backends](https://restic.readthedocs.io/en/stable/030_preparing_a_new_repo.html) are supported.
Those tested are the following:
2021-10-30 13:48:44 +02:00
> You can also [specify the `env` variables in a config file](/backend/env) to separate them from the config file.
2020-05-17 15:30:23 +02:00
## Local
```yaml
backends:
name-of-backend:
type: local
path: /data/my/backups
```
## Backblaze
```yaml
backends:
name-of-backend:
type: b2
2021-10-22 17:57:43 +02:00
path: 'bucket_name'
2021-04-27 09:01:01 +02:00
# Or With a path
2021-10-22 17:57:43 +02:00
# path: 'bucket_name:/some/path'
2021-04-21 09:36:47 +02:00
env:
2021-04-27 01:38:08 +02:00
B2_ACCOUNT_ID: 'backblaze_keyID'
B2_ACCOUNT_KEY: 'backblaze_applicationKey'
2020-05-17 15:30:23 +02:00
```
2021-04-23 13:45:54 +02:00
#### API Keys gotcha
2021-10-22 17:57:43 +02:00
If you use a _File name prefix_ when making the application key, do not include a leading slash. Make sure to include this prefix in the path (e.g. `path: 'bucket_name:my/path'`).
2021-04-23 13:45:54 +02:00
2020-05-17 15:30:23 +02:00
## S3 / Minio
```yaml
backends:
name-of-backend:
type: s3
path: s3.amazonaws.com/bucket_name
# Minio
# path: http://localhost:9000/bucket_name
2021-04-21 09:36:47 +02:00
env:
AWS_ACCESS_KEY_ID: my_key
AWS_SECRET_ACCESS_KEY: my_secret
2020-05-17 15:30:23 +02:00
```
## SFTP
For SFTP to work you need to use configure your host inside of ~/.ssh/config as password prompt is not supported. For more information on this topic please see the [official docs](https://restic.readthedocs.io/en/stable/030_preparing_a_new_repo.html#sftp) on the matter.
```yaml
backends:
name-of-backend:
type: sftp
path: my-host:/remote/path/on/the/server
```
2020-07-23 13:26:31 +02:00
## Rest Server
See [here](https://github.com/restic/rest-server) for how to install a rest server backend and [here](https://restic.readthedocs.io/en/latest/030_preparing_a_new_repo.html#rest-server) for further documentation.
```yaml
backends:
name-of-backend:
type: rest
path: http://localhost:8000/repo_name
2021-04-23 13:45:54 +02:00
# Or authenticated
path: https://user:pass@host:6969/path
```
Optionally you can set user and password separately
```yaml
backends:
rest:
type: rest
path: http://localhost:6969/path
key: ...
rest:
user: user
password: pass
2020-07-23 13:26:31 +02:00
```