Using The Graphical User Interface
Using The Graphical User Interface
After a standard installation, the web interface can be started by a click on the
tray icon:
Duplicati is inactive.
If you don't use the tray icon (for example if you disabled Launch Duplicati at
startup in the installation wizard), or if you want to call another Duplicati instance
than the default one, open your web browser and enter the URL and port number
in the address bar in your browser.
Pay special attention to this message. Everyone who has access to your
computer (or even another computer in your network), could potentionally have
access to your personal files by using the Duplicati Web interface. If Duplicati is
installed as a service, even personal files from all users on the computer could
be accessible.
In the Settings page, which is displayed, you can set a password to the interface
and optionally allow remote access to the webserver. If you grant remote access,
note that you also need to open the appropriate TCP port in your firewall.
Click the OK button to save your changes. After supplying a password, you are
logged out from the web interface and need to re-logon with your new password.
The Duplicati main window is displayed. The responsive design makes Duplicati
easy to use on screens of all sizes, including mobile devices.
In this layout, a click on the Menu icon shows the main menu:
At the top of the page, you see the header, which consists of the Duplicati logo,
the status bar, a pause button, a throttle button and some donation buttons.
If your initial Duplicati installation was a Beta version, The default Update
Channel will be Beta. This can be changed in the Settings page.
The Status Bar shows information about the currently running Backup or Restore
job. If no operation is active, the next scheduled backup job is showed here. If
there are no scheduled backup jobs, the Status Bar shows "No scheduled tasks".
The Pause and Throttle buttons can be used for keeping control over the
bandwidth used by Duplicati.
With the Pause button you can temporarily stop Duplicati uploading and
downloading any file from and to the backend. With the Throttle button you can
limit the bandwidth Duplicati uses by specifying a maximum upload and
download speed.
You can use these buttons to donate using PayPal or Bitcoin. Displaying these
buttons can be disabled in the Settings menu.
The main menu can be found at the left side on high resolution screens or under
the Menu button in the upper right corner when using a lower resolution, for
example on mobile devices.
Restore files from an already configured backup job or directly from the
backend or from an imported configuration file.
Change general program settings and define default settings for all backup
jobs.
Show the Duplicati log files and view events in real time.
Logs out from the Duplicati Graphical User Interface. This item is omitted i
no password is set to the User Interface.
Losing your encryption key will render your backup files useless and makes
restore operations impossible. Always store your encryption key in a safe place,
separated from your backup files and not on your computer that contains the
Duplicati source files.
Enter a descriptive name, Select the encryption type and specify a strong
encryption key. Duplicati gives an indication of the strengthness of the key you
entered. Optionally Duplicati can generate a strong encryption key for you.
If all required fields are filled in, you can optionally click the Test
connection button. Duplicati will try to connect to the backend using the provided
information. If Duplicati can connect to the backend, but the specified folder does
not exist, Duplicati can create it for you.
In step 3 you can select the files and folders you want to include in the backup.
This can be done by selecting files and folders in the file picker. Only local files
and folders can be selected using the file picker. If you want to include shared
folders in your local network, you have to specify the path in the text box beneath
the file picker.
There's a small button in the upper right corner of the file picker:
Clicking it gives access to the advanced editor. In the advanced editor you can
enter the files and folders you want to include in your backup instead of browsing
to them.
You can review your selections under Source data in the file picker.
Under Filters you can specify what you want to be excluded from the backup. If
you deselected one or more files or folders in the file picker (marked with a red
cross), they show up in the list under Filters. You can specify more exclusions
based on file- or folder name, specific files or folders or even using a Regular
Expression.
There are default exclusion lists for Windows, Linux and OS X. Selecting the
appropriate operating system excludes all files and folders that are known to be
unneeded or impossible to be backed up (like temporary files, the paging file or
the hibernation file). For Filters an advanced editor is available too using the
button in the upper right corner.
Another way to avoid unneeded files to be backed up, is excluding files with a
specific attribute or files that exceed a predefined file size. Select what you want
to exclude under the Exclude item. Click Next for Step 4.
If a backup job misses the defined schedule, for example if the computer is
powered off, the backup job will start as soon as possible after the specified time.
Click next to proceed to the final step.
In step 5 you can set the Upload Volume size and how many backups should be
available for restore operations.
The Upload volume size is not the maximum capacity that is offered by your
storage provider. It is the size of each chunk of data that is uploaded to the
backend during a backup operation. Increasing the size of an upload volume will
reduce the number of files at the backend, but will require to download more data
when performing restore operations. See Choosing sizes in Duplicati for more
information about block- and volume sizes.
Unlimited:
Backups will never be deleted. This is the most safe option, but remote
storage capacity will keep increasing.
Until they are older than:
Backups older than a specified number of days, weeks, months or years will
be deleted.
A specific number:
The specified number of backup versions will be kept, all older backups will
be deleted.
When importing a backup job from a configuration file, a new database will be
created, using a random filename. If the configuration file contains the name of a
local database, this name will be ignored. This will prevent problems caused by
multiple backup jobs using the same local database.
If you want to re-use an existing database, open the backup configuration’s
Database menu after the job is imported. Enter the path and filename of the
existing local database in the Local database path field.
If it is a scheduled backup, just wait for the next scheduled time. The backup
will start automatically.
Click Run now, just under the backup name.
Click on the backup name. Then click Run now under Operations.
The first time a backup is executed, all data has to be divided into blocks,
compressed, packaged into archive files, encrypted and uploaded to the
backend. This can take a long time, depending on the amount of source data to
be processed, the system performance and the network bandwidth to the
backend. After the initial (full) backup, only new and changed data will be
processed and uploaded, making successive backups much faster.
You can follow the progress in the progress bar, where the number of files and
the amount of data to be processed will be showed. Also the current upload
speed is displayed.
After all files have been processed, some additional operations are performed.
If there are files still uploading in the background, Duplicati will wait for them to
complete.
After all files are uploaded, Duplicati will randomly choose a few upload volumes
from the backend, download them and view if the contents are what Duplicati
expects it to be.
After the backup has finished, the status bar will show when the next backup will
run, if at least one backup job is scheduled.
If there were any warnings or errors during the backup, they will be displayed in
the bottom of the main screen, including a links to the log files and a button to
dismiss the alert.
After the first backup is completed, the Duplicati main screen will display some
additional information about the backup:
Restoring files from a backup¶
If you want to restore one or more files from a backup, you can start the restore
wizard:
By clicking the backup name and click Restore files ? under Operations.
By clicking Restore in the main menu, select the backup you want to restore
from and clicking Next.
The Restore wizard consists of two steps. In step 1 you can specify what you
want to restore and from which restore point you want to restore these files. In
step 2 you can choose to what location you want to restore the files and supply
some options for the restore operation.
In the first step, select the restore point from which you want to restore some files
by selecting a date and time behind Restore from. Each restore point will list all
files and folders included in the backup exactly as they were at the listed
timestamp.
In the file browser, select all files and folders you want to restore. Selections will
be marked with a green check mark. Clicking a folder will select that folder and
all underlying files and folders. You can exclude files and folders inside a
selected folder, by clicking them. The preceding check marks will be removed
from the clicked objects. Folders that are partially selected are marked with a
green square.
You can find files easily by typing a part of the filename in the Search for files text
box. Filenames containing your search query will be highlighted in the file
browser.
Highlighting does not actually select the files you type in. Only files with a
green check mark will be restored.
If you have selected all files and folders you want to restore, click Continue to
proceed to step 2.
The second step allows you to specify a location to restore the selected files to.
Choose Original location to restore the files to their original location.
Choosing Pick location allows you to select an alternative location to restore your
files to. You can do this by typing the folder path or selecting the root folder with
the Browse button.
If you chose to restore to the original location, you can specify what Duplicati
should do with files that already exist: overwrite them or restore to a new file with
a timestamp in the file name.
You can also restore file access permissions. This is disabled by default,
because doing this might prevent access to the files that you just restored.
Clicking the Restore button will start the actual restore operation. The backup
operation starts with scanning local files for blocks that are already available.
This can reduce the amount of downloaded data from the backend significantly.
Next part of the restore process is downloading the required upload volumes
from the backend for assembling the selected files and folders to restore.
After the operation has been completed, Duplicati will notify you and encourage
you to make a donation. The donation information can be disabled in
the Settings menu. Warnings or errors, if any, will be showed in the bottom part
of the Duplicati main screen. Click OK to return to the main screen.
Restoring files if your Duplicati installation is lost¶
If you want to restore your files without being able to use your Duplicati
installation (for example on another computer, or after a system crash), you have
to restore your files directly from the backup destination.
If Duplicati isn't installed on the computer you want to restore to, download and
install Duplicati first. See Installation for more information.
To start a restore operation without a configured backup job, click Restore in the
main menu. You have 2 options:
If you have exported the backup configuration earlier to a file and still have
access to this file, you can import it and start restoring. This is the easiest
option.
If you don't have an exported configuration file, you need to know the
backend URL, credentials and the backup passphrase. Once entered all
needed information, you can start restoring your files.
If you don't have a configuration file, you have to supply all needed information
yourself. Select Direct restore from backup files ... and click Next.
In Step 1 (Backup location), you have to select the correct Storage Type and fill
in the required information to connect to the remote storage.
Click the Test connection button to verify if the connection works. You should get
a message indicating that the connection works.
Optionally, supply one or more advanced options for the selected backend. Click
next to proceed to step 2.
In step 2 (Encryption), specify the backup passphrase and optionally supply one
or more advanced options.
Click the Connect button to retrieve backup information from the backend.
Browse to the location where the configuration file is stored. If this file was
encrypted during the export, enter the passphrase in the text field. Click Import to
continue.
The restore wizard is showed. In step 1 (Backup location) all information to
connect to the remote storage is filled in with the information from the
configuration file. Click the Test connection button to check if the connection
works.
Duplicati connects to the remote storage and retrieves a list of available backups.
After the Fetching path information task has been completed, the restore process
is exactly the same as described in Restoring files from a backup.
Editing an existing backup¶
Sometimes changes need to be made to a backup configuration. If you create a
new folder and want to add this folder as a backup source in your configuration,
you have to edit the backup job. Other examples are changed credentials for the
backend, defining another schedule and set or change some advanced options
for your backup job.
To modify a backup job configuration, click the name of the backup job and
click Edit ... under Configuration.
You return to the same wizard that was shown when adding the backup. The
difference is that all 5 steps are already filled in with the settings you chose in the
Add backup wizard.
You can walk through the wizard by optionally change some settings and
click Next until you reach the last step of the wizard. You can also click the
number of the step you want to edit in the selector at the top.
Many settings can be modified, but some settings cannot be changed after
the initial backup is made. For obvious reasons, the passphrase and the block
size need to stay the same once the initial backup is completed.
Adding or modifying advanced options may have unwanted effects. Never
modify settings in a backup configuration, unless you are sure what the
consequences of the change are.
As Command-line
If you don't want to use the Graphical User Interface to manage your backups
and/or you want to use another task scheduler instead of the scheduler that
is integrated in Duplicati, you can use the Command-line export to generate a
command that you can use to perform the current backup job with
the Duplicati.CommandLine.exe tool.
To File
When exporting to a file, a standard JSON file is generated that contains all
settings of the selected backup job configuration. This file can be used later
for importing in a new Duplicati installation if your computer is lost because of
a disaster.
Losing the passphrase will make the configuration file useless. Without the
passphrase it is impossible to extract information from the configuration file.
Store the passphrase in a safe place.
Never store the configuration file and, if applicable, the passphrase on the
computer running Duplicati. It is likely that you need them when your computer is
lost. Be sure to keep access to file and passphrase if you can't use your
computer anymore.
The contents of the file (in unencrypted form) could look something like this:
{
"CreatedByVersion": "2.0.2.12",
"Schedule": null,
"Backup": {
"ID": "1",
"Name": "Pictures Collection",
"Tags": [],
"TargetURL": "ftp://myftpserver.com/Backup/Pictures?auth-username=Duplicati&auth-password=backup",
"DBPath": "C:\\Users\\User\\DuplicatiCanary\\data\\NTWRLRVPKH.sqlite",
"Sources": [
"%MY_PICTURES%"
],
"Settings": [
{
"Filter": "",
"Name": "encryption-module",
"Value": "aes",
"Argument": null
},
{
"Filter": "",
"Name": "compression-module",
"Value": "zip",
"Argument": null
},
{
"Filter": "",
"Name": "dblock-size",
"Value": "50mb",
"Argument": null
},
{
"Filter": "",
"Name": "keep-time",
"Value": "3M",
"Argument": null
},
{
"Filter": "",
"Name": "passphrase",
"Value": "%@/%78kUPKlZtz",
"Argument": null
},
{
"Filter": "",
"Name": "--skip-files-larger-than",
"Value": "2GB",
"Argument": null
},
{
"Filter": "",
"Name": "--default-filters",
"Value": "Windows",
"Argument": null
},
{
"Filter": "",
"Name": "--exclude-files-attributes",
"Value": "temporary",
"Argument": null
}
],
"Filters": [
{
"Order": 0,
"Include": false,
"Expression": "desktop.ini"
}
],
"Metadata": {
"LastDuration": "00:00:05.3465555",
"LastStarted": "20171030T171703Z",
"LastFinished": "20171030T171708Z",
"LastBackupDate": "20171030T163454Z",
"BackupListCount": "4",
"TotalQuotaSpace": "0",
"FreeQuotaSpace": "0",
"AssignedQuotaSpace": "-1",
"TargetFilesSize": "454306034",
"TargetFilesCount": "26",
"TargetSizeString": "433.26 MB",
"SourceFilesSize": "216463728",
"SourceFilesCount": "79",
"SourceSizeString": "206.44 MB",
"LastBackupStarted": "20171030T163547Z",
"LastBackupFinished": "20171030T163549Z"
},
"IsTemporary": false
},
"DisplayNames": {
"%MY_PICTURES%": "My Pictures"
}
}
If you no longer need the backup files themselves, Duplicati can delete these
files from the backend, freeing up remote storage space.
This is an irreversible process. If your storage provider does not support
previous versions or something similar, restoring files from this backup set will be
impossible.
If you really want to delete the backup files also, click to select Delete remote
files.
You can start the deletion with the Delete backup button. If you chose to delete
the remote files, you first have to fill in a captcha for security reasons.
Database management¶
Duplicati makes use of a local database for each backup job that contains
information about what is stored at the backend. Main reasons for storing this
information locally are performance and reduction of bandwidth usage. Without
this database, Duplicati would need to download a fair amount of data from the
backend for any operation.
If you want to rebuild the database immediately, you can click the Recreate
button, which will also delete the database, but starts the rebuild process
immediately.
If you want to make changes to the location where the local database is stored,
you can use the Reset, Save, Save and repair and Move existing database
buttons.
First type in a new path and/or filename. Clicking Reset will undo changes you
made to the Local database path. Save will store the new database location (you
have to copy it manually to that location). Save and repair will do the same, but
additionally initiate a repair operation on the database. Move existing database
will move the database from the current location to the location specified in the
Local database path text field.
If any errors or warnings occur, they will be displayed in a popup at the bottom of
the Duplicati screen.
Upload volumes (files at the backend) likely contain blocks that do belong to old
backups only, as well as blocks that are used by newer backups. Because the
contents of these volumes are partly needed, they cannot be deleted, resulting in
unnecessary allocated storage capacity.
Compacting can result in a lot of small volumes at the backend. If enough small
files exist that can be combined to one or more volumes of the defined volume
size (default 50 MB), these small volumes are downloaded, repackaged and
uploaded to the backend, replacing these small files.
The compacting procedure is triggered after each backup, but can be disabled
with an advanced option. If you want to perform a compacting operation
manually, click on the backup name and click Compact now under Advanced.
Depending on the amount of obsolete data, this can take some time. If no
unused blocks are found, the task stops almost instantly.
Using the Command line tools from within the Graphical
User Interface¶
Some tasks you can perform from the command line are not yet implemented in
the Graphical user interface, for example retrieving a list of backed up files,
deleting one or more backups, purging files from all backup sets or comparing 2
backups and listing the differences.
If you want to use the command line tools, some basic knowledge of how
these tools work is required. Improper use of the Commandline tools may
damage or delete your backup files.
In the Command section, you can choose which command line tool you actually
want to use. You can choose from send-mail, systeminfo, vacuum, affected, test-
filters, verify, test, compare, create-report, compact, purge-broken-files, list-
broken-files, purge, repair, restore, backup, delete, list, find, examples and help.
The Target URL section is already filled in with the URL and credentials that are
used by the currently selected backup job. If you want to make changes to it, you
can type them in the text box or click the Target URL link.
Most command line tools need one or more commandline arguments. For
example, if you want to delete a specific backup, you have to supply a version
number to the Delete command. The default value for this field are the source
folders selected for backup, but in most situations you have to change this.
All other options that are set for the current backup job are listed
under Advanced options. Options that do not affect the current backup command
can be ignored. Conflicting options in the list can be deleted by clicking the blue
X at the right side of each advanced option. The Edit as text link lists all
advanced options in a text box, making it easy to delete or modify multiple
options.
Example 1: Retrieving a list of all files that can be restored from the latest
backup.
You need the FIND command to list files in a particular backup. The FIND
command expects a file mask to filter the list of found files as an argument. If you
want a complete list, replace the contents of the Commandline arguments text
box with an asterisk (*). Keep the Target URL unchanged. The upper part of the
Commandline screen should look something like this:
Click the Run "find" command now button. The results are listed in the Duplicati
main screen.
Example 2: Find the differences between 2 backups.
The --verbose option will list all new, modified and deleted files and folders. Without
this options, only the totals and the first 10 files will be listed. The results (without
the --verbose option) looks like this:
Viewing the log files of a backup job¶
You can view all messages and results related to backup job operations . To
view these log entries, click the backup name and click Show
log ... under Reporting.
The log data for the selected backup job is displayed. You can choose to view
the general events or the events that are specific to backend operations, by
clicking the General or Remote button.
When completed, a message is displayed and you can download the generated
report.
Click the Download button and send the report to the Duplicati development team
for further investigation.
Settings in Duplicati¶
In the Settings menu you can specify different types of settings. In the first place
there are some general program settings. These settings influence the look and
feel of the user interface and determine the way that the software is started and
updated.
Additionally you can define a list of default settings that apply to all backup jobs
that don't have explicitly defined that settings.
Access to user interface
When using the tray-icon, the web interface opens without asking for a password,
even is a password is set. If this is not desirable, selecting this checkbox enables
asking for a password when clicking the tray icon to access the web interface.
If you are using a firewall, don't forget to make an access rule to allow
incoming traffic using the port the Duplicati server listens on (default port is TCP
port 8200).
You can set a delay for Duplicati to become active after startup or hibernation.
When Duplicati is started, no tasks will be performed until the specified time has
elapsed.
With the User Interface settings you can change the interface language and
choose a color scheme.
You can disable donation messages, for example if you already made a
donation. Toggle donation messages by clicking on the link.
You can set the level of reports to be sent (Information, Warning, Error or None).
Setting this to None will disable reporting usage statistics at all.
In the Settings screen, you can generate a list of advanced options. These
options will be applied to all backup jobs, unless the same options with another
value are specified in a particular backup job configuration. This avoids having to
set the same settings for each backup job you create. For example, if you want to
send an email after each backup operation, you can set this, including mail
server settings and credentials, in the Default options list.
If you want to see what is happening in the background in real time, click
the Live button. This is disabled by default to preserve system resources.
Choose one of the levels Error, Warning, Information or Profiling. Error will only
display events indicating that something goes wrong, Profiling lists about every
single event that occurs. Clicking on an event also reveals detailed information
about that event.
General will show information about Duplicati and the version you work with. You
can check for updates using the Check for updates now link in this overview. If a
new version for your update channel is available, a message will be displayed
with the new version number. Use the Download and Activate buttons to update
your Duplicati installation to the latest version.
The Libraries button shows all third party components that were used in the
Duplicati software package, including a link to the website and a link to licensing
information for that component.
Updating Duplicati¶
Duplicati checks for new updates regularly. When a new update in your update
channel is available, Duplicati will notify you about this update by displaying a
message at the bottom of the main screen. You can check for updates
immediately by clicking Check for updates now in the General overview of
the About screen.