MREFD ref-dash

This is the dashboard as seen on M17-M17 Reflector to be used with mrefd.

Version 1.3.0 - mrefd v0.3.0 and introducing health checks!

Non-breaking change to config.inc.php - if you intend on using the health checks, either create a new config file from config.inc.php.dist or insert the line containing $CallHome['GUID'] to your existing configuration file. Follow the instructions below for setting up health checks!

Clone dashboard to /var/www

sudo rm /var/www/html
sudo git clone https://github.com/m17-project/ref-dash /var/www/html     # or where ever your system www root is located

Please note that your www root directory might be some place else. There is one file that needs configuration. Edit the copied files, not the ones from the repository:

cd /var/www/html/include
sudo cp config.inc.php.dist config.inc.php

Customizations

• Homepage link
  • edit config.ini.php to change the logo to link to your homepage. Defaults to the M17 website.
• Logo file
  • place your logo in /images (SVG preferred) and edit config.ini.php to change the logo image. Defaults to the M17 logo.

Health Checks

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.

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.
• You will receive two emails when registration is completed, one to verify ownership of the contact email, and one with your GUID.
• Place the GUID you received into the config.inc.php $CallHome['GUID'] line.
• Set up a cron job to run the check.php script every 5 minutes.

sudo crontab -e

*/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"

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.

Files to edit

• include/config.inc.php
  • ContactEmail - set this to the sysop's email address
  • IPV4 - set this to the IPv4 address of the reflector
  • IPV6 - set this to the IPv6 address of the reflector, if not used, enter NONE
  • Homepage - set this to your homepage, defaults to m17project
  • Logo - set this to the filename of your logo, defaults to M17 logo
  • LocalModification - set this to your local modification version number if you modify the main code
  • CallHome GUID - Set this to your assigned Health Check GUID

Caveat

If you notice that the formatting of the page does not look correct, please be sure to clear your browser's cache!