<!-- vale RedHat.Headings = NO -->
# zfs-replicate
<!-- vale RedHat.Headings = YES -->
<https://github.com/alunduil/zfs-replicate>
By Alex Brandt <alunduil@gmail.com>
## Description
zfs-replicate sends all Zettabyte File System (ZFS) snapshots to a remote host by SSH. zfs-replicate
does **not** create ZFS snapshots.
zfs-replicate forks [autorepl.py] used by [`FreeNAS`].
zfs-replicate relates to several other projects, which fit other niches:
1. [sanoid]: A full snapshot management system. Its companion,
`syncoid`, handles replication with copious options.
1. [zfs-replicate (BASH)]: A similar project. The major differences include
configuration style and system expectations (for example, logging controls).
zfs-replicate uses parameters whereas zfs-replicate (BASH) uses a BASH script.
1. [znapzend]: Another scheduling and replicating system.
1. [zrep]: A SH script with several control commands for snapshot replication.
## Terms of use
You are free to copy, change, and distribute zfs-replicate with attribution
under the terms of the `BSD-2-Clause` licence. See the [LICENSE] for details.
## Prerequisites
1. A remote system with a ZFS filesystem and the `zfs` command-line tools
1. SSH access to that remote system
1. If you're not using the root user remotely:
1. Ensure the user can mount filesystems
1. [FreeBSD]: `sysctl -w vfs.usermount=1`
1. Add ZFS permissions
1. Command: `zfs allow ${USER} ${PERMISSIONS} ${BACKUP_DATASET}`
1. Permissions
1. `clone`
1. `create`
1. `destroy`
1. `hold`
1. `mount`
1. `promote`
1. `quota`
1. `readonly`
1. `receive`
1. `rename`
1. `reservation`
1. `rollback`
1. `send`
1. `snapshot`
1. A local ZFS filesystem and `zfs` command-line tools
_N.B., don't use the root user to access your remote system._
## How to use zfs-replicate
1. `poetry install`
1. `poetry run -- zfs-replicate --help`
## Documentation
* `zfs-replicate --help`: Help for zfs-replicate.
* [LICENSE]: Licence file explaining usage of zfs-replicate.
* [Survey of ZFS Replication Tools][survey]: Overview of various ZFS replication
tools and their uses.
* [Working With Oracle Solaris ZFS Snapshots and Clones]: Oracle's guide to
working with ZFS snapshots.
<!-- vale RedHat.Definitions = NO -->
* [ZFS REMOTE REPLICATION SCRIPT WITH REPORTING]
<!-- vale RedHat.Definitions = YES -->
* [ZFS replication without using Root user]: How to configure ZFS replication
for a non-root user.
## Getting support
* [GitHub issues]: Report any problems or features requests to GitHub issues.
[autorepl.py]: https://github.com/freenas/freenas/blob/master/gui/tools/autorepl.py
[FreeBSD]: https://www.freebsd.org/
[`FreeNAS`]: http://www.freenas.org/
[GitHub issues]: https://github.com/alunduil/zfs-replicate/issues
[LICENSE]: ./LICENSE
[sanoid]: https://github.com/jimsalterjrs/sanoid
[survey]: https://www.reddit.com/r/zfs/comments/7fqu1y/a_small_survey_of_zfs_remote_replication_tools/
[Working With Oracle Solaris ZFS Snapshots and Clones]: https://docs.oracle.com/cd/E26505_01/html/E37384/gavvx.html#scrolltoc
[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/
Raw data
{
"_id": null,
"home_page": "https://github.com/alunduil/zfs-replicate",
"name": "zfs-replicate",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0.0,>=3.8.0",
"maintainer_email": null,
"keywords": "zfs, replication, backup, remote",
"author": "Alex Brandt",
"author_email": "alunduil@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/96/a3/52481e2fbce21f1351a06302d1e5b2c2761a9c7bbe4bfe4121ee5490e673/zfs_replicate-3.2.13.tar.gz",
"platform": null,
"description": "<!-- vale RedHat.Headings = NO -->\n# zfs-replicate\n<!-- vale RedHat.Headings = YES -->\n\n<https://github.com/alunduil/zfs-replicate>\n\nBy Alex Brandt <alunduil@gmail.com>\n\n## Description\n\nzfs-replicate sends all Zettabyte File System (ZFS) snapshots to a remote host by SSH. zfs-replicate\ndoes **not** create ZFS snapshots.\n\nzfs-replicate forks [autorepl.py] used by [`FreeNAS`].\n\nzfs-replicate relates to several other projects, which fit other niches:\n\n1. [sanoid]: A full snapshot management system. Its companion,\n `syncoid`, handles replication with copious options.\n1. [zfs-replicate (BASH)]: A similar project. The major differences include\n configuration style and system expectations (for example, logging controls).\n zfs-replicate uses parameters whereas zfs-replicate (BASH) uses a BASH script.\n1. [znapzend]: Another scheduling and replicating system.\n1. [zrep]: A SH script with several control commands for snapshot replication.\n\n## Terms of use\n\nYou are free to copy, change, and distribute zfs-replicate with attribution\nunder the terms of the `BSD-2-Clause` licence. See the [LICENSE] for details.\n\n## Prerequisites\n\n1. A remote system with a ZFS filesystem and the `zfs` command-line tools\n1. SSH access to that remote system\n1. If you're not using the root user remotely:\n 1. Ensure the user can mount filesystems\n 1. [FreeBSD]: `sysctl -w vfs.usermount=1`\n 1. Add ZFS permissions\n 1. Command: `zfs allow ${USER} ${PERMISSIONS} ${BACKUP_DATASET}`\n 1. Permissions\n 1. `clone`\n 1. `create`\n 1. `destroy`\n 1. `hold`\n 1. `mount`\n 1. `promote`\n 1. `quota`\n 1. `readonly`\n 1. `receive`\n 1. `rename`\n 1. `reservation`\n 1. `rollback`\n 1. `send`\n 1. `snapshot`\n1. A local ZFS filesystem and `zfs` command-line tools\n\n_N.B., don't use the root user to access your remote system._\n\n## How to use zfs-replicate\n\n1. `poetry install`\n1. `poetry run -- zfs-replicate --help`\n\n## Documentation\n\n* `zfs-replicate --help`: Help for zfs-replicate.\n* [LICENSE]: Licence file explaining usage of zfs-replicate.\n* [Survey of ZFS Replication Tools][survey]: Overview of various ZFS replication\n tools and their uses.\n* [Working With Oracle Solaris ZFS Snapshots and Clones]: Oracle's guide to\n working with ZFS snapshots.\n<!-- vale RedHat.Definitions = NO -->\n* [ZFS REMOTE REPLICATION SCRIPT WITH REPORTING]\n<!-- vale RedHat.Definitions = YES -->\n* [ZFS replication without using Root user]: How to configure ZFS replication\n for a non-root user.\n\n## Getting support\n\n* [GitHub issues]: Report any problems or features requests to GitHub issues.\n\n[autorepl.py]: https://github.com/freenas/freenas/blob/master/gui/tools/autorepl.py\n[FreeBSD]: https://www.freebsd.org/\n[`FreeNAS`]: http://www.freenas.org/\n[GitHub issues]: https://github.com/alunduil/zfs-replicate/issues\n[LICENSE]: ./LICENSE\n[sanoid]: https://github.com/jimsalterjrs/sanoid\n[survey]: https://www.reddit.com/r/zfs/comments/7fqu1y/a_small_survey_of_zfs_remote_replication_tools/\n[Working With Oracle Solaris ZFS Snapshots and Clones]: https://docs.oracle.com/cd/E26505_01/html/E37384/gavvx.html#scrolltoc\n[ZFS REMOTE REPLICATION SCRIPT WITH REPORTING]: https://techblog.jeppson.org/2014/10/zfs-remote-replication-script-with-reporting/\n[zfs-replicate (BASH)]: https://github.com/leprechau/zfs-replicate\n[ZFS replication without using Root user]: https://forums.freenas.org/index.php?threads/zfs-replication-without-using-root-user.21731/\n[znapzend]: http://www.znapzend.org/\n[zrep]: http://www.bolthole.com/solaris/zrep/\n",
"bugtrack_url": null,
"license": "BSD-2-Clause",
"summary": "ZFS Snapshot Replicator",
"version": "3.2.13",
"project_urls": {
"Homepage": "https://github.com/alunduil/zfs-replicate",
"Repository": "https://github.com/alunduil/zfs-replicate"
},
"split_keywords": [
"zfs",
" replication",
" backup",
" remote"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "25f068b59c76d76b8f0b1545d88b936a93572306f48fd77e4b4cf2591ca66eba",
"md5": "023fe6ad8dbf9a9ea268e524c208c795",
"sha256": "7389023ae817d4983dd8bf9b90ec532baaf5987efe4c53ca1554f2dc3593606c"
},
"downloads": -1,
"filename": "zfs_replicate-3.2.13-py3-none-any.whl",
"has_sig": false,
"md5_digest": "023fe6ad8dbf9a9ea268e524c208c795",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0.0,>=3.8.0",
"size": 19990,
"upload_time": "2024-04-15T09:24:15",
"upload_time_iso_8601": "2024-04-15T09:24:15.080861Z",
"url": "https://files.pythonhosted.org/packages/25/f0/68b59c76d76b8f0b1545d88b936a93572306f48fd77e4b4cf2591ca66eba/zfs_replicate-3.2.13-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "96a352481e2fbce21f1351a06302d1e5b2c2761a9c7bbe4bfe4121ee5490e673",
"md5": "76dac439e90886a472ab4c8d96972fae",
"sha256": "5e6837ddbaacde04095aa90236259851e9b7a3a5ecc697db1c856f2ecff60fde"
},
"downloads": -1,
"filename": "zfs_replicate-3.2.13.tar.gz",
"has_sig": false,
"md5_digest": "76dac439e90886a472ab4c8d96972fae",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0.0,>=3.8.0",
"size": 16002,
"upload_time": "2024-04-15T09:24:16",
"upload_time_iso_8601": "2024-04-15T09:24:16.287019Z",
"url": "https://files.pythonhosted.org/packages/96/a3/52481e2fbce21f1351a06302d1e5b2c2761a9c7bbe4bfe4121ee5490e673/zfs_replicate-3.2.13.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-15 09:24:16",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "alunduil",
"github_project": "zfs-replicate",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "zfs-replicate"
}
JSON
