zrepl/docs/content/_index.md

+++ title = "zrepl - ZFS replication" +++

zrepl - ZFS replication

{{% notice info %}} zrepl as well as this documentation is still under active development. It is neither feature complete nor is there a stability guarantee on the configuration format. Use & test at your own risk ;) {{% /notice %}}

Getting started

The [5 minute tutorial setup]({{< relref "tutorial/_index.md" >}}) gives you a first impression.

Main Features

• Filesystem Replication
  • Local & Remote
  • Pull mode
  • Push mode
  • Access control checks when pulling datasets
  • [Flexible mapping]({{< ref "configuration/map_filter_syntax.md" >}}) rules
  • Bookmarks support
  • Feature-negotiation for
    • Resumable send & receive
    • Compressed send & receive
    • Raw encrypted send & receive (as soon as it is available)
• Automatic snapshot creation
  • Ensure fixed time interval between snapshots
• Automatic snapshot [pruning]({{< ref "configuration/prune.md" >}})
  • Age-based fading (grandfathering scheme)
• Flexible, detailed & structured [logging]({{< ref "configuration/logging.md" >}})
  • human, logfmt and json formatting
  • stdout, syslog and TCP (+TLS client auth) outlets
• Maintainable implementation in Go
  • Cross platform
  • Type safe & testable code

Contributing

We are happy about any help we can get!

• Explore the codebase
  • These docs live in the docs/ subdirectory
• Document any non-obvious / confusing / plain broken behavior you encounter when setting up zrepl for the first time
• Check the Issues and Projects sections for things to do

{{% panel header=" Development Workflow"%}} The GitHub repository is where all development happens.
Make sure to read the Developer Documentation section and open new issues or pull requests there. {{% /panel %}}