diff --git a/README.md b/README.md index 092be6ce..d801dd46 100755 --- a/README.md +++ b/README.md @@ -3,8 +3,7 @@ 💻🔍 WIFI / LAN intruder detector. -Scan the devices connected to your WIFI / LAN and alert you the connection of -unknown devices. It also warns if a "always connected" devices disconnects. +Scans for devices connected to your WIFI / LAN and alerts you if new and unknown devices are found. ![Main screen][main] @@ -44,7 +43,7 @@ The system continuously scans the network for, **New devices**, **New connection - Configurable login to prevent unauthorized use. - Set `PIALERT_WEB_PROTECTION = True` in `pialert.conf` to enable. - The default password is `123456`. -- To change password run `/home/pi/pialert/back/pialert-cli` +- To change password run `/home/pi/pialert/back/pialert-cli` ## 📑 Features - Display: @@ -69,42 +68,35 @@ The system continuously scans the network for, **New devices**, **New connection # 📥 Installation - ⚠ This [fork (jokob-sk)](https://github.com/jokob-sk/Pi.Alert) is only tested via the [docker install method](dockerfiles/README.md). Check out [leiweibau's fork](https://github.com/leiweibau/Pi.Alert/) if you want to install Pi.Alert on the server directly. + ⚠ This [fork (jokob-sk)](https://github.com/jokob-sk/Pi.Alert) is only tested as a [docker container](dockerfiles/README.md). Check out [leiweibau's fork](https://github.com/leiweibau/Pi.Alert/) if you want to install Pi.Alert on the server directly. Instructions for [pucherot's original code can be found here](https://github.com/pucherot/Pi.Alert/) -# Device Management + +## 🔗 Other + + - [Device Management instructions](docs/DEVICE_MANAGEMENT.md) - - -## Other useful info - - -### [Versions History](docs/VERSIONS_HISTORY.md) + - [Versions History](docs/VERSIONS_HISTORY.md) ### License GPL 3.0 - [Read more here](LICENSE.txt) - - Source of the animated GIF (Loading Animation) - https://commons.wikimedia.org/wiki/File:Loading_Animation.gif - - Source of the selfhosted Fonts - https://github.com/adobe-fonts/source-sans - + - [Read more here](LICENSE.txt) + - Source of the [animated GIF (Loading Animation)](https://commons.wikimedia.org/wiki/File:Loading_Animation.gif) + - Source of the [selfhosted Fonts](https://github.com/adobe-fonts/source-sans) ### 🥇 Special thanks This code is a collaborative body of work, with special thanks to: - 🏆 [pucherot/Pi.Alert](https://github.com/pucherot/Pi.Alert) is the original creator od PiAlert - - [leiweibau](https://github.com/leiweibau/Pi.Alert): Dark mode (and much more) - - [Macleykun](https://github.com/Macleykun): Help with Dockerfile clean-up - - [Final-Hawk](https://github.com/Final-Hawk): Help with NTFY, styling and other fixes - - [TeroRERO](https://github.com/terorero): Spanish translation - - [jokob-sk](https://github.com/jokob-sk/Pi.Alert): DB Maintenance tools - - Please see the [Git commit history](https://github.com/jokob-sk/Pi.Alert/commits/main) for a full list of people and their contributions to the project + - [leiweibau](https://github.com/leiweibau/Pi.Alert): Dark mode (and much more) + - [Macleykun](https://github.com/Macleykun): Help with Dockerfile clean-up + - [Final-Hawk](https://github.com/Final-Hawk): Help with NTFY, styling and other fixes + - [TeroRERO](https://github.com/terorero): Spanish translation + - [jokob-sk](https://github.com/jokob-sk/Pi.Alert): DB Maintenance tools + - Please see the [Git commit history](https://github.com/jokob-sk/Pi.Alert/commits/main) for a full list of people and their contributions to the project [main]: ./docs/img/1_devices.jpg "Main screen" diff --git a/dockerfiles/README.md b/dockerfiles/README.md index 32757723..27ffd05e 100755 --- a/dockerfiles/README.md +++ b/dockerfiles/README.md @@ -9,12 +9,6 @@ 🐳 [Docker hub](https://registry.hub.docker.com/r/jokobsk/pi.alert) | 📄 [Dockerfile](https://github.com/jokob-sk/Pi.Alert/blob/main/Dockerfile) | 📚 [Docker instructions](https://github.com/jokob-sk/Pi.Alert/blob/main//dockerfiles/README.md) -Big thanks to @Macleykun for help and tips&tricks for Dockerfile(s): - - - - - ## ℹ Basic Usage ### pialert.conf @@ -26,7 +20,7 @@ Big thanks to @Macleykun for help and ### Default Port - The app is accessible on the port `:20211`. -> Please note - the initial scan can take up-to 20min (with 50 devices and MQTT). Subsequent ones 3 and 5 minutes so wait that long for all of the scans to run. +> Please note - the initial scan can take up-to 40min (with 50 devices and MQTT). Subsequent ones 3 and 5 minutes so wait that long for all of the scans to run. ## 💾 Setup and Backups @@ -134,9 +128,17 @@ Courtesy of [pbek](https://github.com/pbek). The volume `pialert_db` is used by - ./pialert/pialert.conf:/home/pi/pialert/config/pialert.conf ``` -## ☕ Support +## 🏅 Recognitions -> Disclaimer: Please only donate if you don't have any debt yourself. Support yourself first, then others. +Big thanks to @Macleykun for help and tips&tricks for Dockerfile(s): + + + + + +## ☕ Support me + +Disclaimer: Please only donate if you don't have any debt yourself. Support yourself first, then others. Buy Me A Coffee