> For the complete documentation index, see [llms.txt](https://docs.duplicati.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.duplicati.com/duplicati-console/backup-configurations.md).

# Backup configurations

This page describes how to create backup configurations in the Duplicati Console and push them to connected machines, either directly or through a connection link.

A backup configuration is a backup job that is defined in the Duplicati Console and pushed to one or more connected machines. Instead of setting up the same backup on each machine, you create it once and assign it to the machines that should run it. When you change the configuration, the change is sent to every machine it is assigned to.

Configurations are found on the [**Configurations** tab](https://app.duplicati.com/app/machines/configurations) under **Machines**. The configurations run on the machines themselves, using either the [TrayIcon](https://docs.duplicati.com/duplicati-programs/trayicon.md), the [Server](https://docs.duplicati.com/duplicati-programs/server.md) or the [Agent](https://docs.duplicati.com/duplicati-programs/agent.md). If you want the console to run a backup of Microsoft 365 or Google Workspace without a machine of your own, see [Managed Microsoft 365 backup](https://docs.duplicati.com/duplicati-console/managed-microsoft-365-backup.md) and [Managed Google Workspace backup](https://docs.duplicati.com/duplicati-console/managed-google-workspace-backup.md) instead.

{% hint style="info" %}
Creating and assigning configurations requires an Enterprise subscription, which can also be an Enterprise trial. The Pro trial that starts when you connect your first machine does not include configurations. You must be an owner of the organization to create, change or assign a configuration.
{% endhint %}

{% hint style="info" %}
Configurations are not available for an organization with [confidential processing](https://docs.duplicati.com/duplicati-console/confidential-processing.md), and the **Configurations** tab is hidden for such an organization.
{% endhint %}

## How a configuration reaches a machine

A configuration is pushed to a machine in one of two ways:

* [**Assigned to a connected machine**](#assign-a-configuration-to-a-machine), which is done from the machine list.
* [**Added to a connection link**](#apply-a-configuration-with-a-connection-link), so each machine that registers with the link receives the configuration.

The console then sends the configuration to the machine, shortly after the assignment. If the machine is offline, it receives the configuration the next time it connects. A machine only receives configurations when it has a license, and not while it is waiting for [manual approval](https://docs.duplicati.com/duplicati-console/connecting-to-the-duplicati-console.md#link-options).

Each configuration belongs to the organization it was created in, and can only be assigned to machines in that organization. Sub-organizations do not inherit configurations from the parent organization.

## The list of configurations

The list shows the configurations in the current organization with the destination, the schedule and a search field to find a configuration by name:

<figure><picture><source srcset="https://2363712449-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7cMJiGuXy340g9NzpxLY%2Fuploads%2Fgit-blob-7f2c07bf741c40c67fed961d6ed7420fbf60b127%2Fconsole-configurations-list-dark.png?alt=media" media="(prefers-color-scheme: dark)"><img src="https://2363712449-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7cMJiGuXy340g9NzpxLY%2Fuploads%2Fgit-blob-89b19b17e5efe3e0d9f471f14ddb3106c7798774%2Fconsole-configurations-list-light.png?alt=media" alt="The list of configurations in the Duplicati Console"></picture><figcaption></figcaption></figure>

Unfinished configurations are hidden from the list. Toggle **Show drafts** to see them. Use **Edit** to open a configuration, and the menu next to it to archive it, as described in [Remove a configuration](#remove-a-configuration).

## Create a configuration

Click **Create config** to start. The configuration is created as a draft right away, and is saved as a draft each time you click **Continue**, so you can leave at any step and continue later. The draft cannot be assigned to a machine until you click **Submit** on the last step.

You can jump between the steps by clicking them at the top of the page.

### General

Enter the **Backup name**, and choose how the backup is encrypted:

<figure><picture><source srcset="https://2363712449-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7cMJiGuXy340g9NzpxLY%2Fuploads%2Fgit-blob-4ba6dcbe1541709ccc9f1029adbbcdcad96ae3bd%2Fconsole-configurations-general-dark.png?alt=media" media="(prefers-color-scheme: dark)"><img src="https://2363712449-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7cMJiGuXy340g9NzpxLY%2Fuploads%2Fgit-blob-6777416d453fdcc4fb8a0b4ab820be9c5bd315dd%2Fconsole-configurations-general-light.png?alt=media" alt="The General step with the backup name and the encryption choice"></picture><figcaption></figcaption></figure>

* **Auto generate encryption key** creates a random key when you click **Submit**. The key is used by every machine that receives the configuration.
* **Manual enter an encryption key** uses a named key that is stored in the console. Select an existing key, or choose **Create new encryption key** to give a name and a value for a new one. A stored key can be used by several configurations.

<figure><picture><source srcset="https://2363712449-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7cMJiGuXy340g9NzpxLY%2Fuploads%2Fgit-blob-9f288a3f3de6705c6a3063a8e5e16689160828b5%2Fconsole-configurations-general-manual-key-dark.png?alt=media" media="(prefers-color-scheme: dark)"><img src="https://2363712449-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7cMJiGuXy340g9NzpxLY%2Fuploads%2Fgit-blob-daed0da2da9db1b418b430bc6b7d16ac61ca3f18%2Fconsole-configurations-general-manual-key-light.png?alt=media" alt="Selecting a stored encryption key"></picture><figcaption></figcaption></figure>

{% hint style="info" %}
To give each machine its own encryption key, and keep the key out of the console, use a secret manager on the machines. See [Use a secret manager on the machines](#use-a-secret-manager-on-the-machines).
{% endhint %}

{% hint style="warning" %}
The encryption choice cannot be changed after the configuration is submitted. The console rejects changes to the key, because the machines would no longer be able to read the existing backups.
{% endhint %}

### Destinations

Choose where the backups are stored. The list has the same [destinations](https://docs.duplicati.com/backup-destinations/destination-overview.md) as the client, and you can use the search field to find one:

<figure><picture><source srcset="https://2363712449-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7cMJiGuXy340g9NzpxLY%2Fuploads%2Fgit-blob-e9cb9f4c96af4378a84df21aeec303554a1f210e%2Fconsole-configurations-destination-list-dark.png?alt=media" media="(prefers-color-scheme: dark)"><img src="https://2363712449-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7cMJiGuXy340g9NzpxLY%2Fuploads%2Fgit-blob-e28e23486a3190e9b593c23e659eceb850a6f86f%2Fconsole-configurations-destination-list-light.png?alt=media" alt="Choosing a destination type"></picture><figcaption></figcaption></figure>

After choosing a destination, fill in the fields for it. Use **Change** to pick another destination type. **Add advanced option** adds destination options, and the menu next to it lets you edit them as text:

<figure><picture><source srcset="https://2363712449-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7cMJiGuXy340g9NzpxLY%2Fuploads%2Fgit-blob-986393ef0bf3828058d204079452378740559ef0%2Fconsole-configurations-destination-form-dark.png?alt=media" media="(prefers-color-scheme: dark)"><img src="https://2363712449-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7cMJiGuXy340g9NzpxLY%2Fuploads%2Fgit-blob-cf482cfa6e4279efc7edfd3f3de7df21e6dadfc8%2Fconsole-configurations-destination-form-light.png?alt=media" alt="The fields for an S3 compatible destination"></picture><figcaption></figcaption></figure>

If you already have the destination as a URL, use **Set target URL** at the top of the page. For an existing destination the same option is called **Edit target URL**, and is found in the menu at the top of the page together with **Copy url to clipboard**.

There are a few differences from setting up a destination in the client:

* The console does not test the connection, and you cannot browse for folders. The destination is first used when a machine runs the backup, so check the first run on one machine before you assign the configuration widely.
* Paths are evaluated on the machine. A **File system** path must exist on every machine that receives the configuration.
* Destinations that sign in with an AuthID have a button that creates the AuthID, and all machines then use the same AuthID.
* Credentials entered here are stored in the console and sent to every machine. To give each machine its own credentials instead, use [machine variables](https://docs.duplicati.com/duplicati-console/backup-configurations/machine-variables.md) or [a secret manager on the machines](#use-a-secret-manager-on-the-machines).
* The fields can hold the [machine placeholders](#machine-placeholders) and [machine variables](https://docs.duplicati.com/duplicati-console/backup-configurations/machine-variables.md), which are filled in for each machine. A hint above the fields lists them.

{% hint style="warning" %}
Each machine needs its own destination folder, because two machines cannot share one backup. See [Use a configuration on several machines](#use-a-configuration-on-several-machines).
{% endhint %}

### Source Data

Add the folders to back up under **Paths**, using one entry for each path. The console has no access to the file system of the machines, so the paths are typed in, and they must match the operating system of the machines. Paths are given as on the client, which means a folder ends with a path separator, for instance `/srv/data/` or `C:\Data\`.

<figure><picture><source srcset="https://2363712449-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7cMJiGuXy340g9NzpxLY%2Fuploads%2Fgit-blob-a8c85c82a26e2fb00f30478f25a2a8045056fb8f%2Fconsole-configurations-source-dark.png?alt=media" media="(prefers-color-scheme: dark)"><img src="https://2363712449-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7cMJiGuXy340g9NzpxLY%2Fuploads%2Fgit-blob-7bcab8d381b197ad54e108dca6694d5b25b41c96%2Fconsole-configurations-source-light.png?alt=media" alt="The Source Data step with paths, filters and exclusions"></picture><figcaption></figcaption></figure>

Under **Filters**, click **Add filter** to include or exclude files. You can match on file extension, on names that contain a text, on a folder, on a regular expression, or on a predefined group of files such as temporary files or system files. The filters work as described in [Filters in Duplicati](https://docs.duplicati.com/security-and-secrets/filters-in-duplicati.md).

### Schedule

Pick **Daily 12:00**, **Weekdays 12:00** or **Weekly monday 12:00**, or pick **Manual** to set up the schedule yourself:

<figure><picture><source srcset="https://2363712449-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7cMJiGuXy340g9NzpxLY%2Fuploads%2Fgit-blob-abd6ad62198d9ba2101e55a5e65d0ad2aa7fbefd%2Fconsole-configurations-schedule-dark.png?alt=media" media="(prefers-color-scheme: dark)"><img src="https://2363712449-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7cMJiGuXy340g9NzpxLY%2Fuploads%2Fgit-blob-c84e034a0f497d77973c04972bed54d35b628e92%2Fconsole-configurations-schedule-light.png?alt=media" alt="The Schedule step with a manual schedule"></picture><figcaption></figcaption></figure>

With **Manual** you choose the next time the backup runs, how often it repeats and which days it is allowed to run on. Turn off **Automatically run backups** if the backup should not run on a schedule. Such a backup only runs when it is started on the machine.

If a machine is turned off at the scheduled time, the backup runs as soon as possible afterwards.

### Options

Choose the **Backup retention**, which works as described in [Retention settings](https://docs.duplicati.com/configuration-and-management/retention-settings.md):

<figure><picture><source srcset="https://2363712449-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7cMJiGuXy340g9NzpxLY%2Fuploads%2Fgit-blob-bb93e438ae87ca98eaf545d380f0d93e59a76ba7%2Fconsole-configurations-options-dark.png?alt=media" media="(prefers-color-scheme: dark)"><img src="https://2363712449-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7cMJiGuXy340g9NzpxLY%2Fuploads%2Fgit-blob-d1c9e0d0b3aabe2759f3d7b4caf397fba2b0ec1e%2Fconsole-configurations-options-light.png?alt=media" alt="The Options step with backup retention and advanced options"></picture><figcaption></figcaption></figure>

| Option                             | Effect                                                                                  |
| ---------------------------------- | --------------------------------------------------------------------------------------- |
| Keep all backups                   | Nothing is deleted, and the backup grows with each change.                              |
| Delete backups that are older than | Versions older than the given time are deleted, as long as a newer version exists.      |
| Keep a specific number of backups  | The oldest versions are deleted when there are more than the given number.              |
| Smart backup retention             | Keeps one version for each of the last 7 days, the last 4 weeks and the last 12 months. |
| Custom backup retention            | Uses a retention expression, for instance `7D:1D,4W:1W,36M:1M`.                         |

Under **Advanced options** you can add any option for the backup, such as `dblock-size` for the remote volume size. The menu next to **Add advanced option** has **New custom option** for an option that is not in the list, and **Edit contents as text** to paste a list of options.

Click **Submit** to finish the configuration.

### Store the generated encryption key

If you chose **Auto generate encryption key**, the key is shown after you click **Submit**. Copy it to a safe place, check the box and click **Done**:

<figure><picture><source srcset="https://2363712449-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7cMJiGuXy340g9NzpxLY%2Fuploads%2Fgit-blob-df2a33a18d1281553e8e31bc446fe4e3cd34d81d%2Fconsole-configurations-generated-key-dark.png?alt=media" media="(prefers-color-scheme: dark)"><img src="https://2363712449-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7cMJiGuXy340g9NzpxLY%2Fuploads%2Fgit-blob-45c3145fa0a51e8e4cd07b56c30b3e5e00a7de7c%2Fconsole-configurations-generated-key-light.png?alt=media" alt="The dialog that shows the generated encryption key once" width="375"></picture><figcaption></figcaption></figure>

{% hint style="danger" %}
The generated key is only shown once and cannot be retrieved later. Without it, the backup cannot be restored outside the console.
{% endhint %}

## Assign a configuration to a machine

To push configurations to a machine that is already connected:

1. Go to the [**Machines** tab](https://app.duplicati.com/app/machines).
2. Open the menu at the end of the row for the machine and choose **Assign Backups**.
3. Check the configurations the machine should have, uncheck the ones it should no longer have, and click **Save**.

<figure><picture><source srcset="https://2363712449-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7cMJiGuXy340g9NzpxLY%2Fuploads%2Fgit-blob-23952225b69105d98c79b25ca0f6d3855a0f6057%2Fconsole-machines-assign-backups-dark.png?alt=media" media="(prefers-color-scheme: dark)"><img src="https://2363712449-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7cMJiGuXy340g9NzpxLY%2Fuploads%2Fgit-blob-2179b648b121315b91749bfd50808c11f216d221%2Fconsole-machines-assign-backups-light.png?alt=media" alt="The dialog for assigning configurations to a machine" width="375"></picture><figcaption></figcaption></figure>

You can see what each machine has by adding the **Assigned Backups** column to the machine list.

If a configuration uses a [machine variable](https://docs.duplicati.com/duplicati-console/backup-configurations/machine-variables.md) that the machine does not have, the configuration is held back from the machine until the variable is set, and the **Variables** dialog for the machine opens after you click **Save**.

## Apply a configuration with a connection link

A [connection link](https://docs.duplicati.com/duplicati-console/connecting-to-the-duplicati-console.md#connect-with-a-link) can carry configurations, so a machine has its backups from the moment it connects. This is the simplest way to roll out a standard backup to many new machines.

When you create or edit a link on the [**Links** tab](https://app.duplicati.com/app/machines/links), select the configurations under **Select configs to apply to this connection**. **Create new config** starts the steps above and returns to the link afterwards.

The configurations in a link are assigned when a machine registers with it. Changing the configurations in a link does not change machines that have already registered, so use **Assign Backups** for those.

## What happens on the machine

The backup shows up on the machine like any other backup, with the chip **Externally managed**. It runs on its schedule and can be started and restored on the machine as usual, but it cannot be edited, exported or deleted there. The **Edit in console** button on the backup opens the configuration in the console.

<figure><picture><source srcset="https://2363712449-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7cMJiGuXy340g9NzpxLY%2Fuploads%2Fgit-blob-59912136549077011c72b973d6eb8b3e0086ac80%2Fconsole-client-externally-managed-dark.png?alt=media" media="(prefers-color-scheme: dark)"><img src="https://2363712449-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7cMJiGuXy340g9NzpxLY%2Fuploads%2Fgit-blob-77eba018b8e94d5b9b0b4c055d7c6eea9d8178d5%2Fconsole-client-externally-managed-light.png?alt=media" alt="A backup in the Duplicati client with the Externally managed chip and the Edit in console button"></picture><figcaption></figcaption></figure>

If the connection to the console is removed on the machine, the backups that were pushed to it are removed from the machine as well.

## Use a configuration on several machines

Several machines can share a configuration, but each machine needs its own place to store the backup.

The simplest choice is [Duplicati Storage](https://docs.duplicati.com/duplicati-console/duplicati-storage.md). Each machine has its own bucket, so a configuration with Duplicati Storage can be assigned to any number of machines. The machines need a storage API key, which is issued by default when a machine registers.

With any other destination, give each machine its own folder with a [placeholder](#machine-placeholders) such as `${machinename}` in the folder path. If the machines also need their own credentials, or the destination differs in other ways, put the parts that differ in [machine variables](https://docs.duplicati.com/duplicati-console/backup-configurations/machine-variables.md), or let each machine look up its credentials in a [secret manager](#use-a-secret-manager-on-the-machines).

### Machine placeholders

The following placeholders are replaced with the value for each machine when the configuration is pushed:

| Placeholder      | Value                                  |
| ---------------- | -------------------------------------- |
| `${machineid}`   | The ID of the machine                  |
| `${machinename}` | The name of the machine in the console |
| `${orgid}`       | The ID of the organization             |

The placeholders can be used in the destination, the backup name, the source paths, the filters and the advanced options. For instance, a folder path of `backups/${machinename}` gives each machine its own folder at the destination, and a backup named `Documents on ${machinename}` shows which machine it belongs to.

### Machine variables

For values that the console does not know, such as the credentials for each machine or the address of a local server, define your own variables on each machine and refer to them as `${var:name}` in the configuration. With variables, a single configuration can be shared by all machines, also when each machine needs its own credentials. See [Machine variables](https://docs.duplicati.com/duplicati-console/backup-configurations/machine-variables.md).

### Use a secret manager on the machines

By default, the encryption key and the destination credentials are stored in the console and are the same on every machine. With a [secret provider](https://docs.duplicati.com/security-and-secrets/using-the-secret-provider.md) on the machines, the configuration only holds the name of a secret, and each machine looks up its own value when the backup runs. This means that:

* Each machine can have its own encryption key and its own credentials for the destination.
* The actual secrets are not stored in the console.

To set this up:

1. Set up a secret provider on each machine, for instance a [local provider](https://docs.duplicati.com/security-and-secrets/using-the-secret-provider/local-providers.md) or a [cloud provider](https://docs.duplicati.com/security-and-secrets/using-the-secret-provider/cloud-providers.md), with `--secret-provider` as described in [Using the secret provider](https://docs.duplicati.com/security-and-secrets/using-the-secret-provider.md#using-secret-provider-in-the-user-interface). The default secret provider for the operating system is not enough. The option can also be set with a [`preload.json`](https://docs.duplicati.com/configuration-and-management/preload-settings.md) file.
2. Store the secrets under the same names on each machine, with a value for that machine.
3. In the configuration, use the name of the secret with a `$` in front, in place of the value. The field must only hold that reference, as a secret cannot be part of a longer value.

For the encryption key, choose **Manual enter an encryption key**, choose **Create new encryption key** and enter the reference as the key value, for instance `$backup-passphrase`.

For the destination, enter the reference in the fields for the credentials, for instance `$s3-secret` as the password. This also works for options you add under **Add advanced option**. Secrets are only looked up in the options of the destination, so a reference cannot be used for the server name or the folder path.

{% hint style="warning" %}
If a machine cannot find a secret, the backup fails with a message that names the missing secret. Check that the secrets are in place before you assign the configuration to a machine.
{% endhint %}

{% hint style="warning" %}
The console does not know the value of the secrets, and cannot show them. Keep a copy of the encryption key for each machine outside the machine, or the backup cannot be restored if the machine is lost.
{% endhint %}

## Change a configuration

Click **Edit** in the list to change a configuration. The steps are the same as when creating it.

{% hint style="warning" %}
For a configuration that has been submitted, each **Continue** saves the changes and pushes them to the assigned machines, so the change does not wait for **Submit**.
{% endhint %}

A machine that is offline receives the changes when it next connects.

## Remove a configuration from a machine

Open **Assign Backups** for the machine and uncheck the configuration. The backup job is then removed from the machine.

The backup files at the destination are not deleted, so the data can still be [restored](https://docs.duplicati.com/getting-started/restoring-files.md) with the encryption key. They must be deleted from the destination by hand if they are no longer needed.

If you assign the configuration to the machine again, the machine sets it up as a new backup with a new local database. The database must be recreated from the destination before the backup can continue.

## Remove a configuration

To remove a configuration completely, open the menu next to **Edit** and choose **Archive**. The dialog calls this deleting the configuration, and the configuration is removed from the list.

A configuration can only be archived when it is not in use, so you must first:

* Unassign it from all machines.
* Remove it from all connection links that have not expired.

Archiving does not delete any backups at the destination.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.duplicati.com/duplicati-console/backup-configurations.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
