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
+8-6Lines changed: 8 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,12 +22,12 @@ Contributions are welcome!
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
25
-
- Docker container management, if enabled, will manage containers before SnapRAID activity and restore them when finished. This avoids nasty errors aboud data being written during SnapRAID sync.
26
-
- You can either choose to pause or stop your containers.
27
-
- Important messages are sent to the system log, at least on OMV.
25
+
- Docker container management, if enabled, will manage containers before SnapRAID activity and restore them when finished. It avoids nasty errors aboud data being written during SnapRAID sync.
26
+
- You can either choose to pause or stop your containers and manage a remote docker host.
27
+
- Important messages are sent to the system log.
28
28
29
29
## Customization
30
-
Many options can be changed to your taste, their behavior is documented in the script config file.
30
+
Many options can be changed to your taste, their behavior is documented in the config file.
31
31
If you don't know what to do, I recommend using the default values and see how it performs.
32
32
33
33
### Customizable features
@@ -46,7 +46,7 @@ If you don't know what to do, I recommend using the default values and see how i
46
46
- A list of containers you want to be interrupted before running actions and restored when completed.
47
47
- Docker mode - choose to pause/unpause or to stop/restart your containers
48
48
- Docker remote - if docker is running on a remote machine
49
-
- Verbosity - disabled by default. When enabled, includes the TOUCH and DIFF commands output, email will be huge and unreadable.
49
+
- Verbosity option - disabled by default. When enabled, includes the TOUCH and DIFF commands output. Please note email will be huge and mostly unreadable.
50
50
- Spindown - spindown drives after the script, disabled because is currently not working.
51
51
- Snapraid Status - shows the status of the array, disabled by default.
52
52
@@ -59,6 +59,8 @@ You can re-enable full output in the email by switching the option `VERBOSITY` b
59
59
60
60
Here's a sneak peek of the email report.
61
61
62
+
**TO BE UPDATED **
63
+
62
64
```markdown
63
65
## [COMPLETED] DIFF + SYNC + SCRUB Jobs (SnapRAID on omv-test.local)
64
66
@@ -190,7 +192,7 @@ Email address is set. Sending email report to example@example.com [Sat Jan 9 02:
190
192
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.
191
193
192
194
1. Install markdown `apt install python-markdown`. You can skip this step since the script will check and install it for you.
193
-
2. Download config file and script, to be placed wherever you prefer e.g. `/usr/sbin/snapraid`
195
+
2. Download the zip and extract wherever you prefer e.g. `/usr/sbin/snapraid`
194
196
3. Give executable rights to the main script - `chmod +x snapraid-aio-script.sh`
195
197
4. Edit the config file and add your email address at line 9
196
198
5. Make other changes to the config file as required
0 commit comments