Built-in sources of dataΒΆ

You can use any of these sources in any collect point. Of course, you can use the same kind of source several times. Required parameters are marked in red.

engine=dovecot

Dump a OpenLDAP database using slapcat to a filename in the collect point. Require the 'doveadm' utility.

List of available parameters:

  • destination_path: dirname of the dump (not an absolute path)
  • dump_executable: path of the doveadm executable (default: "doveadm")
  • mailbox: only sync this mailbox name
  • socket: The option's argument is either an absolute path to a local UNIX domain socket, or a hostname and port (hostname:port), in order to connect a remote host via a TCP socket.
  • user_mask: only sync this user ("*" and "?" wildcards can be used).

engine=ldap

Dump a OpenLDAP database using slapcat to a filename in the collect point. Must be run on the LDAP server with a sudoer account (or 'root'). Require the 'slapcat' and 'slapadd' utilities.

List of available parameters:

  • data_directory: your LDAP base (if you want to restrict the dump)
  • database: database number (default: 1)
  • destination_path: filename of the dump (not an absolute path)
  • dump_executable: path of the slapcat executable (default: "slapcat")
  • ldap_base: your LDAP base dn (if you want to restrict the dump)
  • restore_executable: path of the slapadd executable (default: "slapadd")
  • use_sudo: use sudo to perform the dump (yes/no)

engine=local_files

copy all files from the given source_path to the collect point using 'rsync'. The destination is a folder inside the collect point.

List of available parameters:

  • destination_path: destination folder (relative path, e.g. "./files")
  • exclude: exclude files matching PATTERN (see --exclude option from rsync). If PATTERN startswith @, then it should be the absolute path of a file (see --exclude-from option from rsync)
  • include: only include files matching PATTERN (see --include option from rsync). If PATTERN startswith @, then it should be the absolute path of a file (see --include-from option from rsync)
  • preserve_hard_links: true|false: preserve hard links
  • source_path: original folder to backup

engine=mysql

Dump the content of a MySQL database with the mysqldump utility to a filename in the collect point. Require the 'mysql' and 'mysqldump' utilities.

List of available parameters:

  • database: name of the backuped database
  • destination_path: relative path of the backup destination (e.g. "database.sql")
  • dump_executable: path of the mysqldump executable (default: "mysqldump")
  • host: database host
  • password: database password
  • port: database port
  • restore_executable: path of the mysql executable (default: "mysql")
  • sudo_user: sudo user, used for all SQL operations
  • user: database user

engine=postgressql

Dump the content of a PostgresSQL database with the pg_dump utility to a filename in the collect point. Require the 'pg_dump' and 'psql' utilities.

List of available parameters:

  • database: name of the backuped database
  • destination_path: relative path of the backup destination (e.g. "database.sql")
  • dump_executable: path of the pg_dump executable (default: "pg_dump")
  • host: database host
  • password: database password
  • port: database port
  • restore_executable: path of the psql executable (default: "psql")
  • sudo_user: sudo user, used for all SQL operations
  • user: database user

engine=remote_files

copy the remote files from the given server/source_path to the collect point. The destination is a folder inside the collect point. Require 'rsync'.

List of available parameters:

  • ca_cert: CA certificate associated to 'remote_url'. Set to "any" for not checking certificates
  • destination_path: destination folder (like "./remote-files")
  • keytab: absolute path of the keytab file (for Kerberos authentication)
  • private_key: private key or certificate associated to 'remote_url'
  • source_url: synchronize data from this URL. Must ends by a folder name1
  • ssh_options: SSH options associated to 'url'

  1. please only use file/http/https/ssh URLs. If a username and a password are required, their must be provided in the URL.