Skip to content

Commit 178153b

Browse files
author
Oliver Cervera
authored
More Tweaks
yeah, why not?
1 parent 449b7ae commit 178153b

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
# snapraid-aio-script
2-
The definitive all-in-one [SnapRAID](https://github.com/amadvance/snapraid) script.
2+
The definitive all-in-one [SnapRAID](https://github.com/amadvance/snapraid) script. I hope you'll agree.
33

4-
There are many SnapRAID scripts out there, but none could fit my needs. So I took the best of them to start a new one.
4+
There are many SnapRAID scripts out there, but none has the features I want. So I made my own, inspired by existing solutions.
55

6-
It is meant to be run periodically (e.g. daily), do the heavy lifting and send an email you will actually read.
6+
It is meant to be run periodically (daily), do the heavy lifting and send an email you will actually read.
77

8-
Supports single and dual parity configurations. It is customizable and has been tested with Debian 10 and [OpenMediaVault 5](https://github.com/openmediavault/openmediavault).
8+
Supports single and dual parity configurations. It is highly customizable and has been tested with Debian 10 and [OpenMediaVault 5](https://github.com/openmediavault/openmediavault).
99

1010
Contributions are welcome!
1111

@@ -18,7 +18,7 @@ Contributions are welcome!
1818
- If parity info is out of sync **and** the number of deleted or changed files exceed the threshold, you can still **force a sync** after a number of warnings. It's useful If you often get a false alarm but you're confident enough. This is called "Sync with threshold warnings"
1919
- If parity info is out of sync **but** the number of deleted or changed files did not exceed the threshold, it **executes a sync** to update the parity info.
2020
- When the parity info is in sync, either because nothing has changed or after a successfully sync, it runs the `snapraid scrub` command to validate the integrity of the data, both the files and the parity info. If sync was cancelled or other issues were found, scrub will not be run. _Note that each run of the scrub command will validate only a configurable portion of parity info to avoid having a long running job and affecting the performance of the server._ Scrub frequency can also be customized in case you don't want to do it every time the script runs. It is still recommended to run scrub frequently.
21-
- Extra information is be added, like SnapRAID's disk health report.
21+
- Extra information can be added, like SnapRAID's disk health report o SnapRAID array status.
2222
- When the script is done sends an email with the results, both in case of error or success.
2323

2424
### Additional Information
@@ -214,10 +214,9 @@ Email address is set. Sending email report to yourmail@example.com [Tue 20 Apr 1
214214

215215
# Requirements
216216
- Markdown to have nice emails - will be installed if not found
217-
- ~~Hd-idle to spin down disks - [Link TBD] - currently not required since spin down does not work properly.~~
217+
- Hd-idle to spin down disks - [Link TBD] - currently not required since spin down does not work properly.
218218

219219
# Installation
220-
If you want to use this script on OMV, don't worry about the section _Diff Script Settings_ in the main page of the SnapRAID plugin. These settings only apply to the plugin built-in script. Also don't forget to remove from scheduling the built-in script.
221220

222221
1. Install markdown `apt install python-markdown`. You can skip this step since the script will check and install it for you.
223222
2. Download the zip and extract wherever you prefer e.g. `/usr/sbin/snapraid`
@@ -228,18 +227,19 @@ If you want to use this script on OMV, don't worry about the section _Diff Scrip
228227

229228
It is tested on OMV5, but will work on other distros. In such case you may have to change the mail binary or SnapRAID location.
230229

231-
If you want to use this script on OMV, don't worry about the section _Diff Script Settings_ in the main page of the SnapRAID plugin, since it only applies to the built-in plugin script. Also don't forget to remove from scheduling the built-in script.
230+
**OMV5 and SnapRAID plugin**
231+
Ignore the page at OMV GUI > Services > SnapRAID > Diff Script Settings, since it only applies to the plugin's built-in script. Also don't forget to remove from scheduling such built-in script.
232232

233233
# Known Issues
234234
- Hard disk spin down does not work: they are immediately woken up. The script probably does not handle this correctly while running.
235235

236236
# Credits
237237
All rights belong to the respective creators.
238-
Thanks to:
238+
This script would not exist without:
239239
- [Zack Reed](https://zackreed.me/snapraid-split-parity-sync-script/) for most of the original script
240240
- [mtompkins](https://gist.github.com/mtompkins/91cf0b8be36064c237da3f39ff5cc49d) for most of the original script
241241
- [sburke](https://zackreed.me/snapraid-split-parity-sync-script/#comment-300) for the Debian 10 fix
242-
- metagliatore (a friend, not on Github) for removing the DIFF output from the email
242+
- metagliatore (a friend not on Github) for helping out on several BASH issues
243243
- [ozboss](https://forum.openmediavault.org/wsc/index.php?user/27331-ozboss/)
244244
- [tehniemer](https://github.com/tehniemer)
245245
- [cmcginty](https://github.com/cmcginty)

0 commit comments

Comments
 (0)