BorgBackup

Backup vaultborgbackup

Deduplicating backup program with optional compression and authenticated encryption.

Provider
default
Category
Operations
Properties · 2 set by this component
propertytypevaluesrequiredkind defaultthis component
appendOnlyRepository · component propertyboolean—nofalseinherited
crossRegionRestoreboolean—nofalse▸ false
deduplication · component propertyboolean—notrueinherited
encryptionMode · component propertyenumnone | authenticated | authenticated-blake2 | repokey | repokey-blake2 | keyfile | keyfile-blake2no—inherited
frequencyenumhourly | daily | weeklyno—inherited
immutableboolean—no—inherited
managedboolean—nofalse▸ false
redundancyenumlocal | zonal | regional | geono—inherited
retentionDaysinteger—no—inherited
softDeleteDaysinteger—no—inherited
Rules that apply · 0

Every rule whose selector covers this component's kind or its category. Whether a rule fires depends on the design: its properties, its edges and its groups.

No rule reads this kind yet. That is a gap, not a guarantee.
Use it in a design
nodes:
  - { id: "borgbackup", component: "borgbackup" }
Other Backup vault products · 23
Source
# 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

The same page as markdown, for an agent: /catalogue/components/borgbackup.md