vh/NetAlertX
1
0
Fork 0
mirror of https://github.com/jokob-sk/NetAlertX.git synced 2025-12-07 09:36:05 -08:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
pucherot
2021-01-05 11:02:07 +01:00
committed by GitHub
parent 721a14e370
commit a1c9910e53
1 changed files with 25 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
README.md
View File

@@ -6,26 +6,36 @@ Check the devices connected to your WIFI / LAN and alert you the unknown devices
*(Apologies for my english and my limited knowledge of Python, php and JavaScript)* *(Apologies for my english and my limited knowledge of Python, php and JavaScript)*
### How it works ### How it works
The system continuously searches the network for:
- New devices
- New connections (re-connections)
- Disconnections
- IP changes
- "Always Connected" devices down
- Changes in Internet IP address
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 asigned) to find active devices that were not discovered by the previous methods.
### Componets ### Componets
The system consists of two parts: The system consists of two parts:
- **Back**: in charge of scanning the network searching connected devices, store the information in the DB, and reporting the changes detected by e-mail. - **Back**: In charge of:
- scanning the network searching connected devices using the scanning methods described
- store the information in the DB
- report the changes detected by e-mail
- **Front**: a web frontal that allows to display, in a visual way, all the information collected by the back. - **Front**: a web frontal that allows:
- display in a visual way all the information collected by the back
- Manage de devices inventory and the characteristics
<Image> <Image>
# Installation # Installation
Initially designed to run on a Raspberry PI, it can run on many other Linux distributions. Initially designed to run on a Raspberry PI, it can run on many other Linux distributions.
```
Pending explain the installation process
- step 1
- step 2
```
### Dependencies ### Dependencies
- Lighttpd (probably works on other webservers / not tested) - Lighttpd (probably works on other webservers / not tested)
- arp-scan (Required for Scan Method 1) - arp-scan (Required for Scan Method 1)
@@ -33,6 +43,13 @@ Pending explain the installation process
- dnsmasq (optional. Scan Method 3. Check devices using DHCP server) - dnsmasq (optional. Scan Method 3. Check devices using DHCP server)
- IEEE HW Vendors Database (Necessary to identified HW vendor) - IEEE HW Vendors Database (Necessary to identified HW vendor)
### Installation process
```
Pending explain the installation process
- step 1
- step 2
```
# Powered by: # Powered by:
- Python (Programming language for the Back) - Python (Programming language for the Back)
- PHP (Programming language for the Front-end) - PHP (Programming language for the Front-end)