Skip to content

Commit

Permalink
Merge pull request #344 from leiweibau/next_update
Browse files Browse the repository at this point in the history
Next update
  • Loading branch information
leiweibau authored Jul 22, 2024
2 parents d724086 + 8cd752e commit 0fee6b1
Show file tree
Hide file tree
Showing 3 changed files with 36 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,8 +55,8 @@ The backend is started at regular intervals via cronjobs of the user who install

The system scans the network to detect connected devices using various scanning methods as described above.
It also verifies the accessibility of web services and notifies about any changes in SSL certificates.
The gathered information is stored in the database. Detected changes are reported via email and/or other services
such as [Pushsafer](https://www.pushsafer.com/), [Pushover](https://pushover.net/), ntfy and Telegram through [shoutrrr](docs/SHOUTRRR.md), as well as to the Frontend. Automated
The gathered information is stored in the database. Detected changes are reported via mail ([Guide](docs/NOTIFICATION_MAIL.md)) and/or other services
such as [Pushsafer](https://www.pushsafer.com/), [Pushover](https://pushover.net/), ntfy and Telegram through shoutrrr ([Guide](docs/NOTIFICATION_SHOUTRRR.md)), as well as to the Frontend. Automated
tasks for cleaning up and optionally backing up the database are also performed. Additionally, optional speed tests of the Internet
connection can be conducted. Users can utilize the [pialert-cli](docs/PIALERTCLI.md) tool to configure login, password, and other
settings conveniently.
Expand Down
34 changes: 34 additions & 0 deletions docs/NOTIFICATION_MAIL.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
## Configure Mail Notification

During the setup, you have the opportunity to configure the mail. Pi.Alert does not use this
configuration by default, as only the notification via the web interface is activated after installation.
the installation is activated.

Screenshot Status Box
![Mail deactivated][status_box_no_mail]

To change this, you can open the Config File Editor under Settings, at the bottom of the page, and under
“Mail Reporting” the entries `REPORT_MAIL`, and if you want to use the Web Service Monitoring,
set `REPORT_MAIL_WEBMON` from `False` to `True`. After saving, the status box should now look like this.

| ![Config File Editor][config_file_editor] | ![Mail activated][status_box_mail] |
| ----------------------------------------- | ---------------------------------- |

To check whether the configuration is successful, you can click on the “Test Notifications” button. A message will
now be sent via all activated notification services. If no notification arrives by email, additional configuration
may be necessary in the relevant mail account. Services (Gmail, iCloud, Outlook) that work with 2FA authentication
usually use specific “app passwords” to allow services to access the mailbox. Here it is now necessary
configure a corresponding app password for Pi.Alert.

[Gmail Support Document](https://support.google.com/accounts/answer/185833?p=InvalidSecondFactor)

[iCloud Support Document](https://support.apple.com/en-us/102654)

[Outlook Support Document](https://support.microsoft.com/en-us/account-billing/how-to-get-and-use-app-passwords-5896ed9b-4263-e681-128a-a6f2979a7944)

[Back](https://github.com/leiweibau/Pi.Alert)

<!--- --------------------------------------------------------------------- --->
[status_box_no_mail]: https://raw.githubusercontent.com/leiweibau/Pi.Alert/assets/notification_mail_01.png "Mail deactivated"
[config_file_editor]: https://raw.githubusercontent.com/leiweibau/Pi.Alert/assets/notification_mail_02.png "Config File Editor"
[status_box_mail]: https://raw.githubusercontent.com/leiweibau/Pi.Alert/assets/notification_mail_03.png "Mail activated"
File renamed without changes.

0 comments on commit 0fee6b1

Please sign in to comment.