autorestic/docs/pages/backend/env.md

66 lines
1.6 KiB
Markdown
Raw Normal View History

2021-10-25 18:02:51 +02:00
# Environment
2021-10-30 13:48:44 +02:00
> ⚠ Available since version `v1.4.0`
2021-10-25 18:02:51 +02:00
Sometimes it's favorable not having the encryption keys in the config files.
2021-10-30 13:48:44 +02:00
For that `autorestic` allows passing the env variables to backend password as `ENV` variables, or through an env file.
You can also pass whatever `env` variable to restic by prefixing it with `AUTORESTIC_[BACKEND NAME]_`.
2021-10-25 18:02:51 +02:00
2021-10-30 13:48:44 +02:00
> Env variables and file overwrite the config file in the following order:
>
> Env Variables > Env File (`.autorestic.env`) > Config file (`.autorestic.yaml`)
## Env file
Alternatively `autorestic` can load an env file, located next to `.autorestic.yml` called `.autorestic.env`.
```
AUTORESTIC_FOO_RESTIC_PASSWORD=secret123
```
### Example with repository password
The syntax for the `ENV` variables is as follows: `AUTORESTIC_[BACKEND NAME]_RESTIC_PASSWORD`.
2021-10-25 18:02:51 +02:00
```yaml | autorestic.yaml
backend:
foo:
type: ...
path: ...
2021-10-30 13:48:44 +02:00
key: secret123 # => AUTORESTIC_FOO_RESTIC_PASSWORD=secret123
2021-10-25 18:02:51 +02:00
```
This means we could remove `key: secret123` from `.autorestic.yaml` and execute as follows:
```bash
2021-10-30 13:48:44 +02:00
AUTORESTIC_FOO_RESTIC_PASSWORD=secret123 autorestic backup ...
2021-10-25 18:02:51 +02:00
```
2021-10-30 13:48:44 +02:00
### Example with Backblaze B2
```yaml | autorestic.yaml
backends:
bb:
type: b2
path: myBucket
key: myPassword
env:
B2_ACCOUNT_ID: 123
B2_ACCOUNT_KEY: 456
```
2021-10-25 18:02:51 +02:00
2021-10-30 13:48:44 +02:00
You could create an `.autorestic.env` or pass the following `ENV` variables to autorestic:
2021-10-25 18:02:51 +02:00
2021-10-30 13:48:44 +02:00
```
AUTORESTIC_BB_RESTIC_PASSWORD=myPassword
AUTORESTIC_BB_B2_ACCOUNT_ID=123
AUTORESTIC_BB_B2_ACCOUNT_KEY=456
2021-10-25 18:02:51 +02:00
```
2021-10-30 13:48:44 +02:00
```yaml | autorestic.yaml
backends:
bb:
type: b2
path: myBucket
```