---
id: "borgbackup"
type: "component"
kind: "backup-service"
provider: "default"
category: "ops"
docs: "https://borgbackup.readthedocs.io/en/stable/usage/init.html"
url: "https://localhost:3000/catalogue/components/borgbackup"
---

# BorgBackup

Deduplicating backup program with optional compression and authenticated encryption.

| | |
|---|---|
| Provider | [default](https://localhost:3000/catalogue?provider=default) |
| Kind | [Backup vault](https://localhost:3000/catalogue/kinds/backup-service) |
| Category | Operations |
| Official docs | [https://borgbackup.readthedocs.io/en/stable/usage/init.html](https://borgbackup.readthedocs.io/en/stable/usage/init.html) |

## Properties

| property | type | values | required | kind default | this component |
|---|---|---|---|---|---|
| `appendOnlyRepository` | boolean | — | no | false | inherited |
| `crossRegionRestore` | boolean | — | no | false | **false** |
| `deduplication` | boolean | — | no | true | inherited |
| `encryptionMode` | enum | `none`, `authenticated`, `authenticated-blake2`, `repokey`, `repokey-blake2`, `keyfile`, `keyfile-blake2` | no | — | inherited |
| `frequency` | enum | `hourly`, `daily`, `weekly` | no | — | inherited |
| `immutable` | boolean | — | no | — | inherited |
| `managed` | boolean | — | no | false | **false** |
| `redundancy` | enum | `local`, `zonal`, `regional`, `geo` | no | — | inherited |
| `retentionDays` | integer | — | no | — | inherited |
| `softDeleteDays` | integer | — | no | — | inherited |

Bold values are the ones this component pins.

## Rules that apply · 0

No rule selects this kind or its category.

## Other products of the same kind · 23

- [Database Backup](https://localhost:3000/catalogue/components/alibaba-dbs.md) `alibaba-dbs` — alibabacloud
- [Cloud Backup](https://localhost:3000/catalogue/components/alibaba-hbr.md) `alibaba-hbr` — alibabacloud
- [AWS Backup](https://localhost:3000/catalogue/components/aws-backup.md) `aws-backup` — aws
- [Amazon Data Lifecycle Manager](https://localhost:3000/catalogue/components/aws-data-lifecycle-manager.md) `aws-data-lifecycle-manager` — aws
- [AWS Elastic Disaster Recovery](https://localhost:3000/catalogue/components/aws-drs.md) `aws-drs` — aws
- [Azure Backup](https://localhost:3000/catalogue/components/azure-backup.md) `azure-backup` — azure
- [Azure Site Recovery](https://localhost:3000/catalogue/components/azure-site-recovery.md) `azure-site-recovery` — azure
- [Generic backup vault](https://localhost:3000/catalogue/components/backup-service.md) `backup-service` — default
- [Bacula](https://localhost:3000/catalogue/components/bacula.md) `bacula` — default
- [Bareos](https://localhost:3000/catalogue/components/bareos.md) `bareos` — default
- [Veeam Kasten](https://localhost:3000/catalogue/components/kasten.md) `kasten` — default
- [restic](https://localhost:3000/catalogue/components/restic.md) `restic` — default
- [Tape library](https://localhost:3000/catalogue/components/tape-library.md) `tape-library` — default
- [Veeam Backup & Replication](https://localhost:3000/catalogue/components/veeam.md) `veeam` — default
- [Velero](https://localhost:3000/catalogue/components/velero.md) `velero` — default
- [SnapShooter](https://localhost:3000/catalogue/components/digitalocean-snapshooter.md) `digitalocean-snapshooter` — digitalocean
- [Backup and DR Service backup vault](https://localhost:3000/catalogue/components/google-backup-and-dr.md) `google-backup-and-dr` — gcp
- [Backup for GKE](https://localhost:3000/catalogue/components/google-backup-for-gke.md) `google-backup-for-gke` — gcp
- [IBM Cloud Backup and Recovery](https://localhost:3000/catalogue/components/ibm-backup-recovery.md) `ibm-backup-recovery` — ibm
- [Oracle Database Autonomous Recovery Service](https://localhost:3000/catalogue/components/oci-autonomous-recovery-service.md) `oci-autonomous-recovery-service` — oci
- [OCI Block Volume Backup Policy](https://localhost:3000/catalogue/components/oci-block-volume-backup.md) `oci-block-volume-backup` — oci
- [OCI Full Stack Disaster Recovery](https://localhost:3000/catalogue/components/oci-full-stack-disaster-recovery.md) `oci-full-stack-disaster-recovery` — oci
- [OpenStack Freezer](https://localhost:3000/catalogue/components/openstack-freezer.md) `openstack-freezer` — openstack

## Use it in a design

```yaml
nodes:
  - { id: "borgbackup", component: "borgbackup" }
```

## Source (`component` YAML, verbatim)

```yaml
# yaml-language-server: $schema=../../schema/component.schema.json
# BorgBackup: deduplicating backup program with optional compression and authenticated encryption ("Borg Documentation").
# borg init requires --encryption explicitly - there is no default mode ("borg init") - and prunes only when a retention policy is passed.
schemaVersion: "1"
type: "component"
id: "borgbackup"
kind: "backup-service"
provider: "default"
docs: "https://borgbackup.readthedocs.io/en/stable/usage/init.html"
defaults:
  managed: false
  crossRegionRestore: false
properties:
  encryptionMode:
    type: "enum"
    values: ["none", "authenticated", "authenticated-blake2", "repokey", "repokey-blake2", "keyfile", "keyfile-blake2"]
  deduplication:
    type: "boolean"
    default: true
  appendOnlyRepository:
    type: "boolean"
    default: false
```

Human page: https://localhost:3000/catalogue/components/borgbackup