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:34:12 +01:00
committed by GitHub
parent f5794cdede
commit 4bf4018465
1 changed files with 25 additions and 46 deletions
Download Patch File Download Diff File Expand all files Collapse all files

71
README.md
View File

@@ -13,7 +13,6 @@ devices.
JavaScript)* JavaScript)*
## How it works ## How it works
The system continuously scans the network for: The system continuously scans the network for:
- New devices - New devices
- New connections (re-connections) - New connections (re-connections)
@@ -23,8 +22,7 @@ The system continuously scans the network for:
- Changes in Internet IP address - Changes in Internet IP address
## Scan Methods ## Scan Methods
Up to three scanning methods are used: Up to three scanning methods are used:
- **Method 1: arp-scan**. The arp-scan system utility is used to search - **Method 1: arp-scan**. The arp-scan system utility is used to search
for devices on the network using arp frames. for devices on the network using arp frames.
- **Method 2: Pi-hole**. This method is optional and complementary to - **Method 2: Pi-hole**. This method is optional and complementary to
@@ -37,7 +35,6 @@ The system continuously scans the network for:
that were not discovered by the previous methods. that were not discovered by the previous methods.
## Components ## Components
The system consists of two parts: The system consists of two parts:
- **Back**, in charge of: - **Back**, in charge of:
@@ -59,9 +56,9 @@ The system consists of two parts:
- IP - IP
- ... - ...
| ![Screen 1][screen1] | ![Screen 2][screen2] | | ![Screen 1][screen1] | ![Screen 2][screen2] |
| ------------------- | ------------------- | | ------------------- | ------------------- |
| ![Screen 3][screen3] | ![Screen 4][screen4] | | ![Screen 3][screen3] | ![Screen 4][screen4] |
# Installation # Installation
@@ -70,20 +67,13 @@ Initially designed to run on a Raspberry PI, it can run on many other Linux
distributions. distributions.
## Dependencies ## Dependencies
- Lighttpd (probably works on other webservers / not tested) | Dependency | Comments |
- arp-scan (required for Scan Method 1) | ------------------------ | -------------------------------------------------------- |
- Pi.hole (optional. Scan Method 2. Check devices doing DNS queries) | Lighttpd | Probably works on other webservers / not tested |
- dnsmasq (optional. Scan Method 3. Check devices using DHCP server) | arp-scan | Required for Scan Method 1 |
- IEEE HW Vendors Database (necessary to identified Device vendor) | Pi.hole | Optional. Scan Method 2. Check devices doing DNS queries |
| dnsmasq | Optional. Scan Method 3. Check devices using DHCP server |
| Dependency | Comments | | IEEE HW Vendors Database | Necessary to identified Device 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 Device vendor |
## Installation process ## Installation process
``` ```
@@ -97,31 +87,19 @@ Pending explain the installation process
<!--- --------------------------------------------------------------------- ---> <!--- --------------------------------------------------------------------- --->
### Powered by: ### Powered by:
| Product | Objetive | | Product | Objetive |
| ------------ | -------------------------------------- | | ------------ | -------------------------------------- |
| 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 |
| Bootstrap | Front-end framework | | Bootstrap | Front-end framework |
| Admin.LTE | Bootstrap template | | Admin.LTE | Bootstrap template |
| FullCalendar | Calendar component | | FullCalendar | Calendar component |
| Sqlite | DB engine | | Sqlite | DB engine |
| Lighttpd | Webserver | | Lighttpd | Webserver |
| arp-scan | Scan network using arp commands | | arp-scan | Scan network using arp commands |
| Pi.hole | DNS Server with Ad-block | | Pi.hole | DNS Server with Ad-block |
| dnsmasq | DHCP 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 with Ad-block)
- dnsmasq (DHCP Server)
### License ### License
GPL 3.0 GPL 3.0
@@ -131,6 +109,7 @@ Pending explain the installation process
pi.alert.application@gmail.com pi.alert.application@gmail.com
<!--- --------------------------------------------------------------------- --->
[main]: ./doc/img/1_devices.jpg "Main screen" [main]: ./doc/img/1_devices.jpg "Main screen"
[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"