This repository is a collection of helper scripts, simplifying the interface of duplicati, making it reusable, easy to configure and ready for cron deployment. This collection of scripts is intended for administrators, solely relying on the command line interface on Linux machines, missing the possibility to automated run backup jobs in the background as well as searching for a simple overview over the backup status of their machines.
Disclaimer: This project is developed independent from duplicati and is intended to be used with duplicati v.2 Beta. I am only testing these helpers with Amazon Cloud Drive, other providers should work as well, however you might need to modify the script slightly.
You can use the installation script provided, to install mono, duplicati and the duplicati helper scripts, as well as configure everything.
DISCLAIMER: I only tested this under Debian 7 and 8.
The following command will download and execute the install script that will do all the work for you: wget https://raw.githubusercontent.com/steilerDev/duplicati_helper/master/install.sh && chmod +x install.sh && ./install.sh && rm install.sh
In case the automatic installation does not work, or you don't trust my script, first install mono and duplicati according to the provided docs. My script should work within any shell. Currently the quiet mode only works if you have gdb installed.
- Clone the repository (suggested location:
/opt/duplicati_helper/) - Link binary:
ln -s /opt/duplicati_helper/duplicati /bin/duplicati
- If you want to use the
quietworkaround you need to installgdband mono needs to have version 4.3.2.467, 4.4.x, or higher
- In case you want a shutdown delayed by running duplicati jobs, do the following:
mv /sbin/shutdown /sbin/shutdown-binln -s /opt/duplicati_helper/shutdown- Make sure the access rights to
/opt/duplicati_helper/shutdownmatch/sbin/shutdown-bin
- In order to show the backup status during log-in on the console, include
source /opt/duplicati_helper/duplicatircin your~/.bashrc(or similiar depending on your bash) - In case your system supports bash autocompletion and you want to use this feature for the duplicati script link the provided script to the auto completion directory:
ln -s /opt/duplicati_helper/duplicati_completion /etc/bash_completion.d/(NOTE: Check if the linking was successfull using. /etc/bash_completion. You might be prompted an error, saying that there are to many levels of linkage. Just remove the link and re-link it again, this fixed it on my systems) - Configure your general duplicati settings based on the provided example in
/opt/duplicati_helper/duplicati.conf.example - Configure your backups based on the provided example in
/opt/duplicati_helper/backup.conf.example - In order for the helper scripts to use your
duplicati.conffile, you either need to move it to/opt/duplicati_helper/duplicati.conf, or you need to modify the second line (source /opt/duplicati_helper/duplicati.conf) ofduplicatirc,duplicati,duplicati_completionandshutdown, pointing to your configuration path.
This repository contains different components, that can be used indipendent of each other. However I recommend to use all of them, in order to get the full experience.
This script is simplifying the interface to duplicati, by introducing a configuartion file based execution of the backups. An up-to-date information about the functionality and the currently configured backups within your instance can be found by executing duplicati help. The following table will show the current functionalities:
| Command | Functionality |
|---|---|
duplicati help |
Shows a full list of available commands and configured backups. |
| `duplicati {backup | repair} <backup_config_name>` |
duplicati kill <backup_config_name> |
Kills a running backup job with the supplied name |
duplicati server |
Starts the duplicati webserver, with the supplied configuration from duplicati.conf (see below). |
duplicati usage |
Shows the usage of currently running backup jobs using top. |
duplicati status |
Shows the output of the duplicatirc file (see below). |
duplicati status <backup_config_name> |
Shows the live log output of the specified backup/repair job using tail -f. |
duplicati command <duplicati arguments> |
Invokes the duplicati CLI with the provided arguments. |
This file contains the basic configuration of duplicati. The default path is /opt/duplicati_helper/duplicati.conf. In case you want to change the location of this file, you need to modify duplicati, duplicatirc, duplicati_completion and shutdown, as described in the intallation instructions below (bullet point 8). An example configuration with all required properties is provided within this repository (duplicati.conf.example).
This file contains the configuration of your backup jobs. It contains the backup's password. The password or name are not allowed to contain white spaces. In this file you have the possibility to specify paths that should be excluded from your backup (see example). Additionally you can overwrite some of the settings defined in duplicati.conf or define new settings on a job level (see example). Make sure you restrict the access rights to the user who is executing the backups. In case you want to change the location of the file (default: /op/duplicati_helper/backup.conf) you need to modify duplicati.conf's BACKUP_CONFIG value. An example configuration is provided within this repository (backup.conf.example).
This file enables autocompletion for bash shells. This functionality requires bash_completion support of your operating system. Follow this guide to enable bash_completion. It might be possible, that you need to install the package bash_completion first using your packet management system. This script enables to auto complete the first argument (modifier) and then reads your backup configuration to suggest auto completion of configured backups, in case the modifier requires that.
This script is intended to give a summary of every backup job's current status upon log in. A "+" within the first column indicates, that this entry was added or updated since your last log in. The status of backups is tracked within a status file. The location of this file is specified within duplicati.conf's BACKUP_STATUS_FILE variable.
This script is a drop-in replacement for the shutdown procedure, checking if there are any running duplicati jobs and postponing the shutdown until all jobs finished. Upon calling shutdown it will notify all open terminals, that a shutdown is scheduled, but delayed. A scheduled shutdown can be canceled using shutdown -c. In case a shutdown is scheduled, duplicatirc will display that information.