mirror of
https://github.com/jokob-sk/NetAlertX.git
synced 2025-12-07 09:36:05 -08:00
Update README.md
This commit is contained in:
23
README.md
23
README.md
@@ -13,7 +13,6 @@ devices.
|
||||
JavaScript)*
|
||||
|
||||
## How it works
|
||||
|
||||
The system continuously scans the network for:
|
||||
- New devices
|
||||
- New connections (re-connections)
|
||||
@@ -24,7 +23,6 @@ The system continuously scans the network for:
|
||||
|
||||
## 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
|
||||
@@ -37,7 +35,6 @@ The system continuously scans the network for:
|
||||
that were not discovered by the previous methods.
|
||||
|
||||
## Components
|
||||
|
||||
The system consists of two parts:
|
||||
|
||||
- **Back**, in charge of:
|
||||
@@ -70,12 +67,6 @@ 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 Device vendor)
|
||||
|
||||
| Dependency | Comments |
|
||||
| ------------------------ | -------------------------------------------------------- |
|
||||
| Lighttpd | Probably works on other webservers / not tested |
|
||||
@@ -84,7 +75,6 @@ distributions.
|
||||
| dnsmasq | Optional. Scan Method 3. Check devices using DHCP server |
|
||||
| IEEE HW Vendors Database | Necessary to identified Device vendor |
|
||||
|
||||
|
||||
## Installation process
|
||||
```
|
||||
Pending explain the installation process
|
||||
@@ -111,18 +101,6 @@ Pending explain the installation process
|
||||
| Pi.hole | DNS Server with Ad-block |
|
||||
| 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
|
||||
GPL 3.0
|
||||
[Read more here](doc/LICENSE.txt)
|
||||
@@ -131,6 +109,7 @@ Pending explain the installation process
|
||||
pi.alert.application@gmail.com
|
||||
|
||||
|
||||
<!--- --------------------------------------------------------------------- --->
|
||||
[main]: ./doc/img/1_devices.jpg "Main screen"
|
||||
[screen1]: ./doc/img/2_1_device_details.jpg "Screen 1"
|
||||
[screen2]: ./doc/img/2_2_device_sessions.jpg "Screen 2"
|
||||
|
||||
Reference in New Issue
Block a user