diff --git a/README.md b/README.md index 42901f45..d5d95bde 100644 --- a/README.md +++ b/README.md @@ -10,19 +10,20 @@ unknown devices. It also warns the disconnection of "always connected" devices. *(Apologies for my English and my limited knowledge of Python, php and JavaScript)* -# Docker image :whale: +# Docker image 🐳 [![Docker](https://github.com/jokob-sk/Pi.Alert/actions/workflows/docker.yml/badge.svg)](https://github.com/jokob-sk/Pi.Alert/actions/workflows/docker.yml) [![Docker Image Size](https://img.shields.io/docker/image-size/jokobsk/pi.alert?logo=Docker)](https://hub.docker.com/r/jokobsk/pi.alert) Docker Pulls -All credit for Pi.Alert goes to: [pucherot/Pi.Alert](https://github.com/pucherot/Pi.Alert). -A pre-built image is available on :whale: Docker Hub: [jokobsk/Pi.Alert](https://registry.hub.docker.com/r/jokobsk/pi.alert). -The source :page_facing_up: Dockerfile is available [here](https://github.com/jokob-sk/Pi.Alert/blob/main/Dockerfile) with a detailed :books: [readme](https://github.com/jokob-sk/Pi.Alert/blob/main//dockerfiles/README.md) included. +🥇 Pi.Alert credit goes to [pucherot/Pi.Alert](https://github.com/pucherot/Pi.Alert).
+🐳 Docker Image: [jokobsk/Pi.Alert](https://registry.hub.docker.com/r/jokobsk/pi.alert).
+📄 [Dockerfile](https://github.com/jokob-sk/Pi.Alert/blob/main/Dockerfile)
+📚 [Dockerfile instructions](https://github.com/jokob-sk/Pi.Alert/blob/main//dockerfiles/README.md). ![Main screen dark][main_dark] -Optional Darkmode (and 12H activity chart) within this fork courtesy of [leiweibau](https://github.com/leiweibau/Pi.Alert) +Dark mode (and Activity over the last x scans) within this fork courtesy of [leiweibau](https://github.com/leiweibau/Pi.Alert) ## How it works The system continuously scans the network for: @@ -61,7 +62,7 @@ In charge of: | -------------------- | -------------------- | ### Front -A web frontal that allows: +A web front that allows: - Manage the devices inventory and the characteristics - Display in a visual way all the information collected by the back - Sessions @@ -72,7 +73,7 @@ A web frontal that allows: - Concurrent devices - Down alerts - IP's - - manuel nmap scans + - Manual Nmap scans - Optional speedtest for Device "Internet" - ... @@ -159,6 +160,14 @@ Linux distributions. ***Suggestions and comments are welcome*** +### Special thanks 🥇 + + This code is a collaborative body of work, with special thanks to: + + - [leiweibau](https://github.com/leiweibau/Pi.Alert): Dark mode (and Last X scans activity chart) + - [Macleykun](https://github.com/Macleykun): Help with Dockerfile clean-up + - [Final-Hawk](https://github.com/Final-Hawk): Help with NTFY, styling and other fixes + - 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 44b125e7..a9c266ca 100644 --- a/dockerfiles/README.md +++ b/dockerfiles/README.md @@ -4,11 +4,12 @@ Docker Pulls -# :whale: A docker image for Pi.Alert +# 🐳 A docker image for Pi.Alert -All credit for Pi.Alert goes to: [pucherot/Pi.Alert](https://github.com/pucherot/Pi.Alert). -A pre-built image is available on :whale: Docker Hub: [jokobsk/Pi.Alert](https://registry.hub.docker.com/r/jokobsk/pi.alert). -The source :page_facing_up: Dockerfile is available [here](https://github.com/jokob-sk/Pi.Alert/blob/main/Dockerfile) with a detailed :books: [readme](https://github.com/jokob-sk/Pi.Alert/blob/main//dockerfiles/README.md) included. +🥇 Pi.Alert credit goes to [pucherot/Pi.Alert](https://github.com/pucherot/Pi.Alert).
+🐳 Docker Image: [jokobsk/Pi.Alert](https://registry.hub.docker.com/r/jokobsk/pi.alert).
+📄 [Dockerfile](https://github.com/jokob-sk/Pi.Alert/blob/main/Dockerfile)
+📚 [Dockerfile 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): @@ -16,7 +17,7 @@ Big thanks to @Macleykun for help and -## :information_source: Usage +## ℹ Usage Network - You will have to probably run the container on the host network, e.g: `sudo docker run --rm --net=host jokobsk/pi.alert` @@ -26,10 +27,10 @@ Default Port > Please note - the cronjob is executed every 1, 5 and 15 minutes so wait that long for all of the scans to run. -## :floppy_disk: Setup and Backups +## 💾 Setup and Backups 1. (**required**) Download `pialert.conf` and `version.conf` from [here](https://github.com/jokob-sk/Pi.Alert/tree/main/config). -2. (**required**) In `pialert.config` specify your network adapter (will probably be `eth0` or `eth1`) and the network filter (which **significantly** speeds up the scan process), e.g. if your DHCP server assigns IPs in the 192.168.1.0 to 192.168.1.255 range specify it the following way: +2. (**required**) In `pialert.conf` specify your network adapter (will probably be `eth0` or `eth1`) and the network filter (which **significantly** speeds up the scan process), e.g. if your DHCP server assigns IPs in the 192.168.1.0 to 192.168.1.255 range specify it the following way: * `SCAN_SUBNETS = '192.168.1.0/24 --interface=eth0'` 3. (**required**) Use your configuration by: * Mapping the container folder `/home/pi/pialert/config` to a persistent folder containing `pialert.conf` and `version.conf`, @@ -44,7 +45,7 @@ Default Port Config examples can be found below. -## :page_facing_up: Examples +## 📄 Examples ### Example 1 @@ -102,7 +103,7 @@ Courtesy of [pbek](https://github.com/pbek). The volume `pialert_db` is used by - ./pialert/version.conf:/home/pi/pialert/config/version.conf ``` -## :coffee: Support +## ☕ Support > Disclaimer: This is my second container and I might have used unconventional hacks so if anyone is more experienced, feel free to fork/create pull requests. Also, please only donate if you don't have any debt yourself. Support yourself first, then others.