---
title: Charmhub | Deploy Duplicity using Charmhub - The Open Operator Collection
description: Deploy the latest version of Duplicity on any cloud.
url: https://charmhub.io/duplicity/configurations
---

# Duplicity

[Canonical BootStack Charmers](https://charmhub.io/publisher/bootstack-charmers "View all packages from Canonical BootStack Charmers")

* [Canonical BootStack Charmers](https://charmhub.io/publisher/bootstack-charmers "View all packages from Canonical BootStack Charmers")

Platform:

22.04

20.04

stable 3

```
juju deploy duplicity
```

[Learn to deploy on juju >](https://juju.is/docs/juju/manage-applications)

* [aux\_backup\_directory](https://charmhub.io/duplicity/configurations#aux_backup_directory)
* [aws\_access\_key\_id](https://charmhub.io/duplicity/configurations#aws_access_key_id)
* [aws\_secret\_access\_key](https://charmhub.io/duplicity/configurations#aws_secret_access_key)
* [backend](https://charmhub.io/duplicity/configurations#backend)
* [backup\_frequency](https://charmhub.io/duplicity/configurations#backup_frequency)
* [deletion\_frequency](https://charmhub.io/duplicity/configurations#deletion_frequency)
* [disable\_encryption](https://charmhub.io/duplicity/configurations#disable_encryption)
* [encryption\_passphrase](https://charmhub.io/duplicity/configurations#encryption_passphrase)
* [extra\_packages](https://charmhub.io/duplicity/configurations#extra_packages)
* [gpg\_public\_key](https://charmhub.io/duplicity/configurations#gpg_public_key)
* [install\_keys](https://charmhub.io/duplicity/configurations#install_keys)
* [install\_sources](https://charmhub.io/duplicity/configurations#install_sources)
* [known\_host\_key](https://charmhub.io/duplicity/configurations#known_host_key)
* [nagios\_context](https://charmhub.io/duplicity/configurations#nagios_context)
* [nagios\_servicegroups](https://charmhub.io/duplicity/configurations#nagios_servicegroups)
* [package\_status](https://charmhub.io/duplicity/configurations#package_status)
* [private\_ssh\_key](https://charmhub.io/duplicity/configurations#private_ssh_key)
* [remote\_backup\_url](https://charmhub.io/duplicity/configurations#remote_backup_url)
* [remote\_password](https://charmhub.io/duplicity/configurations#remote_password)
* [remote\_user](https://charmhub.io/duplicity/configurations#remote_user)
* [retention\_period](https://charmhub.io/duplicity/configurations#retention_period)

[Learn about configurations >](https://juju.is/docs/juju/configuration#heading--application-configuration)

* aux\_backup\_directory | string

  Default: /tmp/duplicity

  Specifies an additional directory paths which duplicity will monitor on
  all units for backup.
* aws\_access\_key\_id | string

  Access key id for the AWS IMA user. The user must have a policy that
  grants it privileges to upload to the S3 bucket. This value is required
  when backend='s3'.
* aws\_secret\_access\_key | string

  Secret access key for the AWS IMA user. The user must have a policy that
  grants it privileges to upload to the S3 bucket. This value is required
  when backend='s3'.
* backend | string

  Accepted values are s3 | scp | sftp | ftp | rsync | file
  An empty string will disable backups.
* backup\_frequency | string

  Default: manual

  Sets the crontab backup frequency to a valid cron string or one of the following:
  hourly|daily|weekly|monthly|manual
  If set to manual, crontab backup will not run.
* deletion\_frequency | string

  Default: daily

  Using retention period, a crontab executes at this frequency to delete stale backups.
  Sets the periodic deletion cron's frequency to one of the following:
  hourly|daily|<any valid cron string>
  Note: hourly runs at 40th min mark every hour and daily runs at 2300 everyday.
* disable\_encryption | boolean

  By default, duplicity uses symmetric encryption on backup, requiring a
  simple password. Duplicity also supports asymmetric encryption, via GPG
  keys. Setting this value to True disables encryption across the entire
  application.
* encryption\_passphrase | string

  Set a passphrase required to perform symmetric encryption.
* extra\_packages | string

  Space separated list of extra deb packages to install.
* gpg\_public\_key | string

  Sets the GPG Public Key used for asymmetrical encryption. When set, this
  becomes the primary method for encryption.
* install\_keys | string

  List of signing keys for install\_sources package sources, per charmhelpers standard format (a yaml list of strings encoded as a string). The keys should be the full ASCII armoured GPG public keys. While GPG key ids are also supported and looked up on a keyserver, operators should be aware that this mechanism is insecure. null can be used if a standard package signing key is used that will already be installed on the machine, and for PPA sources where the package signing key is securely retrieved from Launchpad.
* install\_sources | string

  List of extra apt sources, per charm-helpers standard format (a yaml list of strings encoded as a string). Each source may be either a line that can be added directly to sources.list(5), or in the form ppa:<user>/<ppa-name> for adding Personal Package Archives, or a distribution component to enable.
* known\_host\_key | string

  Host key for remote backup host when using scp, rsync, and sftp backends.
  Valid host key required when using these backends. The format is:
  hostname[,ip] algo public\_key

  ex: example.com,10.0.0.0 ssh-rsa AAABBBCCC...
* nagios\_context | string

  Default: juju

  Used by the nrpe subordinate charms.
  A string that will be prepended to instance name to set the host name
  in nagios. So for instance the hostname would be something like:
  juju-myservice-0
  If you're running multiple environments with the same services in them
  this allows you to differentiate between them.
* nagios\_servicegroups | string

  A comma-separated list of nagios servicegroups.
  If left empty, the nagios\_context will be used as the servicegroup
* package\_status | string

  Default: install

  The status of service-affecting packages will be set to this value in the dpkg database. Valid values are "install" and "hold".
* private\_ssh\_key | string

  base64 encoded private SSH key for SSH authentication from duplicity application unit and the remote backup host.
* remote\_backup\_url | string

  URL to the remote server and its local path to be used as the
  backup destination.

  Backends and their URL formats:
  file: 'file:///some\_dir'
  ftp & sftp: 'remote.host[:port]/some\_dir'
  rsync: 'other.host[:port]::/module/some\_dir'
  'other.host[:port]/relative\_path'
  'other.host[:port]//absolute\_path'
  s3: 's3:other.host[:port]/bucket\_name[/prefix]'
  's3+http://bucket\_name[/prefix]'
  scp: 'other.host[:port]/some\_dir'
  sftp: 'other.host[:port]/some\_dir'
* remote\_password | string

  This value sets the remote server's password to be used for scp, ftp or sftp
  backups. If unset, it may still be able to authenticate via SSH private key.
* remote\_user | string

  This value sets the remote host username for scp, ftp or sftp backups.
* retention\_period | string

  Default: manual

  Sets the retention period of backups. By default, it is set to 30 days.
  Can be set to:
  manual, <n>d, <n>h but not both hours and days. For example, 30d, 7d, 36h, etc...
  If set to manual, crontab for deletion of stale backups will not run.
