Warning: This document is for the development version of zrepl. The main version is stable.

Configuration

• Overview & Terminology
  • Config File Structure
  • Jobs & How They Work Together
  • How the Active Side Works
  • How the Passive Side Works
  • How Replication Works
    • ZFS Background Knowledge
    • ZFS Abstractions Managed By zrepl
  • Caveats With Complex Setups (More Than 2 Jobs or Machines)
    • Multiple Jobs on One Machine
    • Two Or More Machines
• Job Types in Detail
  • Job Type push
  • Job Type sink
  • Job Type pull
  • Job Type source
  • Local replication
  • Job Type snap (snapshot & prune only)
• Transports
  • tcp Transport
    • Serve
    • Connect
  • tls Transport
    • Serve
    • Connect
    • Mutual-TLS between Two Machines
    • Certificate Authority using EasyRSA
  • ssh+stdinserver Transport
    • Serve
    • Connect
  • local Transport
• Filter Syntax
  • Examples
    • Full Access
    • Fine-grained
• Send & Recv Options
  • Send Options
    • encrypted
    • properties
    • backup_properties
    • large_blocks
  • Recv Options
    • properties
  • A Note on Property Replication
    • Mount behaviour
    • Systemd
    • Encryption
  • Placeholders
  • Common Options
    • Bandwidth Limit (send & recv)
• Replication Options
  • protection option
  • concurrency option
• Conflict Resolution Options
  • initial_replication option
• Taking Snaphots
  • periodic Snapshotting
  • cron Snapshotting
    • Timestamp Format
  • manual Snapshotting
  • Pre- and Post-Snapshot Hooks
    • command Hooks
    • postgres-checkpoint Hook
    • mysql-lock-tables Hook
• Pruning Policies
  • Policy not_replicated
  • Policy grid
  • Policy last_n
  • Policy regex
  • Source-side snapshot pruning
    • Workaround using snap job
• Logging
  • Default Configuration
  • Building Blocks
    • Levels
    • Formats
    • Outlets
  • stdout Outlet
  • syslog Outlet
  • tcp Outlet
• Monitoring
  • Prometheus & Grafana
• Miscellaneous
  • Runtime Directories & UNIX Sockets
  • Durations & Intervals