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

Update README.md

Browse Source
This commit is contained in:
pucherot
2021-01-05 09:37:57 +01:00
committed by GitHub
parent 73acaabefc
commit 5e78dfcbc2
1 changed files with 15 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@@ -5,11 +5,24 @@ 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)*
<>
### Componets
The system consists of two parts:
- **Back**: in charge of scanning the network searching connected devices, store the information in the DB, and reporting the changes detected by e-mail.
- **Front**: a web frontal that allows to display, in a visual way, all the information collected by the back.
<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 Linux distributions.
# Dependencies ### Dependencies
arp-scan - arp-scan
- Pi.hole (optional)
- dnsmasq (optional)
# Contributions # Contributions
- Pi.hole - Pi.hole