https://github.com/firasdib/snapper
Probably the best SnapRAID runner.
https://github.com/firasdib/snapper
snapraid snapraid-configuration snapraid-sync
Last synced: about 1 month ago
JSON representation
Probably the best SnapRAID runner.
- Host: GitHub
- URL: https://github.com/firasdib/snapper
- Owner: firasdib
- License: mit
- Created: 2023-09-25T17:56:49.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-07-24T11:27:42.000Z (10 months ago)
- Last Synced: 2025-04-17T07:17:38.942Z (about 1 month ago)
- Topics: snapraid, snapraid-configuration, snapraid-sync
- Language: Python
- Homepage:
- Size: 50.8 KB
- Stars: 16
- Watchers: 2
- Forks: 4
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# :turtle: Snapper
Snapper is a simple python script that executes [SnapRAID](https://github.com/amadvance/snapraid) in order to sync and scrub the array. Inspired by the great [snapraid-aio-script](https://github.com/auanasgheps/snapraid-aio-script) with a limited feature set.
The reason I created this is that I wanted more granular control of how my setup worked, which consequently means, this script is opinionated.
## Features
- Sanity checks the array
- Runs `touch` if necessary
- Runs `diff` before attempting to `sync`
- Allows you to pre-hash before syncing
- Allows you to automatically re-run `sync` if snapraid recommends it
- Allows you to run snapraid with a lower priority to keep server and drives responsive
- Allows you to abort execution if configurable thresholds are broken
- Allows you to `scrub` after `sync`
- Allows delay of `scrub` job to every N invocations
- Logs the raw snapraid output as well as formatted text
- Creates a nicely formatted report and sends it via email or discord
- Provides live insight into the sync/scrub process in Discord
- Spin down selected hard drives after script completion
**This project is a work in progress, and can change at any time.**
I welcome bugfixes and contributions, but be aware that I will not merge PRs that I do not feel do not fit the usage of this tool.
## Requirements
- SnapRAID 12.2 or later
- Python 3.7 or later
## How to use
- Install the necessary dependencies by running `pip3 install -r requirements.txt`
- Download the [latest release](https://github.com/firasdib/snapper/releases/latest) of this project, or clone the git project.
- Copy or rename `config.json.example` to `config.json`
- Run the script via `python3 snapper.py`
You may run the script with the `--force` flag to force a sync/scrub and ignore any thresholds or sanity checks.
## Configuration
A `config.json` file is required and expected to be in the same root as this script.
Please read through the [json schema](config.schema.json) to understand the exact details of each property. If you're not fluent in json schema (I don't blame you), you could use something like [this](https://json-schema.app/view/%23?url=https%3A%2F%2Fraw.githubusercontent.com%2Ffirasdib%2Fsnapper%2Fmain%2Fconfig.schema.json) to get a better idea of the different options.