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 Doc

Browse Source
This commit is contained in:
pucherot
2021-01-05 17:58:37 +01:00
parent 18dbb54fa3
commit 3ba69540ef
1 changed files with 8 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@@ -1,5 +1,6 @@
# Pi.Alert # Pi.Alert
================================================================================ --------------------------------------------------------------------------------
WIFI / LAN intruder detector. WIFI / LAN intruder detector.
Check the devices connected to your WIFI / LAN and alert you the unknown Check the devices connected to your WIFI / LAN and alert you the unknown
@@ -9,7 +10,7 @@ devices. It also warns of the disconnection of "always connected" devices.
JavaScript)* JavaScript)*
## How it works ## How it works
--------------------------------------------------------------------------------
The system continuously searches the network for: The system continuously searches the network for:
- New devices - New devices
- New connections (re-connections) - New connections (re-connections)
@@ -19,8 +20,8 @@ The system continuously searches 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
@@ -33,7 +34,7 @@ Up to three scanning methods are used:
that were not discovered by the previous methods. 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: - **Back**, in charge of:
@@ -50,12 +51,11 @@ The system consists of two parts:
# Installation # Installation
================================================================================ --------------------------------------------------------------------------------
Initially designed to run on a Raspberry PI, it can run on many other Linux 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) - Lighttpd (probably works on other webservers / not tested)
- arp-scan (Required for Scan Method 1) - arp-scan (Required for Scan Method 1)
- Pi.hole (optional. Scan Method 2. Check devices doing DNS queries) - Pi.hole (optional. Scan Method 2. Check devices doing DNS queries)
@@ -63,7 +63,6 @@ distributions.
- IEEE HW Vendors Database (Necessary to identified HW vendor) - IEEE HW Vendors Database (Necessary to identified HW vendor)
## Installation process ## Installation process
--------------------------------------------------------------------------------
``` ```
Pending explain the installation process Pending explain the installation process
- step 1 - step 1
@@ -71,9 +70,8 @@ Pending explain the installation process
``` ```
## Other useful info ## Other useful info
================================================================================
### 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)
- JavaScript (Programming language for the Front-end) - JavaScript (Programming language for the Front-end)
@@ -87,10 +85,8 @@ Pending explain the installation process
- dnsmasq (DHCP Server) - dnsmasq (DHCP Server)
### License ### License
--------------------------------------------------------------------------------
GPL 3.0 GPL 3.0
[Read more here](doc/LICENSE.txt) [Read more here](doc/LICENSE.txt)
### Contact ### Contact
--------------------------------------------------------------------------------
_pending..._ _pending..._