duplone

KO | EN

gitlite — search

#python #react #ai #typescript #golang #android #machine-learning #deep-learning #macos #nodejs #awesome #kubernetes #pytorch #security

(★ 8)

automate duplicity & rclone

duplone Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Duplone, automate duplicity & rclone

## Few words about duplicity & rclone

[duplicity](http://duplicity.nongnu.org/) *backs directories by producing encrypted tar-format volumes and uploading them to a remote or local file server.* It's a very good tool to produce backup! Nothing else.

[rclone](https://github.com/ncw/rclone) *is a command line program to sync files and directories to and from* cloud & non-cloud (storage) providers.

[duplicity-rclone](https://github.com/GilGalaad/duplicity-rclone) is a duplicity backend to using rclone, written by [Francesco Magno](https://github.com/GilGalaad).

## What's is duplone?

Duplone is a script to automate duplicity & rclone backups, written in Python, who can help you to create/delete/verify backups trough cloud providers.  Actually the code have only Hubic and Google Drive/Suite as service but you can easily modify the code and add it (and send to me a message, I'll update it).

Duplone read the configured `conf.json` file and launch a full or incremental backup, a full or partial delete of backups or read the status of backups trough duplicity.

The idea is to use three simple parameters to launch the desired function:
```sh
     duplone bck-full host service --> perform full backup
     duplone bck-incr host service --> perform incremental backup
     duplone status host service   --> show backups status
     duplone del-ret host service  --> delete backups (using retention)
     duplone del-all host service  --> delete all backups (except last N)
```
### JSON configuration file:
The JSON configuration file is like the one below, description of key/value trough quotation marks:
```json
{
  "my-host-desired-name":
    {
      "my-service-name" : {
      "dest_type": "put here your destination: hubic, gdrive or sftp",
      "dest_path": "destination path of hubic, gdrive or sftp",
      "bck_path" : "source path of backup",
      "encryptkey": "your encrypted key",
      "passphrase" : "your key passphrase",
      "exclude_dir" : "do you exclude a directory from backup?",
      "using_rclone" : "yes or not or empty",
      "retention_days" : "day of retention in M(months) D(days) or Y(year)",
      "retention_full" : "how many full backup to save",
      "only_sftp_string" : "user@host:port if you use sftp, otherwise empty"
        }
    }
}
```
A simple example of JSON configuration file is below. We want from our workstation to create a backup of:
 - home directory `/home/name` to hubic cloud storage in `/default/my-homedir` (without /default/ in hubic we can't see it on control panel). GPG key is ABC123C4 and the passphrase is myp4ssphr4s3. We also want to exclude to backup the directories `/home/name/tmp /home/name/var`.  Obviously we want to use rclone and we want a retention of 1 month for the full/incremental backup and at least 1 full backup always online.
 - `/var` directory to Google Drive/Suite in `bck-vardir`. GPG key is ABC123C4 and the passphrase is myp4ssphr4s3. We also want to exclude to backup the directories `/var/log /var/mail`. Obviously we want to use rclone and we want a retention of 3 month for the full/incremental backup and at least 2 full backup always online.

```json
{
  "myworkstation":
    {
      "homedir" : {
        "dest_type": "hubic",
        "dest_path": "/default/my-homedir",
        "bck_path" : "/home/name",
        "encryptkey": "ABC123C4",
        "passphrase" : "myp4ssphr4s3",
        "exclude_dir" : "/home/name/tmp /home/name/var",
        "using_rclone" : "yes",
        "retention_days" : "1M",
        "retention_full" : "1",
        "only_sftp_string" : ""
      },
      "vardir" : {
        "dest_type": "gdrive",
        "dest_path": "/bck-vardir",
        "bck_path" : "/var",
        "encryptkey": "ABC123C4",
        "passphrase" : "myp4ssphr4s3",
        "exclude_dir" : "/var/log /var/mail",
        "using_rclone" : "yes",
        "retention_days" : "3M",
        "retention_full" : "2",
        "only_sftp_string" : ""
        }
    }
}
```
Remember to save the `conf.json` file in the same directory of `duplone.py`.

### Launch duplone script
At the moment only five options are available:

- **Full backup - create first backup** : `./duplone.py bck-full host service`, using the previously example:

`./duplone.py bck-full myworkstation homedir`

`./duplone.py bck-full myworkstation vardir`