Added license and readme

This commit is contained in:
Chronial committed 2014-02-16 11:10:02 +00:00
1 parent 37c0d52cef
commit 1e8a90a9cb
2 files changed
+45

No files matched your search

+21
View File
@@ -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.
+24
View File
@@ -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`