# [MREFD](https://github.com/n7tae/mrefd) ref-dash

This is the dashboard as seen on [M17-M17 Reflector](https://ref.m17.link) to be used with mrefd.

### Version 1.2.0 - code cleanup

Possible breaking change, a rename of "Repeaters" to "Links" requires use of a new copy of the configuration file to be used. Backup your old config.inc.php and follow the setup process below to update to the new configuration.

### Clone dashboard to /var/www

```bash
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:

```bash
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.
- 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 line $CallHome['GUID'] line.
- Set up a cron job to run the check.php script every 5 minutes.
```bash
sudo crontab -e

*/5 * * * * cd /var/www/html && php check.php  # change the cd to wherever your system www root is located
```

### 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

**Do not** enable the calling home feature. This feature is not appropriate for mrefd.

### Caveat

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