From 1e8a90a9cb41dd02421d3e2704b283024211b4c1 Mon Sep 17 00:00:00 2001 From: Chronial Date: Sun, 16 Feb 2014 11:10:02 +0000 Subject: [PATCH] Added license and readme --- LICENSE.txt | 21 +++++++++++++++++++++ README.md | 24 ++++++++++++++++++++++++ 2 files changed, 45 insertions(+) create mode 100644 LICENSE.txt create mode 100644 README.md diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..785929e --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,21 @@ +The MIT License (MIT) + +Copyright (c) 2014 Christian Fersch + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..426e0f6 --- /dev/null +++ b/README.md @@ -0,0 +1,24 @@ +# Snapraid Runner Script + +This script runs snapraid, and sends it 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. + +## How to use +* If you don’t already have it, download and install + [the latest python 2.7](http://www.python.org/getit/). +* Download [the latest release](https://github.com/Chronial/snapraid-runner/releases) + 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.exectable` and + `snapraid.config`. +* Run the script via `python snapraid-runner.py`. + +## 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`