Skip to content

borgbackup

Efficient, deduplicating backup program with optional compression and secure encryption.

System

BorgBackup (short: Borg) gives you:

  • Space efficient storage of backups.
  • Secure, authenticated encryption.
  • Compression: lz4, zstd, zlib, lzma or none.
  • Mountable backups with FUSE.
  • Easy installation on multiple platforms: Linux, macOS, BSD, …
  • Free software (BSD license).
  • Backed by a large and active open-source community.

Roles

The borgbackup module has the following roles:

  • client
  • server

Options for the client role

destinations

external destinations where the machine should be backuped to

Type: attribute set of (submodule)

Default:

{ }

Declared in: clanServices/borgbackup/default.nix

destinations.<name>.name

the name of the backup job

Type: string matching the pattern ^[a-zA-Z0-9._-]+$

Default:

"‹name›"

Declared in: clanServices/borgbackup/default.nix

destinations.<name>.repo

the borgbackup repository to backup to

Type: string

Declared in: clanServices/borgbackup/default.nix

destinations.<name>.rsh

the rsh to use for the backup

Type: string

Default:

"ssh -i \${config.clan.core.vars.generators.borgbackup.files.\"borgbackup.ssh\".path} -o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null"

Declared in: clanServices/borgbackup/default.nix

exclude

Directories/Files to exclude from the backup. Use * as a wildcard.

Type: list of string

Default:

[ ]
Example 
[
  "*.pyc"
]

Declared in: clanServices/borgbackup/default.nix

Options for the server role

directory

The directory where the borgbackup repositories are stored.

Type: string

Default:

"/var/lib/borgbackup"

Declared in: clanServices/borgbackup/default.nix