Update readme
This commit is contained in:
1 parent
3964935580
commit
1204c001e1
1 file changed
+8
-4
@@ -1,20 +1,23 @@
|
|||||||
# Snapraid Runner Script
|
# 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.
|
via email. All this is configurable.
|
||||||
|
|
||||||
It can be run manually, but its main purpose is to be run via cronjob/windows
|
It can be run manually, but its main purpose is to be run via cronjob/windows
|
||||||
scheduler.
|
scheduler.
|
||||||
|
|
||||||
|
It supports Windows, Linux and macOS and runs on both python2 and python3.
|
||||||
|
|
||||||
## How to use
|
## How to use
|
||||||
* If you don’t already have it, download and install
|
* 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)
|
* Download [the latest release](https://github.com/Chronial/snapraid-runner/releases)
|
||||||
of this script and extract it anywhere or clone this repository via git.
|
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
|
* Copy/rename the `snapraid-runner.conf.example` to `snapraid-runner.conf` and
|
||||||
edit its contents. You need to at least configure `snapraid.exectable` and
|
edit its contents. You need to at least configure `snapraid.exectable` and
|
||||||
`snapraid.config`.
|
`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
|
## Features
|
||||||
* Runs `diff` before `sync` to see how many files were deleted and aborts if
|
* Runs `diff` before `sync` to see how many files were deleted and aborts if
|
||||||
@@ -24,7 +27,8 @@ scheduler.
|
|||||||
* Can run `scrub` after `sync`
|
* Can run `scrub` after `sync`
|
||||||
|
|
||||||
## Changelog
|
## 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 support for running `snapraid touch` (by ShoGinn, PR-11)
|
||||||
* Add SMTP TLS support
|
* Add SMTP TLS support
|
||||||
|
|
||||||
|
|||||||
Reference in new issue
Block a user