{"id":26728317,"url":"https://github.com/mojtabamoaddab/zfshotter","last_synced_at":"2026-04-28T11:35:01.939Z","repository":{"id":282985733,"uuid":"945461819","full_name":"mojtabamoaddab/zfshotter","owner":"mojtabamoaddab","description":"ZFShotter is a utility designed to automate the creation of ZFS snapshots and replicate them to remote servers","archived":false,"fork":false,"pushed_at":"2025-12-30T16:35:42.000Z","size":64,"stargazers_count":11,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-01-03T09:24:13.276Z","etag":null,"topics":["bash-script","zfs","zfs-replication","zfs-snapshot-automation","zfs-snapshot-manager","zfs-snapshots"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mojtabamoaddab.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"COPYING","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-03-09T13:36:36.000Z","updated_at":"2025-12-30T16:35:30.000Z","dependencies_parsed_at":"2025-10-01T22:10:51.107Z","dependency_job_id":"d6d3232e-6b5d-4c3e-9d9d-32eb6b6a2dce","html_url":"https://github.com/mojtabamoaddab/zfshotter","commit_stats":null,"previous_names":["mojtabamoaddab/zfshotter"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/mojtabamoaddab/zfshotter","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mojtabamoaddab%2Fzfshotter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mojtabamoaddab%2Fzfshotter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mojtabamoaddab%2Fzfshotter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mojtabamoaddab%2Fzfshotter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mojtabamoaddab","download_url":"https://codeload.github.com/mojtabamoaddab/zfshotter/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mojtabamoaddab%2Fzfshotter/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32379498,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-28T11:25:28.583Z","status":"ssl_error","status_checked_at":"2026-04-28T11:25:05.435Z","response_time":56,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bash-script","zfs","zfs-replication","zfs-snapshot-automation","zfs-snapshot-manager","zfs-snapshots"],"created_at":"2025-03-27T22:23:02.659Z","updated_at":"2026-04-28T11:35:01.932Z","avatar_url":"https://github.com/mojtabamoaddab.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ZFShotter\n\nZFShotter is a utility designed to automate the creation of ZFS snapshots and\nreplicate them to remote servers\n\n\n## Table of Contents\n- [Features](#features)\n- [Installation](#installation)\n- [Configuration](#configuration)\n  - [Job](#job)\n  - [Datasets](#datasets)\n  - [Replication](#replication)\n- [License](#license)\n\n\n## Features\n\n- Automates the creation of ZFS snapshots.\n- Flexible prune policy pipeline to automate the pruning of old snapshots.\n- Supports replication of snapshots to remote servers (push-based via ssh).\n- Easy configuration file for customizable settings.\n\n\n## Installation\n\nTo install ZFShotter, follow these steps:\n\n1. Clone the repository to your desired directory (e.g., `/opt/`, `/usr/local/`,\n   or wherever you want). In this documentation, we will use `/usr/local`:\n\n   ```bash\n   git clone https://github.com/mojtabamoaddab/zfshotter.git /usr/local/zfshotter\n   ```\n\n2. Configure Jobs according configuration section.\n\n3. Define a job scheduler (e.g., cron or systemd-timer) to run the jobs with following command:\n\n   ```bash\n   /usr/local/zfshotter/bin/zfshotter.sh \u003cJOB_NAME\u003e\n   ```\n\n## Configuration\n\nThe configuration for ZFShotter is organized into a `config` directory,\nwhich contains three subdirectories: `jobs`, `datasets`, and `replications`.\nEach subdirectory holds `.conf` files that define the respective configurations.\n\n\n### Directory Structure\n\n```\nconfig/\n├── jobs/\n│   └── sample.conf\n├── datasets/\n│   └── sample.conf\n└── replications/\n    └── sample.conf\n```\n\n\n### Job\n\nA job is a sequence of operations that involves taking snapshots, pruning old ones,\nand then replicating them.\n\nYou can see `config/jobs/sample.conf` to possible configuration options.\n\nSupported prune-policies (can be combined with `|`):\n\n| Prune Policy          | Description                              | Example                |\n|-----------------------|------------------------------------------|------------------------|\n| `keep_all`            | Keep all snapshots (no prune)            |                        |\n| `keep_for \u003cduration\u003e` | Keep snapshots within specified duration | `keep_for 4d12h`       |\n| `keep_n \u003cn\u003e`          | Keep the last n snapshots                | `keep_n 20`            |\n| `keep_regex \u003cregex\u003e`  | Keep snapshots that match the specified regex pattern in their name | `keep_regex \"^manual\"` |\n| `keep_time_pattern \u003ctime-format\u003e \u003cregex\u003e` | Keep snapshots whose creation time (formatted as specified) matches the given regex | `keep_time_pattern \"%H\" \"00\"` |\n\n\n### Datasets\n\nThe datasets configuration file is a simple list of datasets  (for taking snapshots,\npruning, or replicating) along with some per-dataset options.\nEach line contains a dataset path followed by optional key-value pairs separated by semicolons.\n\nExample:\n```\npath/to/dataset; option1=value1; option2=value2\n```\n\n\n### Replication\n\nThis section defines the remote server for replicating snapshots and the datasets to replicate.\n\nYou can see `config/replications/sample.conf` to possible configuration options.\n\n\n\n## License\n\nThis project is licensed under the GPL-3.0-or-later License -\nsee the `COPYING` file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmojtabamoaddab%2Fzfshotter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmojtabamoaddab%2Fzfshotter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmojtabamoaddab%2Fzfshotter/lists"}