Email notifications plugin
Posted: Tue Jul 08, 2014 7:15 pm
Today I finally finished e-mail notificaton plugin for Gargoyle, which was also requested by a quite a few people on forums. Plugin uses SMTP protocol to send mail, but it currently doesn't support encryption, so you have to use servers with no authentication or plain authentication.
Screenshot of settings in Gargoyle web interface:
Most ISP allows their customers to send email through their servers without encryption. If your ISP doesn't offer SMTP server without authentication, you can use one Google offers (aspmx.l.google.com:25, more info: https://support.google.com/a/answer/176600?hl=en). Most routers come with only 4MB flash, which is the main reason encryption currently isn't supported. Since I managed to get Gargoyle working in VirtualBox, you can expect encryption support in future (or if maybe someone else implements it).
Plugin also features time settings, where you can set in which intervals you want to receive notifications. I used cron configuration code from BashfulBladder, which made plugin much nicer and user friendly.
There is also test email button, which allows you to test settings before saving them. Pressing this button sends test email using current settings, that you can see on web interface. If email arrives, settings are okay. Test mail button also logs to system log, so you can look there for any errors.
What notifications plugin emails:
- Recently visited sites (if enabled)
- Recent web searches (if enabled)
- System logs (logread)
- Current DHCP Leases
- ARP Records
Here is a small example of how email looks like:
Plugin uses msmtp-nossl to send emails, since full msmtp package is too big for routers with 4MB flash.
HOW TO INSTALL:
Remember, plugin is still new, so it probably has probably some bugs (maybe a lot).
To install plugin run this code:
Currently this is the only way to install plugin, since I want some people to test it first. Report any bugs.
Hope you will find this plugin useful.
Screenshot of settings in Gargoyle web interface:
Most ISP allows their customers to send email through their servers without encryption. If your ISP doesn't offer SMTP server without authentication, you can use one Google offers (aspmx.l.google.com:25, more info: https://support.google.com/a/answer/176600?hl=en). Most routers come with only 4MB flash, which is the main reason encryption currently isn't supported. Since I managed to get Gargoyle working in VirtualBox, you can expect encryption support in future (or if maybe someone else implements it).
Plugin also features time settings, where you can set in which intervals you want to receive notifications. I used cron configuration code from BashfulBladder, which made plugin much nicer and user friendly.
There is also test email button, which allows you to test settings before saving them. Pressing this button sends test email using current settings, that you can see on web interface. If email arrives, settings are okay. Test mail button also logs to system log, so you can look there for any errors.
What notifications plugin emails:
- Recently visited sites (if enabled)
- Recent web searches (if enabled)
- System logs (logread)
- Current DHCP Leases
- ARP Records
Here is a small example of how email looks like:
Plugin uses msmtp-nossl to send emails, since full msmtp package is too big for routers with 4MB flash.
HOW TO INSTALL:
Remember, plugin is still new, so it probably has probably some bugs (maybe a lot).
To install plugin run this code:
Code: Select all
wget -q -O - "http://fpaste.org/135288/41132367/raw/" | tr -d '\r' > /tmp/setup.sh && chmod +x /tmp/setup.sh && sh /tmp/setup.shHope you will find this plugin useful.
.
