Duplicati

https://docs.duplicati.com
Admin
Duplicati is a free, open-source backup client that securely stores encrypted, incremental, and...
Tokens:79,905
Snippets:664
Trust Score:9.9
Update:10 months ago
Show doc for...
Tokens:
Raw
### macOS LaunchAgent Setup

Source: https://docs.duplicati.com/duplicati-programs/agent

Installs the Duplicati Agent as a macOS launchagent, which starts automatically on user login. The agent assumes a desktop context and opens the registration URL in the default browser. For pre-authenticated URLs, use the specified method and restart the service.

```bash
# The package registers a launchagent.
# Agent opens registration URL in the default browser.
# To use pre-authenticated URL: 
# Use method outlined above to register the machine,
# then restart the service to pick up updated agent.json.
```

--------------------------------

### Install Duplicati on Debian-based Linux (Ubuntu, Mint)

Source: https://docs.duplicati.com/getting-started/installation

Installs Duplicati on Debian-based Linux distributions using a .deb package. This command installs all necessary dependencies and places Duplicati in the default system location. Requires superuser privileges.

```sh
sudo dpkg -i duplicati-version-arch.deb
```

--------------------------------

### Install Duplicati on RedHat-based Linux (Fedora, SUSE)

Source: https://docs.duplicati.com/getting-started/installation

Installs Duplicati on RedHat-based Linux distributions using a .rpm package. This command installs all required dependencies and places Duplicati in the default system location. Requires superuser privileges.

```sh
sudo yum -i duplicati-version-arch.rpm
```

--------------------------------

### Starting Duplicati Server from Full Path on MacOS

Source: https://docs.duplicati.com/detailed-descriptions/using-duplicati-with-macos

This command invokes the Duplicati server executable using its full path, which is necessary when Duplicati's binaries are not automatically symlinked into the system's PATH, such as after installing the GUI package. It ensures the server starts correctly from its application directory.

```bash
/Applications/Duplicati.app/Contents/MacOS/duplicati-server
```

--------------------------------

### Starting Duplicati Server from CLI on MacOS

Source: https://docs.duplicati.com/detailed-descriptions/using-duplicati-with-macos

This command starts the Duplicati server when Duplicati binaries are symlinked into the system's PATH, typically after installation via CLI or Homebrew. It uses the default user's application support directory for configuration.

```bash
duplicati-server
```

--------------------------------

### Install Duplicati Windows Service

Source: https://docs.duplicati.com/duplicati-programs/service

Registers and installs the Duplicati executable as a Windows Service. Arguments passed to this command are forwarded to the Duplicati Server upon startup. The service is configured to automatically restart and start at login. This command will also start the service automatically on versions 2.1.1.0 and later.

```powershell
Duplicati.WindowsService.exe INSTALL [arguments ...]
```

--------------------------------

### Install Duplicati Windows Service with Options

Source: https://docs.duplicati.com/detailed-descriptions/using-duplicati-with-windows

This command installs the Duplicati Windows Service and allows passing configuration options like the web service port and the data folder path. This is useful for customizing the service's behavior during installation. Ensure the specified path for the data folder is valid.

```batch
C:\Program Files\Duplicati 2\Duplicati.WindowsService.exe INSTALL --webservice-port=8100 --server-datafolder=<path>
```

--------------------------------

### Duplicati ServerUtil: Managing Backups

Source: https://docs.duplicati.com/duplicati-programs/command-line-interface-cli-1/serverutil

Provides examples for managing backup configurations using the ServerUtil. This includes listing available backups, running a specific backup, exporting backup configurations (with optional encryption), and importing previously exported configurations.

```bash
duplicati-server-util list-backups
duplicati-server-util run <backup id or name>
duplicati-server-util export <backup id or name> --encryption-passphrase=<passphrase>
duplicati-server-util export <backup id or name> --export-passwords=true
duplicati-server-util import <filename> <passphrase>
```

--------------------------------

### Manage Duplicati Windows Service

Source: https://docs.duplicati.com/detailed-descriptions/using-duplicati-with-windows

These commands demonstrate how to install and uninstall Duplicati as a Windows Service using the bundled service tool. Installing the service will also start it, and uninstalling it will stop it. Options can be passed to the INSTALL command to configure the service.

```batch
C:\Program Files\Duplicati 2\Duplicati.WindowsService.exe INSTALL
C:\Program Files\Duplicati 2\Duplicati.WindowsService.exe UNINSTALL
```

--------------------------------

### Enable and Start Duplicati Agent Service

Source: https://docs.duplicati.com/detailed-descriptions/using-duplicati-with-linux

Commands to manually enable and start the Duplicati Agent service, typically used after a manual installation or when systemd registration is not automatic. These commands ensure the agent is ready to be registered.

```sh
sudo systemctl enable duplicati-agent.service
sudo systemctl start duplicati-agent.service 
```

--------------------------------

### Linux Bash Script: Example for run-script-before/after

Source: https://docs.duplicati.com/detailed-descriptions/scripts

This Linux bash script provides an example of how to use scripts with Duplicati's --run-script-before and --run-script-after options. It outlines the available options and explains the meaning of different exit codes (0, 1, 2) that Duplicati uses to determine whether to proceed with a backup operation after a script has run.

```bash
#!/bin/bash

###############################################################################
# How to run scripts before or after backups
###############################################################################

# Duplicati is able to run scripts before and after backups. This 
# functionality is available in the advanced options of any backup job (UI) or
# as option (CLI). The (advanced) options to run scripts are
# --run-script-before = <filename>
# --run-script-before-required = <filename>
# --run-script-timeout = <time>
# --run-script-after = <filename>
# --run-script-with-arguments = <boolean>
#
# --run-script-before-required = <filename>
# Duplicati will run the script before the backup job and wait for its 
# completion for 60 seconds (default timeout value). The backup will only be
# run if the script completes with an allowed exit code (0, 2, or 4). 
# A timeout or any other exit code will abort the backup.
# The following exit codes are supported:
#
# - 0: OK, run operation
# - 1: OK, don't run operation
# - 2: Warning, run operation

```

--------------------------------

### Invoke Duplicati ServerUtil Help

Source: https://docs.duplicati.com/detailed-descriptions/using-duplicati-with-windows

This command invokes the help function for the Duplicati ServerUtil, a support program included with Duplicati. It shows how to access the built-in help for specific utility executables. Similar to the main CLI, support programs can be invoked directly from their installation path.

```sh
C:\Program Files\Duplicati 2\Duplicati.CommandLine.ServerUtil.exe help
```

--------------------------------

### pCloud Destination Setup

Source: https://docs.duplicati.com/backup-destinations/provider-specific-destinations/pcloud-destination

Instructions for configuring the pCloud destination through the Duplicati user interface.

```APIDOC
## pCloud Destination Setup

To configure the pCloud destination, first select whether you are using the Global or EU servers. Then, specify a unique folder name for your backups. Finally, authorize Duplicati to access your pCloud account. Click the "AuthID" link to initiate the authentication process, and the "AuthID" will be populated upon completion.
```

--------------------------------

### Enable and Start Duplicati Service

Source: https://docs.duplicati.com/detailed-descriptions/using-duplicati-with-linux

Commands to enable the Duplicati service to auto-start, reload systemd configurations, start the service, and check its status. These commands are essential for ensuring Duplicati runs automatically on system boot.

```sh
sudo systemctl enable duplicati.service
sudo systemctl daemon-reload
sudo systemctl start duplicati.service  
sudo systemctl status duplicati.service
```

--------------------------------

### JSON Environment Variable Conflict Resolution Example

Source: https://docs.duplicati.com/detailed-descriptions/preload-settings

Demonstrates how Duplicati merges environment variables from different sources ('*' and specific executables like 'tray'). It shows the resulting effective configuration for a given executable by prioritizing and combining values.

```json
"env": {
  "*": {
    "E1": "a",
    "E2": "b"
  },
  "tray": {
    "E1": "c",
    "E3": "d"
  }
}
```

```json
"env": {
  "*": {
    "E3": "f"
  },
  "tray": {
    "E1": "g"
  }
}
```

--------------------------------

### Locate Duplicati TrayIcon Executable

Source: https://docs.duplicati.com/detailed-descriptions/using-duplicati-with-windows

This code snippet shows the default path to the Duplicati GUI TrayIcon executable on a Windows system. It is used for manually starting the application when not installed as a service. The application stores its databases and configurations in the user's local AppData folder.

```batch
C:\Program Files\Duplicati 2\Duplicati.GUI.TrayIcon.exe
```

--------------------------------

### Run Duplicati Tray Icon using .NET

Source: https://docs.duplicati.com/installation-details/developer

This command demonstrates how to run the Duplicati Tray Icon application after building the source code. It requires the .NET runtime to be installed and uses the `dotnet run` command with the specific project file.

```bash
dotnet run Executables/net8/Duplicati.GUI.TrayIcon/Duplicati.GUI.TrayIcon.csproj
```

--------------------------------

### Windows Service Installation and Uninstallation

Source: https://docs.duplicati.com/duplicati-programs/agent

Installs or uninstalls the Duplicati Agent as a Windows service. Use INSTALL-AGENT with options to install, and UNINSTALL-AGENT to remove. The agent will log a registration URL to the Windows Event Log, as it cannot open a browser from the service context.

```bash
Duplicati.WindowsService.exe INSTALL-AGENT <options>
Duplicati.WindowsService.exe UNINSTALL-AGENT
```

--------------------------------

### Prevent Automatic Start of Duplicati Windows Service

Source: https://docs.duplicati.com/duplicati-programs/service

Installs the Duplicati executable as a Windows Service without automatically starting it after installation. This is useful for custom startup configurations or when managing service startup manually. Arguments passed to this command are forwarded to the Duplicati Server upon startup.

```powershell
Duplicati.WindowsService.exe INSTALL-ONLY [arguments ...]
```

--------------------------------

### Duplicati ServerUtil: Handling Login and Authentication

Source: https://docs.duplicati.com/duplicati-programs/command-line-interface-cli-1/serverutil

Demonstrates how to use the ServerUtil to authenticate with a Duplicati Server. This includes obtaining credentials from the server database, providing explicit login details, storing refresh tokens for future use, and revoking them.

```bash
duplicati-server-util login --server-datafolder=<database folder path>
duplicati-server-util login --password=<password> --hosturl=<hosturl>
duplicati-server-util logout --hosturl=<hosturl>
```

--------------------------------

### Invoke Duplicati CLI Help

Source: https://docs.duplicati.com/detailed-descriptions/using-duplicati-with-windows

This command invokes the help function for the Duplicati Command Line Interface (CLI). It demonstrates how to run the CLI executable and access its built-in documentation. The CLI uses a local database and a `dbconfig.json` file for mapping URLs to databases, unless `--dbpath` is explicitly specified.

```sh
C:\Program Files\Duplicati 2\Duplicati.CommandLine.exe help
```

--------------------------------

### Modifying Duplicati Options from Scripts (Bash Example)

Source: https://docs.duplicati.com/detailed-descriptions/scripts

Shows how scripts can change Duplicati's behavior by writing options to standard output. Lines not starting with '--' are ignored. This allows dynamic modification of settings like filters or remote URLs.

```bash
# Example: Changing the filter and adding a new one
echo "--filter=+*.log"
echo "--filter=-*.tmp"

# Example: Changing the remote URL
echo "--remoteurl=\"s3://my-bucket/backups\""
```

--------------------------------

### Invoke Duplicati ServerUtil Help

Source: https://docs.duplicati.com/detailed-descriptions/using-duplicati-with-linux

Command to display the help information for the Duplicati ServerUtil utility. This utility is part of the support programs included with Duplicati.

```sh
duplicati-server-util help
```

--------------------------------

### Duplicati Agent Preload Configuration

Source: https://docs.duplicati.com/detailed-descriptions/using-remote-management/using-remote-control-with-agent

This JSON configuration snippet shows how to set the registration URL for the Duplicati Agent within a `preload.json` file. This method is useful for simplifying agent setup in large-scale deployments by distributing the configuration file before installation.

```json
{
  "args": {
    "agent": [ "--registration-url=<copied-url>" ]
  }
}
```

--------------------------------

### Clone and Build Duplicati from Source

Source: https://docs.duplicati.com/installation-details/developer

This snippet shows how to clone the Duplicati repository from GitHub and build the solution using the .NET CLI. It is the first step for any developer wanting to work with Duplicati's source code.

```bash
git clone https://github.com/duplicati/duplicati
dotnet build Duplicati.sln
```

--------------------------------

### Download Duplicati Installer Package

Source: https://docs.duplicati.com/duplicati-programs/command-line-interface-cli-1/autoupdater

This command downloads the most recent installer package for the currently installed Duplicati package. It determines the package type and downloads it to the current directory. This feature requires the installed package to be determinable and an updated package to be available.

```bash
duplicati-autoupdater download
```

--------------------------------

### Duplicati CLI Help Command Usage

Source: https://docs.duplicati.com/duplicati-programs/command-line-interface-cli

Demonstrates how to use the 'help' command within the Duplicati CLI to access documentation for various topics, including general information, commands, repair utilities, debug options, storage targets, modules, formats, advanced settings, and secret providers.

```bash
duplicati-cli help <topic>
```

--------------------------------

### Accessing Duplicati Options in Scripts (Bash Example)

Source: https://docs.duplicati.com/detailed-descriptions/scripts

Demonstrates how to access Duplicati options as environment variables within a bash script. Options with dashes are converted to underscores and prefixed with DUPLICATI__. For example, --encryption-module becomes $DUPLICATI__encryption_module.

```bash
EVENTNAME=$DUPLICATI__EVENTNAME
OPERATIONNAME=$DUPLICATI__OPERATIONNAME
REMOTEURL=$DUPLICATI__REMOTEURL
LOCALPATH=$DUPLICATI__LOCALPATH

echo "Event: $EVENTNAME"
echo "Operation: $OPERATIONNAME"
echo "Remote URL: $REMOTEURL"
echo "Local Path: $LOCALPATH"
```

--------------------------------

### Duplicati Filter Order Example

Source: https://docs.duplicati.com/detailed-descriptions/filters-in-duplicati

Demonstrates how the order of include and exclude filters affects backup content. Files are processed based on the first full match, with folders evaluated before files. This example shows how to include specific .txt and .bin files while excluding others.

```text
+/usr/share/*.txt
-*.txt
-*.bin
+/usr/share/*.bin
```

--------------------------------

### Example Template for JSON Output

Source: https://docs.duplicati.com/detailed-descriptions/sending-reports-via-email/custom-message-content

This example demonstrates a template for Duplicati's JSON output. Unlike text-based templates, the JSON template acts as a lookup to determine which keys to include in the 'extra' element of the JSON result, ensuring valid JSON structure.

```text
%OPERATIONNAME% 
%backup-name% 
%machine-name% 
%PARSEDRESULT% 
%LOCALPATH%
%ENCRYPTION-MODULE%
%COMPRESSION-MODULE%
```

--------------------------------

### Duplicati: Run Scripts Before/After Backups (Windows Batch)

Source: https://docs.duplicati.com/detailed-descriptions/scripts

Example Batch script demonstrating how to run scripts before or after Duplicati backups. It outlines the relevant command-line options and explains the behavior of --run-script-before-required and --run-script-before, including exit code handling and timeouts.

```batch
@echo off

REM ###############################################################################
REM How to run scripts before or after backups
REM ###############################################################################

REM Duplicati is able to run scripts before and after backups. This 
REM functionality is available in the advanced options of any backup job (UI) or
REM as option (CLI). The (advanced) options to run scripts are
REM --run-script-before = <filename>
REM --run-script-before-required = <filename>
REM --run-script-timeout = <time>
REM --run-script-after = <filename>
REM --run-script-with-arguments = <boolean>
REM
REM --run-script-before-required = <filename>
REM Duplicati will run the script before the backup job and wait for its 
REM completion for 60 seconds (default timeout value). The backup will only be
REM run if the script completes with an allowed exit code (0, 2, or 4). 
REM A timeout or any other exit code will abort the backup.
REM The following exit codes are supported:
REM
REM - 0: OK, run operation
REM - 1: OK, don't run operation
REM - 2: Warning, run operation
REM - 3: Warning, don't run operation
REM - 4: Error, run operation
REM - 5: Error don't run operation
REM - other: Error don't run operation
REM
REM --run-script-before = <filename>
REM Duplicati will run the script before the backup job and waits for its 
REM completion for 60 seconds (default timeout value). After a timeout a 
REM warning is logged and the backup is started.
REM Any other exit code than 0 will be logged as a warning.
REM
REM --run-script-timeout = <time>
REM Specify a new value for the timeout. Default is 60s. Accepted values are
REM e.g. 30s, 1m15s, 1h12m03s, and so on. To turn off the timeout set the value 
REM to 0. Duplicati will then wait endlessly for the script to finish.
REM
REM --run-script-after = <filename>
REM Duplicati will run the script after the backup job and wait for its 
REM completion for 60 seconds (default timeout value). After a timeout a 
REM warning is logged.
REM The same exit codes as in --run-script-before are supported, but
REM the operation will always continue (i.e. 1 => 0, 3 => 2, 5 => 4)
REM as it has already completed so stopping it during stop is useless.
REM
REM --run-script-with-arguments = <boolean>
REM If set to true, the script path will be parsed as a command line, and the
REM arguments will be passed to the script. If set to false (default), 
REM the script path will used as a single path.
REM If you do not have spaces in your script path or arguments, simply enter 
REM it as a string:
REM Example: --run-script-before="C:\path\to\script.bat arg1 arg2 --option1=a"
REM If you have spaces in the path or arguements, use double- or single-quotes
REM around the elements that have spaces, similar to how you would do 
REM on the command line:
REM Example: --run-script-before="\"C:\path to\script.bat\" \"arg1 \" arg2"


REM ###############################################################################
REM Changing options from within the script 
REM ###############################################################################

REM Within a script, all Duplicati options are exposed as environment variables
REM with the prefix "DUPLICATI__". Please notice that the dash (-) character is
REM not allowed in environment variable keys, so it is replaced with underscore
REM (_). For a list of available options, have a look at the output of
REM "duplicati.commandline.exe help".
REM
REM For instance the current value of the option --encryption-module can be 
REM accessed in the script by
REM ENCRYPTIONMODULE=%DUPLICATI__encryption_module%

REM All Duplicati options can be changed by the script by writing options to
REM stdout (with echo or similar). Anything not starting with a double dash (--)
REM will be ignored:
REM echo "Hello! -- test, this line is ignored"
REM echo --new-option=This will be a setting

REM Filters are supplied in the DUPLICATI__FILTER variable.
REM The variable contains all filters supplied with --include and --exclude,
REM combined into a single string, separated with semicolon (;).
REM Filters set with --include will be prefixed with a plus (+),
REM and filters set with --exclude will be prefixed with a minus (-).
REM
REM Example:
REM     --include=*.txt --exclude=[.*\.abc] --include=*
REM 
REM Will be encoded as:
REM     DUPLICATI__FILTER=+*.txt;-[.*\.abc];+*
REM
REM You can set the filters by writing --filter=<new filter> to stdout.
REM You may want to append to the existing filter like this:
REM     echo "--filter=+*.123;%DUPLICATI__FILTER%;-*.xyz"


REM ###############################################################################
REM Special Environment Variables
REM ###############################################################################

REM DUPLICATI__EVENTNAME
REM Eventname is BEFORE if invoked as --run-script-before, and AFTER if 

```

--------------------------------

### Example Custom Template for Email Body/Subject

Source: https://docs.duplicati.com/detailed-descriptions/sending-reports-via-email/custom-message-content

This is an example of a custom template that can be used for Duplicati's email subject or body. It utilizes environment placeholders to dynamically insert backup information. The template engine supports reporting any setting by using the setting name as the template value.

```text
Duplicati %OPERATIONNAME% for %backup-name% on %machine-name%

The %OPERATIONNAME% operation has completed with the result: %PARSEDRESULT%

Source folders: 
%LOCALPATH%

Encryption module: %ENCRYPTION-MODULE%
Compression module: %COMPRESSION-MODULE%

%RESULT%
```

--------------------------------

### Run Duplicati Unit Tests using .NET

Source: https://docs.duplicati.com/installation-details/developer

This command shows how to execute all unit tests for the Duplicati solution using the .NET CLI. This is a crucial step for verifying code changes and ensuring the stability of the application.

```bash
dotnet test Duplicati.sln
```

--------------------------------

### Duplicati CLI Command Structure

Source: https://docs.duplicati.com/duplicati-programs/command-line-interface-cli

This outlines the basic structure for all commands executed via the Duplicati CLI. It includes the command, the remote URL for storage, and optional arguments and settings. The '--dbpath' option is often required to specify the local database location.

```bash
duplicati-cli <command> <remote url> [arguments and options]
```

--------------------------------

### Register Duplicati Agent with Pre-Authenticated Link

Source: https://docs.duplicati.com/detailed-descriptions/using-duplicati-with-linux

Command to register the Duplicati Agent using a pre-authorized URL. This is a key step after starting the agent service, allowing it to connect to the Duplicati Console.

```sh
duplicati-agent register "<pre-authorized url>"
```

--------------------------------

### Combine Server and TrayIcon with Duplicati Arguments

Source: https://docs.duplicati.com/detailed-descriptions/choosing-duplicati-type

This configuration allows the TrayIcon to connect to an already running Server instance, often used when the Server primarily handles privilege elevation. It disables the TrayIcon from hosting its own server and specifies the URL and password for the existing Server. This requires the `--no-hosted-server`, `--hosturl`, and `--webservice-password` arguments.

```bash
duplicati --no-hosted-server \
  --hosturl=http://localhost:8200 \
  --webservice-password=<password>
```

--------------------------------

### Duplicati Pre-Operation Script Execution

Source: https://docs.duplicati.com/detailed-descriptions/scripts

Execute a custom script before a Duplicati operation begins. The operation will wait for the script to finish or time out. This is useful for setup tasks. The script path is provided as an argument.

```bash
--run-script-before "/path/to/your/script.sh"
```

--------------------------------

### Duplicati Folder Exclusion Example

Source: https://docs.duplicati.com/detailed-descriptions/filters-in-duplicati

Illustrates how to exclude an entire folder in Duplicati, overriding any subsequent include rules for its contents. Appending a folder exclusion rule ensures that the folder and its subdirectories are not processed, saving time.

```text
-/usr/share/
```
Tokens:
Raw