You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+10-10Lines changed: 10 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,11 +1,11 @@
1
1
# 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.
3
3
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.
5
5
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.
7
7
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).
9
9
10
10
Contributions are welcome!
11
11
@@ -18,7 +18,7 @@ Contributions are welcome!
18
18
- 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"
19
19
- 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.
20
20
- 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.
22
22
- When the script is done sends an email with the results, both in case of error or success.
23
23
24
24
### Additional Information
@@ -214,10 +214,9 @@ Email address is set. Sending email report to yourmail@example.com [Tue 20 Apr 1
214
214
215
215
# Requirements
216
216
- 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.
218
218
219
219
# 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.
221
220
222
221
1. Install markdown `apt install python-markdown`. You can skip this step since the script will check and install it for you.
223
222
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
228
227
229
228
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.
230
229
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.
232
232
233
233
# Known Issues
234
234
- Hard disk spin down does not work: they are immediately woken up. The script probably does not handle this correctly while running.
235
235
236
236
# Credits
237
237
All rights belong to the respective creators.
238
-
Thanks to:
238
+
This script would not exist without:
239
239
-[Zack Reed](https://zackreed.me/snapraid-split-parity-sync-script/) for most of the original script
240
240
-[mtompkins](https://gist.github.com/mtompkins/91cf0b8be36064c237da3f39ff5cc49d) for most of the original script
241
241
-[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
0 commit comments