Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Chronial committed Aug 16, 2019
1 parent 3964935 commit 1204c00
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,23 @@
# Snapraid Runner Script

This script runs snapraid, and sends it output to the console, a log file and
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 runs on both python2 and python3.

## How to use
* If you don’t already have it, download and install
[the latest python 2.7](http://www.python.org/getit/).
[the latest python version](https://www.python.org/downloads/).
* 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`.
* 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
Expand All @@ -24,7 +27,8 @@ scheduler.
* Can run `scrub` after `sync`

## Changelog
### Unreleased
### v0.4 (17 Aug 2019)
* Add compatibility with python3 (by reed-jones)
* Add support for running `snapraid touch` (by ShoGinn, PR-11)
* Add SMTP TLS support

Expand Down

0 comments on commit 1204c00

Please sign in to comment.