vh/NetAlertX
1
0
Fork 0
mirror of https://github.com/jokob-sk/NetAlertX.git synced 2025-12-06 17:15:38 -08:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity

Doc update

Browse Source
This commit is contained in:
pucherot
2021-01-05 17:42:34 +01:00
parent 766671ad6d
commit 18dbb54fa3
2 changed files with 55 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files

86
README.md
View File

@@ -1,50 +1,69 @@
# Pi.Alert
================================================================================
WIFI / LAN intruder detector.
Check the devices connected to your WIFI / LAN and alert you the unknown devices. It also warns of the disconnection of "always connected" devices.
Check the devices connected to your WIFI / LAN and alert you the unknown
devices. It also warns of the disconnection of "always connected" 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
--------------------------------------------------------------------------------
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
- New devices
- New connections (re-connections)
- Disconnections
- IP changes
- "Always Connected" devices down
- Changes in Internet IP address
## Scan Methods
--------------------------------------------------------------------------------
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.
- **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
--------------------------------------------------------------------------------
The system consists of two parts:
- **Back**, in charge of:
- scanning the network searching connected devices using the scanning methods described
- 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:
- display in a visual way all the information collected by the back
- Manage de devices inventory and the characteristics
<Image>
# 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.
## Dependencies
- Lighttpd (probably works on other webservers / not tested)
- arp-scan (Required for Scan Method 1)
- Pi.hole (optional. Scan Method 2. Check devices doing DNS queries)
- dnsmasq (optional. Scan Method 3. Check devices using DHCP server)
- IEEE HW Vendors Database (Necessary to identified HW vendor)
--------------------------------------------------------------------------------
- Lighttpd (probably works on other webservers / not tested)
- arp-scan (Required for Scan Method 1)
- Pi.hole (optional. Scan Method 2. Check devices doing DNS queries)
- dnsmasq (optional. Scan Method 3. Check devices using DHCP server)
- IEEE HW Vendors Database (Necessary to identified HW vendor)
## Installation process
--------------------------------------------------------------------------------
```
Pending explain the installation process
- step 1
@@ -52,21 +71,26 @@ Pending explain the installation process
```
## Other useful info
================================================================================
### Powered by:
- 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)
- dnsmasq (DHCP Server)
--------------------------------------------------------------------------------
- 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)
- dnsmasq (DHCP Server)
### License
GPL 3.0
--------------------------------------------------------------------------------
GPL 3.0
[Read more here](doc/LICENSE.txt)
### Contact
_pending..._
--------------------------------------------------------------------------------
_pending..._

0
LICENSE → doc/LICENSE.txt
View File