Skip to content

Commit 5fc8da6

Browse files
author
Oliver Cervera
authored
Minor tweaks
1 parent ec046b8 commit 5fc8da6

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,12 @@ Contributions are welcome!
2222
- When the script is done sends an email with the results, both in case of error or success.
2323

2424
### 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.
2828

2929
## 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.
3131
If you don't know what to do, I recommend using the default values and see how it performs.
3232

3333
### Customizable features
@@ -46,7 +46,7 @@ If you don't know what to do, I recommend using the default values and see how i
4646
- A list of containers you want to be interrupted before running actions and restored when completed.
4747
- Docker mode - choose to pause/unpause or to stop/restart your containers
4848
- 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.
5050
- Spindown - spindown drives after the script, disabled because is currently not working.
5151
- Snapraid Status - shows the status of the array, disabled by default.
5252

@@ -59,6 +59,8 @@ You can re-enable full output in the email by switching the option `VERBOSITY` b
5959

6060
Here's a sneak peek of the email report.
6161

62+
**TO BE UPDATED **
63+
6264
```markdown
6365
## [COMPLETED] DIFF + SYNC + SCRUB Jobs (SnapRAID on omv-test.local)
6466

@@ -190,7 +192,7 @@ Email address is set. Sending email report to example@example.com [Sat Jan 9 02:
190192
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.
191193

192194
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`
194196
3. Give executable rights to the main script - `chmod +x snapraid-aio-script.sh`
195197
4. Edit the config file and add your email address at line 9
196198
5. Make other changes to the config file as required

0 commit comments

Comments
 (0)