Snapraid Runner Script

This script runs snapraid and sends its output to the console, a log file and via email. All this is configurable.

It can be run manually, but its main purpose is to be run via cronjob/windows scheduler.

It supports Windows, Linux and macOS and requires at least python3.7.

How to use

If you don’t already have it, download and install the latest python version.
Download the latest release of this script and extract it anywhere or clone this repository via git.
Copy/rename the snapraid-runner.conf.example to snapraid-runner.conf and edit its contents. You need to at least configure snapraid.executable and snapraid.config.
Run the script via python3 snapraid-runner.py on Linux or py -3 snapraid-runner.py on Windows.

Features

Runs diff before sync to see how many files were deleted and aborts if that number exceeds a set threshold.
Can create a size-limited rotated logfile.
Can send notification emails after each run or only for failures.
Can run scrub after sync

Scope of this project and contributions

Snapraid-runner is supposed to be a small tool with clear focus. It should not have any dependencies to keep installation trivial. I always welcome bugfixes and contributions, but be aware that I will not merge new features that I feel do not fit the core purpose of this tool.

I keep the PRs for features I do not plan on merging open, so if there's a feature you are missing, you can have a look at the open PRs.

Changelog

v0.5 (26 Feb 2021)

Remove (broken) python2 support
Fix snapraid output encoding handling (by hyyz17200, #31)
Fix log rotation (by ptoulouse, #36)

v0.4 (17 Aug 2019)

Add compatibility with python3 (by reed-jones)
Add support for running snapraid touch (by ShoGinn, #11)
Add SMTP TLS support

v0.3 (20 Jul 2017)

Limit size of sent emails

v0.2 (27 Apr 2015)

Fix compatibility with Snapraid 8.0
Allow disabling of scrub from command line

v0.1 (16 Feb 2014)

Initial release

phybros/snapraid-runner