cupcakearmy/autorestic
1
0
Fork 0
mirror of https://github.com/cupcakearmy/autorestic.git synced 2024-12-22 16:26:25 +00:00
Code Issues Packages Projects Releases Wiki Activity
41e4e4a5f3
autorestic/docs/pages/backend/index.md
Boris Bera bc74d3f13e
Add option to crash autorestic when key is missing instead of generating a new key (#383) 
* feat(backend): add requireKey option to backend

This option will prevent `autorestic` from generating a key and will
cause it to crash instead. This is intended for use cases where you want
to provision the key yourself and don't want `autorestic` to
accidentally generate one for you.

* doc(backend): document requireKey
2024-08-28 17:21:01 +02:00

1.1 KiB
Raw Blame History

💽 Backends

Backends are the outputs of the backup process. Each location needs at least one.

Note: names of backends MUST be lower case!

version: 2

backends:
  name-of-backend:
    type: local
    path: /data/my/backups

Types

We restic supports multiple types of backends. See the full list for details.

Avoid Generating Keys

By default, autorestic will generate a key for every backend if none is defined. This is done by updating your config file with the key.

In cases where you want to provide the key yourself, you can ensure that autorestic doesn't accidentally generate one for you by setting requireKey: true.

Example:

version: 2

backends:
  foo:
    type: local
    path: /data/my/backups
    # Alternatively, you can set the key through the `AUTORESTIC_FOO_RESTIC_PASSWORD` environment variable.
    key: ... your key here ...
    requireKey: true

With this setting, if a key is missing, autorestic will crash instead of generating a new key and updating your config file.