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
+19-8Lines changed: 19 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,17 +20,30 @@ _This readme has some rough edges which will be smoothened over time._
20
20
- One of the following will happen:
21
21
- If parity info is out of sync **and** the number of deleted or changed files exceed the threshold you have configured it **stops**. You may want to take a look to the output log.
22
22
- 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"
23
-
- If parity info is out of sync **but** the number of deleted or changed files did not exceed the treshold, it **executes a sync** to update the parity info.
23
+
- 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.
24
24
- 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._
25
25
- Extra information is be added, like SnapRAID's disk health report.
26
26
- When the script is done sends an email with the results, both in case of error or success.
27
27
28
28
## Customization
29
-
Many options can be changed to your taste, their behaviour is documented in the script config file.
30
-
31
-
Pre-hashing is enabled by default to avoid silent read errors. It mitigates the lack of ECC memory.
32
-
33
-
If you don't know what to do, I recommend using the default values and see how it performs.
29
+
Many options can be changed to your taste, their behavior is documented in the script config file.
30
+
If you don't know what to do, I recommend using the default values and see how it performs.
31
+
32
+
### Customizable features
33
+
- Sync options
34
+
- Sync always (forced sync)
35
+
- Sync after a number of breached threshold warnings
36
+
- Sync only if thresholds warnings are not breached (enabled by default)
37
+
- Thresholds for deleted and updated files
38
+
- Scrub options
39
+
- Enable or disable scrub
40
+
- Data to be scrubbed - by default 5% older than 10 days
41
+
- Pre-hashing - enabled by default to avoid silent read errors. It mitigates the lack of ECC memory.
42
+
- SMART Log - enabled by default, a SnapRAID report for disks health status
43
+
- Verbosity - disabled by default, does not include the TOUCH and DIFF output to have a better email
44
+
- Spindown - to spindown drives after the script, disabled because is currently not working
45
+
- Snapraid Status - show the status of the array, disabled because the report output is not rendered correctly
46
+
34
47
35
48
You can also change more advanced options such as mail binary (by default uses `mailx`), SnapRAID binary location, log file location.
36
49
@@ -39,8 +52,6 @@ This report produces emails that don't contain a list of changed files to improv
39
52
40
53
You can re-enable full output in the email by switching the option `VERBOSITY` but the full report will always be available in `/tmp/snapRAID.out` but will be replaced after each run, or deleted when the system is shut down. You can change the location of the file, if needed.
41
54
42
-
SMART drive report from SnapRAID is also included by default.
0 commit comments