WIFI / LAN intruder detector.
Scan the devices connected to your WIFI / LAN and alert you the connection of unknown devices. It also warns if a "always connected" devices disconnects.
(Apologies for my English and my limited knowledge of Python, php and JavaScript)
π₯ Pi.Alert credit goes to pucherot/Pi.Alert
π³ Docker Image: jokobsk/Pi.Alert
π Dockerfile
π Dockerfile instructions
Dark mode (and much more) within this fork courtesy of leiweibau
The system continuously scans the network for:
- New devices
- New connections (re-connections)
- Disconnections
- "Always Connected" devices down
- Devices IP changes
- Internet IP address changes
Up to three scanning methods are used:
- Method 1: arp-scan. The arp-scan system utility is used to search for devices on the network using arp frames.
- Method 2: Pi-hole. This method is optional and complementary to method 1. If the Pi-hole DNS server is active, Pi.Alert examines its activity looking for active devices using DNS that have not been detected by method 1.
- Method 3. dnsmasq. This method is optional and complementary to the previous methods. If the DHCP server dnsmasq is active, Pi.Alert examines the DHCP leases (addresses assigned) to find active devices that were not discovered by the other methods.
The system consists of two parts:
In charge of:
- Scan the network searching connected devices using the scanning methods described
- Store the information in the DB
- Report the changes detected by e-mail and/or other services (Apprise, Pushsafer, NTFY, Webhooks (sample JSON))
- Optional speedtest for Device "Internet"
- DB cleanup tasks via cron
- a pialert-cli that helps to configure login and password
There is a configurable login to prevent unauthorized use.
- Set
PIALERT_WEB_PROTECTION = True
inpialert.conf
to enable. The default password is123456
. To change password run/home/pi/pialert/back/pialert-cli
A web frontend that allows:
- Manage the devices inventory and the characteristics
- Display in a visual way all the information collected by the back
- Sessions
- Connected devices
- Favorites
- Events
- Presence
- Concurrent devices
- Down alerts
- IP's
- Manual Nmap scans
- Optional speedtest for Device "Internet"
- Simple Network relationship display
- Maintenance tasks and Settings like:
- Status Infos (active scans, database size, backup counter)
- Theme Selection (blue, red, green, yellow, black, purple)
- Language Selection (english, german, spanish)
- Light/Dark-Mode Switch
- Pause arp-scan
- DB maintenance tools
- DB Backup and Restore
- CSV Export / Import (Experimental)
- Help/FAQ Section
Initially designed to run on a Raspberry Pi, probably it can run on many other Linux distributions.
β Please note, this fork (jokob-sk) is only tested via the docker install method
Instructions for pucherot's original code
- One-step Automated Install:
Instructions for leiweibau's fork
-
One-step Automated Install:
-
One-step Automated Install without Webserver if another Webserver is already installed. (not recommended):
-
One-step Automated Update (pucherot):
-
One-step Automated Update (leiweibau):
Product | Objetive |
---|---|
Python | Programming language for the Back |
PHP | Programming language for the Front-end |
JavaScript | Programming language for the Front-end |
Bootstrap | Front-end framework |
Admin.LTE | Bootstrap template |
FullCalendar | Calendar component |
Sqlite | DB engine |
Lighttpd | Webserver |
arp-scan | Scan network using arp commands |
Pi.hole | DNS Server with Ad-block |
dnsmasq | DHCP Server |
nmap | Network Scanner |
zip | Filecompression Tool |
speedtest-cli | Python SpeedTest https://github.com/sivel/speedtest-cli |
GPL 3.0 Read more here
Source of the animated GIF (Loading Animation) https://commons.wikimedia.org/wiki/File:Loading_Animation.gif
Source of the selfhosted Fonts https://github.com/adobe-fonts/source-sans
pi.alert.application@gmail.com
Suggestions and comments are welcome
This code is a collaborative body of work, with special thanks to:
- leiweibau: Things
- Macleykun: Help with Dockerfile clean-up
- Final-Hawk: Help with NTFY, styling and other fixes
- TeroRERO: Spanish translation
- jokob-sk: DB Maintenance tools
- Please see the Git commit history for a full list of people and their contributions to the project