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 Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
pucherot
2021-01-07 10:31:07 +01:00
committed by GitHub
parent 033553a2a8
commit 4c9344e402
1 changed files with 29 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
README.md
View File

@@ -9,12 +9,12 @@ devices.
![Main screen][main] ![Main screen][main]
*(Apologies for my english and my limited knowledge of Python, php and *(Apologies for my English and my limited knowledge of Python, php and
JavaScript)* JavaScript)*
## How it works ## How it works
The system continuously scan the network for: The system continuously scans the network for:
- New devices - New devices
- New connections (re-connections) - New connections (re-connections)
- Disconnections - Disconnections
@@ -33,7 +33,7 @@ The system continuously scan the network for:
detected by method 1. detected by method 1.
- **Method 3. dnsmasq**. This method is optional and complementary to the - **Method 3. dnsmasq**. This method is optional and complementary to the
previous methods. If the DHCP server dnsmasq is active, Pi.Alert previous methods. If the DHCP server dnsmasq is active, Pi.Alert
examines the DHCP leases (addresses asigned) to find active devices examines the DHCP leases (addresses assigned) to find active devices
that were not discovered by the previous methods. that were not discovered by the previous methods.
## Components ## Components
@@ -50,7 +50,7 @@ The system consists of two parts:
- Manage the devices inventory and the characteristics - Manage the devices inventory and the characteristics
- Display in a visual way all the information collected by the back - Display in a visual way all the information collected by the back
- Sessions - Sessions
- Conected devices - Connected devices
- Favourites - Favourites
- Events - Events
- Presence - Presence
@@ -59,9 +59,8 @@ The system consists of two parts:
- IP - IP
- ... - ...
| Sample | Screens |
| ------------------- | ------------------- |
| ![Screen 1][screen1] | ![Screen 2][screen2] | | ![Screen 1][screen1] | ![Screen 2][screen2] |
| ------------------- | ------------------- |
| ![Screen 3][screen3] | ![Screen 4][screen4] | | ![Screen 3][screen3] | ![Screen 4][screen4] |
@@ -77,6 +76,15 @@ distributions.
- 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 Device vendor) - IEEE HW Vendors Database (necessary to identified Device vendor)
| Dependency | Comments |
| ------------------------ | -------------------------------------------------------- |
| 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 Device vendor |
## Installation process ## Installation process
``` ```
Pending explain the installation process Pending explain the installation process
@@ -89,6 +97,20 @@ Pending explain the installation process
<!--- --------------------------------------------------------------------- ---> <!--- --------------------------------------------------------------------- --->
### Powered by: ### Powered by:
| 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 |
- 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)
- JavaScript (Programming language for the Front-end) - JavaScript (Programming language for the Front-end)
@@ -113,4 +135,4 @@ Pending explain the installation process
[screen1]: ./doc/img/2_1_device_details.jpg "Screen 1" [screen1]: ./doc/img/2_1_device_details.jpg "Screen 1"
[screen2]: ./doc/img/2_2_device_sessions.jpg "Screen 2" [screen2]: ./doc/img/2_2_device_sessions.jpg "Screen 2"
[screen3]: ./doc/img/2_3_device_presence.jpg "Screen 3" [screen3]: ./doc/img/2_3_device_presence.jpg "Screen 3"
[screen4]: ./doc/img/3_presence.jpg "Screen 4" [screen4]: ./doc/img/3_presence.jpg "Screen 4"