> 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/connecting-to-the-duplicati-console.md).

# Connecting to the Duplicati console

This page describes how to connect a Duplicati open-source client to the Duplicati console

The Duplicati open-source client can run without a connection to the console, but connecting the client offers additional features, such as backup monitoring, remote management, zero-configuration storage and more.

{% hint style="info" %}
Since the [Agent](https://docs.duplicati.com/duplicati-programs/agent.md) does not have a local UI, refer to the [Agent section for information on how to register](https://docs.duplicati.com/duplicati-programs/agent.md)
{% endhint %}

## Connect a single machine

To connect a single machine to the Duplicati console, the simplest approach is to use the dedicated "Click to register" feature shown in the top-right corner of the Duplicati open-source client screen:

<figure><picture><source srcset="https://2363712449-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7cMJiGuXy340g9NzpxLY%2Fuploads%2FWpJ5Edq27Ew58wInUs2w%2FScreenshot%202026-05-28%20at%2011.40.54.png?alt=media&amp;token=fedf6711-f0d6-4c9c-824d-ba8ae27b4402" media="(prefers-color-scheme: dark)"><img src="https://2363712449-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7cMJiGuXy340g9NzpxLY%2Fuploads%2Ft88TCZjF5iM35jt1s9uH%2FScreenshot%202026-05-28%20at%2011.40.45.png?alt=media&amp;token=07369b90-73aa-48ad-8d99-c2c954e274e0" alt=""></picture><figcaption></figcaption></figure>

After clicking "Click to register" you will need to accept adding the machine to your account:

<figure><img src="https://2363712449-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7cMJiGuXy340g9NzpxLY%2Fuploads%2FFGcOtRWDjCpXHfgN8sTv%2FScreenshot%202026-05-28%20at%2011.43.30.png?alt=media&amp;token=d8ab2c2f-c6e9-4a19-aa9f-1f35f78bc113" alt="" width="563"><figcaption></figcaption></figure>

After this, the machine is connected to the console, and no further action is needed.

## Connect with a link

{% hint style="info" %}
Links are available with a Pro or Enterprise subscription, and during a trial. You must be an owner of the organization to create or change a link.
{% endhint %}

{% hint style="info" %}
Registering an [Agent](https://docs.duplicati.com/duplicati-programs/agent.md) requires an Enterprise subscription or a trial. With a Pro subscription, links can only register the TrayIcon and the Server.
{% endhint %}

If you prefer a more automated way to connect to the console, you can generate a link that is pre-authenticated. This is done on the ["Links" page on the console](https://app.duplicati.com/app/machines/links):

<figure><picture><source srcset="https://2363712449-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7cMJiGuXy340g9NzpxLY%2Fuploads%2Fgit-blob-c821b122e9a0565cc8b5ad5744a7ed11471898a7%2Fconsole-links-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-9fddf9437f241611d16ebf5307d8a2e5c0771233%2Fconsole-links-list-light.png?alt=media" alt="The Links page in the Duplicati Console"></picture><figcaption></figcaption></figure>

Click "Create a new link" to create the link and set the [options on the link](#link-options). Then click the "Copy" button to copy the URL. On the open-source client, go to settings and paste in the link into the "Connect to console" field, replacing the existing text:

<figure><picture><source srcset="https://2363712449-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7cMJiGuXy340g9NzpxLY%2Fuploads%2FSHbch5m2yyiu4DBu9u9g%2FScreenshot%202026-05-28%20at%2011.48.36.png?alt=media&amp;token=f461f452-51b9-463a-b89e-060eaefcf8cc" media="(prefers-color-scheme: dark)"><img src="https://2363712449-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7cMJiGuXy340g9NzpxLY%2Fuploads%2FCOFyCjZf6BLlp5n69QpF%2FScreenshot%202026-05-28%20at%2011.07.13.png?alt=media&amp;token=0b0a5eb2-3269-4130-a22d-3b086967ab62" alt=""></picture><figcaption></figcaption></figure>

Then click "Register on console" and the open-source client will connect directly.

If you prefer to register via the commandline, you can run either [TrayIcon](https://docs.duplicati.com/duplicati-programs/trayicon.md) or [Server](https://docs.duplicati.com/duplicati-programs/server.md) with the `--register-remote-control=<copied-url>`, for example:

```
duplicati-server --register-remote-control=<copied-url>
```

### Link options

The options are set when you create the link, and can be changed later with the "Edit" button:

<figure><picture><source srcset="https://2363712449-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7cMJiGuXy340g9NzpxLY%2Fuploads%2Fgit-blob-d59cb6bff152f33e2fb1295f64e1daf928a87195%2Fconsole-links-create-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-76a099f802217088216617e5fb190220e7e684f0%2Fconsole-links-create-light.png?alt=media" alt="The options for a new link"></picture><figcaption></figcaption></figure>

| Option                                         | Description                                                                                                                                                                                  |
| ---------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Name                                           | The name shown in the list of links. This is required.                                                                                                                                       |
| Valid for                                      | How long the link can be used, from 30 days to 5 years. The default is 90 days. When editing a link, this is instead a "Valid until" date that can be moved.                                 |
| Select connection icon                         | The icon shown next to the link.                                                                                                                                                             |
| Activate reporting                             | Machines send backup reports to the console. This is on by default.                                                                                                                          |
| Require manual approval of registered machines | New machines wait until you choose "Approve Machine" in the machine list. Until then, they have no license and receive no configurations.                                                    |
| Issue storage API key                          | Machines get a key for [Duplicati Storage](https://docs.duplicati.com/duplicati-console/duplicati-storage.md). This is on by default.                                                        |
| Select configs to apply to this connection     | [Backup configurations](https://docs.duplicati.com/duplicati-console/backup-configurations.md) that are pushed to machines that register with the link. Requires an Enterprise subscription. |

If the organization has per-machine storage limits enabled, the link also has the options "Unlimited storage" and "Storage quota".

### Manage links

The options only apply when a machine registers. Changing a link does not change machines that are already registered, and this includes the configurations on the link.

A link that has expired can no longer register machines. The trash can button deletes a link, so it can no longer be used. Machines that have already registered with the link stay connected.

## Connect with a file

Similar to the [link approach](#connect-with-a-link), you can also generate a file that configures the open-source client to automatically connect. This is done with the "Download" button on the ["Links" page on the console](https://app.duplicati.com/app/machines/links):

<figure><picture><source srcset="https://2363712449-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F7cMJiGuXy340g9NzpxLY%2Fuploads%2Fgit-blob-c821b122e9a0565cc8b5ad5744a7ed11471898a7%2Fconsole-links-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-9fddf9437f241611d16ebf5307d8a2e5c0771233%2Fconsole-links-list-light.png?alt=media" alt="The Links page in the Duplicati Console"></picture><figcaption></figcaption></figure>

You will then download a file named [`preload.json`](https://docs.duplicati.com/configuration-and-management/preload-settings.md) which has the link inside. The same file works for the TrayIcon, the Server and the [Agent](https://docs.duplicati.com/duplicati-programs/agent.md). You simply place this file in either the installation folder for Duplicati or in the [datafolder](https://docs.duplicati.com/database-and-storage/the-server-database.md), and the open-source client will automatically connect to the console when it (re-)starts. After starting with the preload file, the file can be deleted, but has no effect if it is left behind.

{% hint style="info" %}
Note that a `preload.json` placed inside the data folder is only loaded if the folder passes the [permission check](https://docs.duplicati.com/database-and-storage/the-server-database.md#limited-access-to-the-database-folder).
{% endhint %}

For automated install, an MDM tool or similar can place the `preload.json` file in the target folder prior to installing Duplicati such that it automatically connects on startup.


---

# 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/connecting-to-the-duplicati-console.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.
