Update README.md

This commit is contained in:
pucherot
2021-01-05 10:39:44 +01:00
committed by GitHub
parent c7c2335f59
commit 721a14e370
+26 -18
View File
@@ -1,12 +1,12 @@
# 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 devices. Check the devices connected to your WIFI / LAN and alert you the unknown devices. It also warns of the disconnection of "always connected" devices.
It also warns of the disconnection of "always connected" devices.
*(Apologies for my english and my limited knowledge of Python, php and JavaScript)* *(Apologies for my english and my limited knowledge of Python, php and JavaScript)*
### How it works
### Componets ### Componets
The system consists of two parts: The system consists of two parts:
@@ -16,27 +16,35 @@ The system consists of two parts:
- **Front**: a web frontal that allows to display, in a visual way, all the information collected by the back. - **Front**: a web frontal that allows to display, in a visual way, all the information collected by the back.
<Image> <Image>
# Installation # Installation
Initially designed to run on a Raspberry PI, it can run on many Linux distributions. Initially designed to run on a Raspberry PI, it can run on many other Linux distributions.
```
Pending explain the installation process
- step 1
- step 2
```
### Dependencies ### Dependencies
- arp-scan - Lighttpd (probably works on other webservers / not tested)
- Pi.hole (optional) - arp-scan (Required for Scan Method 1)
- dnsmasq (optional) - 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 HW vendor)
# Contributions # Powered by:
### Powered by: - Python (Programming language for the Back)
- Python - PHP (Programming language for the Front-end)
- PHP - JavaScript (Programming language for the Front-end)
- JavaScript - Bootstrap (Front-end framework)
- Bootstrap
- Sqlite
- Lighttpd
### Acknowledgment
- Pi.hole (web design inspiration)
- Admin.LTE (Bootstrap template) - Admin.LTE (Bootstrap template)
- FullCalendar (calendar component) - FullCalendar (calendar component)
- Sqlite (DB engine)
- Lighttpd (Webserver)
- arp-scan (Scan network using arp commands)
- Pi.hole (DNS Server)
- dnsmasq (DHCP Server)
# License # License
GPL 3.0 GPL 3.0