configuration.html

<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
  <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />

  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  <title>Configuration &mdash; zrepl  documentation</title>
      <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
      <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
      <link rel="stylesheet" href="_static/banner.css" type="text/css" />
  <!--[if lt IE 9]>
    <script src="_static/js/html5shiv.min.js"></script>
  <![endif]-->
  
        <script src="_static/jquery.js?v=5d32c60e"></script>
        <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
        <script src="_static/documentation_options.js?v=5929fcd5"></script>
        <script src="_static/doctools.js?v=888ff710"></script>
        <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
    <script src="_static/js/theme.js"></script>
    <link rel="index" title="Index" href="genindex.html" />
    <link rel="search" title="Search" href="search.html" />
    <link rel="next" title="Overview &amp; Terminology" href="configuration/overview.html" />
    <link rel="prev" title="What next?" href="installation/what-next.html" /> 
</head>

<body class="wy-body-for-nav"> 
  <div class="wy-grid-for-nav">
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search" >

          
          <a href="index.html" class="icon icon-home">
            zrepl
              <img src="_static/zrepl.svg" class="logo" alt="Logo"/>
          </a>
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>
        </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
              <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="quickstart.html">Quick Start by Use Case</a></li>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Configuration</a><ul>
<li class="toctree-l2"><a class="reference internal" href="configuration/overview.html">Overview &amp; Terminology</a></li>
<li class="toctree-l2"><a class="reference internal" href="configuration/jobs.html">Job Types in Detail</a></li>
<li class="toctree-l2"><a class="reference internal" href="configuration/transports.html">Transports</a></li>
<li class="toctree-l2"><a class="reference internal" href="configuration/filter_syntax.html">Filter Syntax</a></li>
<li class="toctree-l2"><a class="reference internal" href="configuration/sendrecvoptions.html">Send &amp; Recv Options</a></li>
<li class="toctree-l2"><a class="reference internal" href="configuration/replication.html">Replication Options</a></li>
<li class="toctree-l2"><a class="reference internal" href="configuration/conflict_resolution.html">Conflict Resolution Options</a></li>
<li class="toctree-l2"><a class="reference internal" href="configuration/snapshotting.html">Taking Snaphots</a></li>
<li class="toctree-l2"><a class="reference internal" href="configuration/prune.html">Pruning Policies</a></li>
<li class="toctree-l2"><a class="reference internal" href="configuration/logging.html">Logging</a></li>
<li class="toctree-l2"><a class="reference internal" href="configuration/monitoring.html">Monitoring</a></li>
<li class="toctree-l2"><a class="reference internal" href="configuration/misc.html">Miscellaneous</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="usage.html">Usage</a></li>
<li class="toctree-l1"><a class="reference internal" href="pr.html">Talks &amp; Presentations</a></li>
<li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a></li>
<li class="toctree-l1"><a class="reference external" href="https://github.com/zrepl/zrepl">GitHub Repository &amp; Issue Tracker</a></li>
<li class="toctree-l1"><a class="reference external" href="https://matrix.to/#/#zrepl:matrix.org">Chat: Matrix</a></li>
<li class="toctree-l1"><a class="reference internal" href="supporters.html">Supporters</a></li>
</ul>

        </div>
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
          <a href="index.html">zrepl</a>
      </nav>

      <div class="wy-nav-content">
        <div class="rst-content">
          <div role="navigation" aria-label="Page navigation">
  <ul class="wy-breadcrumbs">
      <li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
      <li class="breadcrumb-item active">Configuration</li>
      <li class="wy-breadcrumbs-aside">
              <a href="https://github.com/zrepl/zrepl/blob/master/docs/configuration.rst" class="fa fa-github"> Edit on GitHub</a>
      </li>
  </ul>
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
             

  <section id="configuration">
<span id="configuration-toc"></span><h1>Configuration<a class="headerlink" href="#configuration" title="Link to this heading"></a></h1>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="configuration/overview.html">Overview &amp; Terminology</a><ul>
<li class="toctree-l2"><a class="reference internal" href="configuration/overview.html#config-file-structure">Config File Structure</a></li>
<li class="toctree-l2"><a class="reference internal" href="configuration/overview.html#jobs-how-they-work-together">Jobs &amp; How They Work Together</a></li>
<li class="toctree-l2"><a class="reference internal" href="configuration/overview.html#how-the-active-side-works">How the Active Side Works</a></li>
<li class="toctree-l2"><a class="reference internal" href="configuration/overview.html#how-the-passive-side-works">How the Passive Side Works</a></li>
<li class="toctree-l2"><a class="reference internal" href="configuration/overview.html#how-replication-works">How Replication Works</a><ul>
<li class="toctree-l3"><a class="reference internal" href="configuration/overview.html#zfs-background-knowledge">ZFS Background Knowledge</a></li>
<li class="toctree-l3"><a class="reference internal" href="configuration/overview.html#zfs-abstractions-managed-by-zrepl">ZFS Abstractions Managed By zrepl</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="configuration/overview.html#caveats-with-complex-setups-more-than-2-jobs-or-machines">Caveats With Complex Setups (More Than 2 Jobs or Machines)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="configuration/overview.html#multiple-jobs-on-one-machine">Multiple Jobs on One Machine</a></li>
<li class="toctree-l3"><a class="reference internal" href="configuration/overview.html#two-or-more-machines">Two Or More Machines</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="configuration/jobs.html">Job Types in Detail</a><ul>
<li class="toctree-l2"><a class="reference internal" href="configuration/jobs.html#job-type-push">Job Type <code class="docutils literal notranslate"><span class="pre">push</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="configuration/jobs.html#job-type-sink">Job Type <code class="docutils literal notranslate"><span class="pre">sink</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="configuration/jobs.html#job-type-pull">Job Type <code class="docutils literal notranslate"><span class="pre">pull</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="configuration/jobs.html#job-type-source">Job Type <code class="docutils literal notranslate"><span class="pre">source</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="configuration/jobs.html#local-replication">Local replication</a></li>
<li class="toctree-l2"><a class="reference internal" href="configuration/jobs.html#job-type-snap-snapshot-prune-only">Job Type <code class="docutils literal notranslate"><span class="pre">snap</span></code> (snapshot &amp; prune only)</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="configuration/transports.html">Transports</a><ul>
<li class="toctree-l2"><a class="reference internal" href="configuration/transports.html#tcp-transport"><code class="docutils literal notranslate"><span class="pre">tcp</span></code> Transport</a><ul>
<li class="toctree-l3"><a class="reference internal" href="configuration/transports.html#serve">Serve</a></li>
<li class="toctree-l3"><a class="reference internal" href="configuration/transports.html#connect">Connect</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="configuration/transports.html#tls-transport"><code class="docutils literal notranslate"><span class="pre">tls</span></code> Transport</a><ul>
<li class="toctree-l3"><a class="reference internal" href="configuration/transports.html#id1">Serve</a></li>
<li class="toctree-l3"><a class="reference internal" href="configuration/transports.html#id2">Connect</a></li>
<li class="toctree-l3"><a class="reference internal" href="configuration/transports.html#mutual-tls-between-two-machines">Mutual-TLS between Two Machines</a></li>
<li class="toctree-l3"><a class="reference internal" href="configuration/transports.html#certificate-authority-using-easyrsa">Certificate Authority using EasyRSA</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="configuration/transports.html#ssh-stdinserver-transport"><code class="docutils literal notranslate"><span class="pre">ssh+stdinserver</span></code> Transport</a><ul>
<li class="toctree-l3"><a class="reference internal" href="configuration/transports.html#transport-ssh-stdinserver-serve">Serve</a></li>
<li class="toctree-l3"><a class="reference internal" href="configuration/transports.html#transport-ssh-stdinserver-connect">Connect</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="configuration/transports.html#local-transport"><code class="docutils literal notranslate"><span class="pre">local</span></code> Transport</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="configuration/filter_syntax.html">Filter Syntax</a><ul>
<li class="toctree-l2"><a class="reference internal" href="configuration/filter_syntax.html#examples">Examples</a><ul>
<li class="toctree-l3"><a class="reference internal" href="configuration/filter_syntax.html#full-access">Full Access</a></li>
<li class="toctree-l3"><a class="reference internal" href="configuration/filter_syntax.html#fine-grained">Fine-grained</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="configuration/sendrecvoptions.html">Send &amp; Recv Options</a><ul>
<li class="toctree-l2"><a class="reference internal" href="configuration/sendrecvoptions.html#send-options">Send Options</a><ul>
<li class="toctree-l3"><a class="reference internal" href="configuration/sendrecvoptions.html#encrypted"><code class="docutils literal notranslate"><span class="pre">encrypted</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="configuration/sendrecvoptions.html#properties"><code class="docutils literal notranslate"><span class="pre">properties</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="configuration/sendrecvoptions.html#backup-properties"><code class="docutils literal notranslate"><span class="pre">backup_properties</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="configuration/sendrecvoptions.html#large-blocks"><code class="docutils literal notranslate"><span class="pre">large_blocks</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="configuration/sendrecvoptions.html#recv-options">Recv Options</a><ul>
<li class="toctree-l3"><a class="reference internal" href="configuration/sendrecvoptions.html#job-recv-options-inherit-and-override"><code class="docutils literal notranslate"><span class="pre">properties</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="configuration/sendrecvoptions.html#a-note-on-property-replication">A Note on Property Replication</a><ul>
<li class="toctree-l3"><a class="reference internal" href="configuration/sendrecvoptions.html#mount-behaviour">Mount behaviour</a></li>
<li class="toctree-l3"><a class="reference internal" href="configuration/sendrecvoptions.html#systemd">Systemd</a></li>
<li class="toctree-l3"><a class="reference internal" href="configuration/sendrecvoptions.html#encryption">Encryption</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="configuration/sendrecvoptions.html#placeholders">Placeholders</a></li>
<li class="toctree-l2"><a class="reference internal" href="configuration/sendrecvoptions.html#common-options">Common Options</a><ul>
<li class="toctree-l3"><a class="reference internal" href="configuration/sendrecvoptions.html#bandwidth-limit-send-recv">Bandwidth Limit (send &amp; recv)</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="configuration/replication.html">Replication Options</a><ul>
<li class="toctree-l2"><a class="reference internal" href="configuration/replication.html#protection-option"><code class="docutils literal notranslate"><span class="pre">protection</span></code> option</a></li>
<li class="toctree-l2"><a class="reference internal" href="configuration/replication.html#concurrency-option"><code class="docutils literal notranslate"><span class="pre">concurrency</span></code> option</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="configuration/conflict_resolution.html">Conflict Resolution Options</a><ul>
<li class="toctree-l2"><a class="reference internal" href="configuration/conflict_resolution.html#initial-replication-option"><code class="docutils literal notranslate"><span class="pre">initial_replication</span></code> option</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="configuration/snapshotting.html">Taking Snaphots</a><ul>
<li class="toctree-l2"><a class="reference internal" href="configuration/snapshotting.html#periodic-snapshotting"><code class="docutils literal notranslate"><span class="pre">periodic</span></code> Snapshotting</a></li>
<li class="toctree-l2"><a class="reference internal" href="configuration/snapshotting.html#cron-snapshotting"><code class="docutils literal notranslate"><span class="pre">cron</span></code> Snapshotting</a><ul>
<li class="toctree-l3"><a class="reference internal" href="configuration/snapshotting.html#timestamp-format">Timestamp Format</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="configuration/snapshotting.html#manual-snapshotting"><code class="docutils literal notranslate"><span class="pre">manual</span></code> Snapshotting</a></li>
<li class="toctree-l2"><a class="reference internal" href="configuration/snapshotting.html#pre-and-post-snapshot-hooks">Pre- and Post-Snapshot Hooks</a><ul>
<li class="toctree-l3"><a class="reference internal" href="configuration/snapshotting.html#command-hooks"><code class="docutils literal notranslate"><span class="pre">command</span></code> Hooks</a></li>
<li class="toctree-l3"><a class="reference internal" href="configuration/snapshotting.html#postgres-checkpoint-hook"><code class="docutils literal notranslate"><span class="pre">postgres-checkpoint</span></code> Hook</a></li>
<li class="toctree-l3"><a class="reference internal" href="configuration/snapshotting.html#mysql-lock-tables-hook"><code class="docutils literal notranslate"><span class="pre">mysql-lock-tables</span></code> Hook</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="configuration/prune.html">Pruning Policies</a><ul>
<li class="toctree-l2"><a class="reference internal" href="configuration/prune.html#policy-not-replicated">Policy <code class="docutils literal notranslate"><span class="pre">not_replicated</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="configuration/prune.html#policy-grid">Policy <code class="docutils literal notranslate"><span class="pre">grid</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="configuration/prune.html#policy-last-n">Policy <code class="docutils literal notranslate"><span class="pre">last_n</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="configuration/prune.html#policy-regex">Policy <code class="docutils literal notranslate"><span class="pre">regex</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="configuration/prune.html#source-side-snapshot-pruning">Source-side snapshot pruning</a><ul>
<li class="toctree-l3"><a class="reference internal" href="configuration/prune.html#workaround-using-snap-job">Workaround using <code class="docutils literal notranslate"><span class="pre">snap</span></code> job</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="configuration/logging.html">Logging</a><ul>
<li class="toctree-l2"><a class="reference internal" href="configuration/logging.html#default-configuration">Default Configuration</a></li>
<li class="toctree-l2"><a class="reference internal" href="configuration/logging.html#building-blocks">Building Blocks</a><ul>
<li class="toctree-l3"><a class="reference internal" href="configuration/logging.html#levels">Levels</a></li>
<li class="toctree-l3"><a class="reference internal" href="configuration/logging.html#formats">Formats</a></li>
<li class="toctree-l3"><a class="reference internal" href="configuration/logging.html#outlets">Outlets</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="configuration/logging.html#stdout-outlet"><code class="docutils literal notranslate"><span class="pre">stdout</span></code> Outlet</a></li>
<li class="toctree-l2"><a class="reference internal" href="configuration/logging.html#syslog-outlet"><code class="docutils literal notranslate"><span class="pre">syslog</span></code> Outlet</a></li>
<li class="toctree-l2"><a class="reference internal" href="configuration/logging.html#tcp-outlet"><code class="docutils literal notranslate"><span class="pre">tcp</span></code> Outlet</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="configuration/monitoring.html">Monitoring</a><ul>
<li class="toctree-l2"><a class="reference internal" href="configuration/monitoring.html#prometheus-grafana">Prometheus &amp; Grafana</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="configuration/misc.html">Miscellaneous</a><ul>
<li class="toctree-l2"><a class="reference internal" href="configuration/misc.html#runtime-directories-unix-sockets">Runtime Directories &amp; UNIX Sockets</a></li>
<li class="toctree-l2"><a class="reference internal" href="configuration/misc.html#durations-intervals">Durations &amp; Intervals</a></li>
</ul>
</li>
</ul>
</div>
</section>


           </div>
          </div>
          <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
        <a href="installation/what-next.html" class="btn btn-neutral float-left" title="What next?" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
        <a href="configuration/overview.html" class="btn btn-neutral float-right" title="Overview &amp; Terminology" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
    </div>

  <hr/>

  <div role="contentinfo">
    <p>&#169; Copyright 2017-2023, Christian Schwarz.</p>
  </div>

  Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
    provided by <a href="https://readthedocs.org">Read the Docs</a>.
   

</footer>
        </div>
      </div>
    </section>
  </div>
  
<div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
  <span class="rst-current-version" data-toggle="rst-current-version">
    <span class="fa fa-book"> Other Versions</span>
    v: stable
    <span class="fa fa-caret-down"></span>
  </span>
  <div class="rst-other-versions">
    <dl>
      <dt>Tags</dt>
      <dd><a href="v0.6.1/configuration.html">v0.6.1</a></dd>
      <dd><a href="v0.5.0/configuration.html">v0.5.0</a></dd>
      <dd><a href="v0.4.0/configuration.html">v0.4.0</a></dd>
      <dd><a href="v0.3.1/configuration.html">v0.3.1</a></dd>
      <dd><a href="v0.2.1/configuration.html">v0.2.1</a></dd>
      <dd><a href="v0.1.1/configuration.html">v0.1.1</a></dd>
    </dl>
    <dl>
      <dt>Branches</dt>
      <dd><a href="configuration.html">stable</a></dd>
      <dd><a href="master/configuration.html">master</a></dd>
    </dl>
  </div>
</div><script>
      jQuery(function () {
          SphinxRtdTheme.Navigation.enable(true);
      });
  </script> 

</body>
</html>