Skip to content

Commit a46c736

Browse files
authored
Update README.md
Introduce Apprise email notification
1 parent 8a1d151 commit a46c736

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -103,11 +103,13 @@ If you don't know what to do, I recommend using the default values and see how i
103103
- If you don't read your emails every day, this is a great one for you, since you can be quickly informed if things go wrong.
104104
- The script will report when it's started and when it's completed. If there's a failure, it's notified as well.
105105
- You can choose to get the output attached if there's a warning (only supported by some services, check Apprise docs)
106+
- Email report via [Apprise](https://github.com/caronc/apprise)
107+
- If your distro doesn't have `mailx` or `sendmail`, you can use Apprise to deliver your email reports
106108
- Notification Hook **[deprecated, use Apprise]**
107109
- Made for external services or mail binaries with different commands than `mailx`.
108110
- Configure the path of the script or the mail binary to be invoked.
109111
- You can still use native services since it only replaces the standard email.
110-
- You can choose to run the final hook before or after the spindown command, if configured.
112+
- You can choose to run the final hook before or after the spindown command, if configured.
111113
- Update Check - enabled by default
112114
- The script will check via GitHub if there's an update and alert the user via the configured notification systems
113115
- If you don't like this, it can be disabled
@@ -124,7 +126,7 @@ If you don't know what to do, I recommend using the default values and see how i
124126
- Spindown - spindown disks after the script has completed operations. Uses a rewritten version of [hd-idle](https://github.com/adelolmo/hd-idle).
125127

126128

127-
You can also change more advanced options such SnapRAID binary location, log file location and mail binary. If your mail binary uses different commands than `mailx`, use the Notification Hook feature.
129+
You can also change more advanced options such SnapRAID binary location, log file location and mail binary.
128130

129131
## A nice email report
130132
This script produces emails that don't contain a list of changed files to improve clarity.
@@ -298,7 +300,6 @@ Dependencies that require manual installation:
298300

299301
# Installation
300302

301-
302303
1. Install the packages listed in the Requirements section if you're not running a distro with `apt` package manager
303304
2. Download the latest version from [Releases](https://github.com/auanasgheps/snapraid-aio-script/releases)
304305
3. Extract the archive wherever you prefer
@@ -318,8 +319,7 @@ It is tested on OMV6 and OMV7, but will work on other distros. In such case you
318319

319320
### OMV7 USERS
320321
OMV7's SnapRAID plugins introduced support for multiple arrays. This means each SnapRAID config file does not have a predictable name, unlike what occurred with OMV6 or standard SnapRAID installs.
321-
If running on OMV7, the AIO Script will search for a SnapRAID configuration file in the new path `/etc/snapraid/`. If multiple arrays are found, it will inform you to adjust your configuration.
322-
322+
When running on OMV7, the AIO Script will search for a single SnapRAID configuration file in the new path `/etc/snapraid/`. If multiple arrays are found, it will inform you to adjust your configuration.
323323

324324
## First Run
325325
If you start with empty disks, you cannot use (yet) this script, since it expects SnapRAID files which would not be found.

0 commit comments

Comments
 (0)