M17_Project
/
ref-dash
mirror of https://github.com/M17-Project/ref-dash.git
1
0
Fork 0
Code Issues Releases Wiki Activity

upadte README

main
kc1awv 2020-11-09 17:58:50 -05:00
parent 0a188e1dc8
commit d0352e642a
1 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -28,7 +28,9 @@ sudo cp config.inc.php.dist config.inc.php
### Health Checks ### Health Checks
M17 Reflector Dashboard can now send health check data to the M17 Reflector team. M17 Reflector Dashboard can now send health check data to the M17 Reflector team.
In order to reduce spam, the M17 Check system is a double opt-in transaction. What this means is you submit your address to the M17 Reflector Team, and you will be manually sent an email to verify ownership of that address. If you should ever wish to stop receiving M17 Check emails, simply use the Unsubscribe link found in any notification email. In order to reduce spam, the M17 Check system is a double opt-in transaction. What this means is you submit your address to the M17 Reflector Team, and you will be manually sent an email to verify ownership of that address. If you should ever wish to stop receiving M17 Check emails, simply use the Unsubscribe link found in any notification email.
To subscribe to the M17 Check service: To subscribe to the M17 Check service:
- Send an email to contact@m17.link with your reflector name and a contact email for the responsible party of the reflector. - Send an email to contact@m17.link with your reflector name and a contact email for the responsible party of the reflector.
- You will receive two emails when registration is completed, one to verify ownership of the contact email, and one with your GUID. - You will receive two emails when registration is completed, one to verify ownership of the contact email, and one with your GUID.
@ -39,8 +41,10 @@ sudo crontab -e
*/5 * * * * cd /var/www/html && php check.php # change the cd to wherever your system www root is located */5 * * * * cd /var/www/html && php check.php # change the cd to wherever your system www root is located
``` ```
** It is important that you set your cron job to run every 5 minutes, else your status will show "Late" or "Down" ** **It is important that you set your cron job to run every 5 minutes, else your status will show "Late" or "Down"**
If the M17 Check service does not receive a ping from your reflector when expected, your status will show "Late" on the reflector list. A grace period of another 5 minutes will wait for a late ping to arrive. If a ping is not received within the grace period, an email will be sent to the registered email address to let you know that your reflector may be offline. Once a new ping arrives, your status will show "Up", and you will receive an email notifying you of the status change. If the M17 Check service does not receive a ping from your reflector when expected, your status will show "Late" on the reflector list. A grace period of another 5 minutes will wait for a late ping to arrive. If a ping is not received within the grace period, an email will be sent to the registered email address to let you know that your reflector may be offline. Once a new ping arrives, your status will show "Up", and you will receive an email notifying you of the status change.
Again, as an effort to reduce spam, you will only receive *one* email notifying a reflector offline, and *one* email notifying you when it is back online. Again, as an effort to reduce spam, you will only receive *one* email notifying a reflector offline, and *one* email notifying you when it is back online.
### Files to edit ### Files to edit