autorestic/docs/pages/backend/index.md

# 💽 Backends

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

Note: names of backends MUST be lower case!

```yaml | .autorestic.yml
version: 2

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

## Types

We restic supports multiple types of backends. See the [full list](/backend/available) 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:

```yaml | .autorestic.yml
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.

## Automatic Backend Initialization

`autorestic` is able to automatically initialize backends for you. This is done by setting `init: true` in the config for a given backend. For example:

```yaml | .autorestic.yml
backend:
  foo:
    type: ...
    path: ...
    init: true
```

When you set `init: true` on a backend config, `autorestic` will automatically initialize the underlying `restic` repository that powers the backend if it's not already initialized. In practice, this means that the backend will be initialized the first time it is being backed up to.

This option is helpful in cases where you want to automate the configuration of `autorestic`. This means that instead of running `autorestic exec init -b ...` manually when you create a new backend, you can let `autorestic` initialize it for you.
finished docs 2020-05-17 13:30:23 +00:00			`# 💽 Backends`

typos 2021-04-21 07:34:01 +00:00			`Backends are the outputs of the backup process. Each location needs at least one.`
Add line break in documentation 2022-04-07 09:00:28 +00:00
Add lower case warning for backend name If uppercase characters are used in a backend name a check (and I assume other actions) will fail. 2022-04-06 20:28:25 +00:00			`Note: names of backends MUST be lower case!`
finished docs 2020-05-17 13:30:23 +00:00
			```yaml \| .autorestic.yml
docs 2021-11-21 20:06:25 +00:00			`version: 2`

finished docs 2020-05-17 13:30:23 +00:00			`backends:`
			`name-of-backend:`
			`type: local`
			`path: /data/my/backups`
			```

			`## Types`

			`We restic supports multiple types of backends. See the [full list](/backend/available) for details.`
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 15:21:01 +00:00
			`## 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:`

			```yaml \| .autorestic.yml
			`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.
feat(backend): add init option to backend config When this option is set to `true`, the backend will automatically get initialized during the backup process. This applies to invoking `autorestic backup` or when `autorestic cron` actualy performs a backup. 2024-10-14 17:56:22 +00:00
			`## Automatic Backend Initialization`

			`autorestic` is able to automatically initialize backends for you. This is done by setting `init: true` in the config for a given backend. For example:

			```yaml \| .autorestic.yml
			`backend:`
			`foo:`
			`type: ...`
			`path: ...`
			`init: true`
			```

			When you set `init: true` on a backend config, `autorestic` will automatically initialize the underlying `restic` repository that powers the backend if it's not already initialized. In practice, this means that the backend will be initialized the first time it is being backed up to.

			This option is helpful in cases where you want to automate the configuration of `autorestic`. This means that instead of running `autorestic exec init -b ...` manually when you create a new backend, you can let `autorestic` initialize it for you.