Metadata-Version: 2.1
Name: zfs-replicate
Version: 1.2.3
Summary: ZFS Snapshot Replicator
Home-page: UNKNOWN
Author: Alex Brandt
Author-email: alunduil@gmail.com
License: BSD-2
Description: Description
        -----------
        
        ZFS_ Replicate Utility
        
        A small command line utility to handle remote replication of ZFS_ snapshots
        using SSH_.
        
        This project is directly based on the autorepl.py_ script used by FreeNAS_.
        
        I am providing code in the repository to you under an open source license.
        Because this is my personal repository, the license you receive to my code is
        from me and not my employer (Facebook).
        
        Getting Started
        ---------------
        
        Usage is pretty straight-forward and documented in the command's help output.
        For more information on ZFS_ snapshots, see:
        `Working With Oracle Solaris ZFS Snapshots and Clones`_
        
        Remote Configuration
        --------------------
        
        If you're replicating using the root user's credentials, you should really
        reconsider, but this script should just work.
        
        Otherwise, you'll not only need to ensure the user you're using has SSH_ access
        to the remote host, but also can mount filesystems (if this is desirable) and
        has ZFS_ permissions configured correctly.
        
        Allow user to mount (FreeBSD_)::
        
            sysctl -w vfs.usermount=1
        
        ZFS_ Permissions::
        
            zfs allow ${USER} create,destroy,snapshot,rollback,clone,promote,rename,mount,send,receive,readonly,quota,reservation,hold ${BACKUP_DATASET}
        
        More information about this configuration can be found at the following sources:
        
        * `ZFS REMOTE REPLICATION SCRIPT WITH REPORTING`_
        * `ZFS replication without using Root user`_
        
        Compared to Other Tools
        -----------------------
        
        This tool is only for replication of snapshots.  It assumes that another system
        is creating them on a regular basis.  It also doesn't require installation of
        any special tools (other than the standard shell scripts) on the remote host.
        
        Other tools fill other niches:
        
        `sanoid`_
          A full snapshot management system.  Its companion application, syncoid,
          handles replication with many available options.
        
        `zfs-replicate (BASH)`_
          A very similar project.  The major differences are configuration style (our
          project uses parameters whereas this project uses a BASH script), and the
          system expectations (e.g., logging controls).
        
        `znapzend`_
          Another scheduling and replicating system.
        
        `zrep`_
          A SH script with several control commands for snapshot replication.
        
        More information has been captured in `this survey`_.
        
        Reporting Issues
        ----------------
        
        Any issues discovered should be recorded on Github_.  If you believe you've
        found an error or have a suggestion for a new feature, please ensure that it is
        reported.
        
        If you would like to contribute a fix or new feature, please submit a pull
        request.  This project follows `git flow`_ and utilizes travis_ to automatically
        check pull requests before a manual review.
        
        .. _autorepl.py: https://github.com/freenas/freenas/blob/master/gui/tools/autorepl.py
        .. _FreeBSD: https://www.freebsd.org/
        .. _FreeNAS: http://www.freenas.org/
        .. _git flow: http://nvie.com/posts/a-successful-git-branching-model/
        .. _Github: https://github.com/alunduil/zfs-replicate
        .. _sanoid: https://github.com/jimsalterjrs/sanoid
        .. _SSH: https://www.openssh.com/
        .. _this survey: https://www.reddit.com/r/zfs/comments/7fqu1y/a_small_survey_of_zfs_remote_replication_tools://www.reddit.com/r/zfs/comments/7fqu1y/a_small_survey_of_zfs_remote_replication_tools/
        .. _travis: https://travis-ci.org/aunduil/zfs-replicate
        .. _Working With Oracle Solaris ZFS Snapshots and Clones: https://docs.oracle.com/cd/E26505_01/html/E37384/gavvx.html#scrolltoc
        .. _ZFS: http://open-zfs.org/wiki/System_Administration
        .. _ZFS REMOTE REPLICATION SCRIPT WITH REPORTING: https://techblog.jeppson.org/2014/10/zfs-remote-replication-script-with-reporting/
        .. _zfs-replicate (BASH): https://github.com/leprechau/zfs-replicate
        .. _ZFS replication without using Root user: https://forums.freenas.org/index.php?threads/zfs-replication-without-using-root-user.21731/
        .. _znapzend: http://www.znapzend.org/
        .. _zrep: http://www.bolthole.com/solaris/zrep/
        
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: End Users/Desktop
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: System
Classifier: Topic :: System :: Archiving
Classifier: Topic :: System :: Filesystems
Requires-Python: >=3.6
Description-Content-Type: text/x-rst
