cphipps/NetAlertX
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Doc

Browse Source
This commit is contained in:
pucherot
2021-01-05 21:50:37 +01:00
parent 6fa6ac2899
commit 1aedc4e035
1 changed files with 9 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@@ -1,10 +1,11 @@
# 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 Scan the devices connected to your WIFI / LAN and alert you the connection of
devices. It also warns of the disconnection of "always connected" devices. unknown devices. It also warns of the disconnection of "always connected"
devices.
*(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)*
@@ -51,16 +52,16 @@ 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)
- 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 HW vendor) - IEEE HW Vendors Database (necessary to identified Device vendor)
## Installation process ## Installation process
``` ```
@@ -71,7 +72,7 @@ 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)
@@ -83,7 +84,7 @@ Pending explain the installation process
- 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) - Pi.hole (DNS Server with Ad-block)
- dnsmasq (DHCP Server) - dnsmasq (DHCP Server)
### License ### License