fixes

Fix update check interval Thanks to @Final-Hawk 🙏

.dockerignore

@@ -0,0 +1,13 @@
+.dockerignore
+.env
+.git
+.github
+.gitignore
+docker-compose.yml
+Dockerfile
+dockerfiles/LICENSE
+dockerfiles/README.md
+docs
+LICENSE.txt
+README.md
+CONTRIBUTING

.env

@@ -0,0 +1,16 @@
+#GLOBAL PATH VARIABLES
+
+APP_DATA_LOCATION=/path/to/docker_appdata
+APP_CONFIG_LOCATION=/path/to/docker_config
+LOGS_LOCATION=/path/to/docker_logs
+
+#ENVIRONMENT VARIABLES
+
+TZ=Europe/Paris
+HOST_USER_ID=1000
+HOST_USER_GID=1000
+PORT=20211
+
+#DEVELOPMENT VARIABLES
+
+DEV_LOCATION=/path/to/local/source/code

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/ISSUE_TEMPLATE/i-have-an-issue.md

@@ -0,0 +1,46 @@
+---
+name: I have an issue
+about: Describe this issue template's purpose here.
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+## Describe the issue
+
+> When submitting an issue ❗[enable debug](https://github.com/jokob-sk/Pi.Alert/blob/main/docs/DEBUG_TIPS.md)❗ and [have a look at the docs](https://github.com/jokob-sk/Pi.Alert/tree/main/docs)
+
+[describe your issue]
+
+## Paste your `pialert.conf` (remove personal info)
+
+```
+paste_here
+```
+
+## Paste your `docker-compose.yml` and `.env` (remove personal info)
+
+`docker-compose.yml` 
+
+```
+paste_here
+```
+
+`.env` 
+
+```
+paste_here
+```
+
+## Screenshots
+
+[If applicable, add screenshots to help explain your problem.]
+
+## Paste last few lines from `pialert.log`
+
+> You can use `tail -100 /home/pi/pialert/front/log/pialert.log`
+
+```bash
+
+# paste code below 

.github/workflows/docker_cache-cleaner.yml

@@ -0,0 +1,25 @@
+name: ci-package-cleaner
+
+on:
+
+  workflow_dispatch: # manual option
+
+  schedule:
+    - cron: '15 22 * * 1' # every Monday 10.15pm UTC (~11.15am Tuesday NZT)
+
+jobs:
+
+  package-cleaner:
+    name: package-cleaner
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+    permissions:
+      packages: write
+    steps:
+
+      - uses: actions/delete-package-versions@v4
+        with: 
+          package-name: pi.alert
+          package-type: container
+          min-versions-to-keep: 0
+          delete-only-untagged-versions: true

.github/workflows/docker_dev.yml

@@ -0,0 +1,79 @@
+---
+name: docker
+
+on:
+  push:
+    branches:
+      - '**'
+    tags:
+      - '*.*.*'
+  pull_request:
+    branches:
+      - master
+
+jobs: 
+  docker_dev:
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    permissions:
+      contents: read
+      packages: write
+    if: >
+      contains(github.event.head_commit.message, 'PUSHPROD') != 'True' &&
+      github.repository == 'jokob-sk/Pi.Alert'  
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v2
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v2
+
+      - name: Set up dynamic build ARGs
+        id: getargs       
+        run: echo "version=$(cat ./stable/VERSION)" >> $GITHUB_OUTPUT
+
+      - name: Docker meta
+        id: meta
+        uses: docker/metadata-action@v4
+        with:
+          # list of Docker images to use as base name for tags
+          images: |
+            jokobsk/pi.alert_dev
+          # generate Docker tags based on the following events/attributes
+          tags: |
+            type=raw,value=latest
+            type=schedule
+            type=ref,event=branch
+            type=ref,event=pr
+            type=semver,pattern={{version}}
+            type=semver,pattern={{major}}.{{minor}}
+            type=semver,pattern={{major}}
+            type=sha
+
+      - name: Log in to Github Container registry
+        uses: docker/login-action@v2
+        with:
+          registry: ghcr.io
+          username: jokob-sk
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Login to DockerHub
+        if: github.event_name != 'pull_request'
+        uses: docker/login-action@v2
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+
+      - name: Build and push
+        uses: docker/build-push-action@v3
+        with:
+          context: .
+          platforms: linux/amd64,linux/arm64,linux/arm/v7
+          push: ${{ github.event_name != 'pull_request' }}
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+          cache-from: type=registry,ref=ghcr.io/jokob-sk/pi.alert:buildcache
+          cache-to: type=registry,ref=ghcr.io/jokob-sk/pi.alert:buildcache,mode=max

.github/workflows/docker_prod.yml

@@ -0,0 +1,84 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+# GitHub recommends pinning actions to a commit SHA.
+# To get a newer version, you will need to update the SHA.
+# You can also reference a tag or branch, but the action may change without warning.
+
+name: Publish Docker image
+
+on:
+  release:
+    types: [published]
+    tags:
+      - '*.*.*'
+jobs:
+  docker:
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    permissions:
+      contents: read
+      packages: write
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v2
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v2
+
+      - name: Set up dynamic build ARGs
+        id: getargs        
+        run: echo "version=$(cat ./stable/VERSION)" >> $GITHUB_OUTPUT
+
+      - name: Get release version
+        id: get_version
+        run: echo "::set-output name=version::${GITHUB_REF#refs/tags/}"
+
+      - name: Create .VERSION file
+        run: echo "${{ steps.get_version.outputs.version }}" >> .VERSION
+
+      - name: Docker meta
+        id: meta
+        uses: docker/metadata-action@v4
+        with:
+          # list of Docker images to use as base name for tags
+          images: |
+            jokobsk/pi.alert
+          # generate Docker tags based on the following events/attributes
+          tags: |
+            type=semver,pattern={{version}},value=${{ inputs.version }}
+            type=semver,pattern={{major}}.{{minor}},value=${{ inputs.version }}
+            type=semver,pattern={{major}},value=${{ inputs.version }}
+            type=ref,event=branch,suffix=-{{ sha }}
+            type=ref,event=pr
+            type=raw,value=latest,enable=${{ github.ref == 'refs/heads/main' || startsWith(github.ref, 'refs/tags/') }}
+
+      - name: Log in to Github Container registry
+        uses: docker/login-action@v2
+        with:
+          registry: ghcr.io
+          username: jokob-sk
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Login to DockerHub
+        if: github.event_name != 'pull_request'
+        uses: docker/login-action@v2
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+
+      - name: Build and push
+        uses: docker/build-push-action@v3
+        with:
+          context: .
+          platforms: linux/amd64,linux/arm64,linux/arm/v7
+          push: ${{ github.event_name != 'pull_request' }}
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+          cache-from: type=registry,ref=ghcr.io/jokob-sk/pi.alert:buildcache
+          cache-to: type=registry,ref=ghcr.io/jokob-sk/pi.alert:buildcache,mode=max

.gitignore

@@ -0,0 +1,16 @@
+.vscode
+.DS_Store
+config/pialert.conf
+db/*
+db/pialert.db
+front/log/*
+**/plugins/**/*.log
+**/%40eaDir/
+**/@eaDir/
+
+__pycache__/
+*.py[cod]
+*$py.class
+
+**/last_result.log
+**/script.log

CONTRIBUTING

@@ -0,0 +1,14 @@
+# Contributing to this project
+
+## Issues, bugs, feature requests
+
+The issue tracker is the preferred channel for bug reports, features requests and submitting pull requests.
+
+Before submitting a new issue please spend a couple of minutes on research:
+
+* Check [🛑 Common issues](https://github.com/jokob-sk/Pi.Alert/tree/main/dockerfiles#-common-issues) 
+* Check [💡 Closed issues](https://github.com/jokob-sk/Pi.Alert/issues?q=is%3Aissue+is%3Aclosed) if a similar issue was solved in the past.
+
+## Pull-requests (PRs)
+
+If you submit a PR please do check that your changes are backward compatible with existing installations. Existing features should be always preserved.

Dockerfile

@@ -0,0 +1,54 @@
+FROM debian:bullseye-slim
+
+# default UID and GID
+ENV USER=pi USER_ID=1000 USER_GID=1000  PORT=20211 
+#TZ=Europe/London
+
+# Todo, figure out why using a workdir instead of full paths don't work
+# Todo, do we still need all these packages? I can already see sudo which isn't needed
+
+RUN apt-get update \
+    && apt-get install --no-install-recommends tini snmp ca-certificates curl libwww-perl arp-scan perl apt-utils cron sudo nginx-light php php-cgi php-fpm php-sqlite3 php-curl sqlite3 dnsutils net-tools python3 iproute2 nmap python3-pip zip -y \
+    && pip3 install requests paho-mqtt scapy cron-converter pytz json2table dhcp-leases pyunifi \
+    && update-alternatives --install /usr/bin/python python /usr/bin/python3 10 \
+    && apt-get clean autoclean \
+    && apt-get autoremove \
+    && rm -rf /var/lib/apt/lists/* \
+    && rm -rf /var/www/html \
+    && ln -s /home/pi/pialert/front /var/www/html 
+
+# create pi user and group
+# add root and www-data to pi group so they can r/w files and db
+RUN groupadd --gid "${USER_GID}" "${USER}" && \
+    useradd \
+        --uid ${USER_ID} \
+        --gid ${USER_GID} \
+        --create-home \
+        --shell /bin/bash \
+        ${USER} && \
+    usermod -a -G ${USER_GID} root && \
+    usermod -a -G ${USER_GID} www-data
+
+COPY --chmod=775 --chown=${USER_ID}:${USER_GID} . /home/pi/pialert/
+
+# Pi.Alert
+RUN rm /etc/nginx/sites-available/default \
+    && ln -s /home/pi/pialert/install/default /etc/nginx/sites-available/default \
+    && sed -ie 's/listen 80/listen '${PORT}'/g' /etc/nginx/sites-available/default \
+    # run the hardware vendors update
+    && /home/pi/pialert/back/update_vendors.sh \
+    # Create a backup of the pialert.conf to be used if the user didn't supply a configuration file
+    && cp /home/pi/pialert/config/pialert.conf /home/pi/pialert/back/pialert.conf_bak \
+    # Create a backup of the pialert.db to be used if the user didn't supply a database
+    && cp /home/pi/pialert/db/pialert.db /home/pi/pialert/back/pialert.db_bak \
+    # Create a buildtimestamp.txt to later check if a new version was released
+    && date +%s > /home/pi/pialert/front/buildtimestamp.txt
+
+ENTRYPOINT ["tini", "--"]
+
+CMD ["/home/pi/pialert/dockerfiles/start.sh"]
+
+
+
+
+## command to build docker:  DOCKER_BUILDKIT=1  docker build . --iidfile dockerID

FUNDING.yml

@@ -0,0 +1,2 @@
+github: jokob-sk
+patreon: 84385063

README.md

@@ -1,27 +1,23 @@
 # Pi.Alert
 <!--- --------------------------------------------------------------------- --->
 
-WIFI / LAN intruder detector.
+💻🔍 WIFI / LAN intruder detector.
 
-Scan the devices connected to your WIFI / LAN and alert you the connection of
-unknown devices. It also warns the disconnection of "always connected" devices.
+Scans for devices connected to your WIFI / LAN and alerts you if new and unknown devices are found.
 
 ![Main screen][main]
 
-*(Apologies for my English and my limited knowledge of Python, php and
-JavaScript)*
+# 🐳 Docker image 
+[![Docker](https://img.shields.io/github/actions/workflow/status/jokob-sk/Pi.Alert/docker_prod.yml?label=Build&logo=GitHub)](https://github.com/jokob-sk/Pi.Alert/actions/workflows/docker_prod.yml)
+[![GitHub Committed](https://img.shields.io/github/last-commit/jokob-sk/Pi.Alert?color=40ba12&label=Committed&logo=GitHub&logoColor=fff)](https://github.com/jokob-sk/Pi.Alert)
+[![Docker Size](https://img.shields.io/docker/image-size/jokobsk/pi.alert?label=Size&logo=Docker&color=0aa8d2&logoColor=fff)](https://hub.docker.com/r/jokobsk/pi.alert)
+[![Docker Pulls](https://img.shields.io/docker/pulls/jokobsk/pi.alert?label=Pulls&logo=docker&color=0aa8d2&logoColor=fff)](https://hub.docker.com/r/jokobsk/pi.alert)
+[![Docker Pushed](https://img.shields.io/badge/dynamic/json?color=0aa8d2&logoColor=fff&label=Pushed&query=last_updated&url=https%3A%2F%2Fhub.docker.com%2Fv2%2Frepositories%2Fjokobsk%2Fpi.alert%2F&logo=docker&link=http://left&link=https://hub.docker.com/repository/docker/jokobsk/pi.alert)](https://hub.docker.com/r/jokobsk/pi.alert)
 
-## How it works
-The system continuously scans the network for:
-  - New devices
-  - New connections (re-connections)
-  - Disconnections
-  - "Always Connected" devices down
-  - Devices IP changes
-  - Internet IP address changes
+🐳 [Docker hub](https://registry.hub.docker.com/r/jokobsk/pi.alert) | 📑 [Docker instructions](https://github.com/jokob-sk/Pi.Alert/blob/main/dockerfiles/README.md) | 🆕 [Release notes](https://github.com/jokob-sk/Pi.Alert/releases) | 📚 [All Docs](https://github.com/jokob-sk/Pi.Alert/tree/main/docs)
 
-## Scan Methods
-Up to three scanning methods are used:
+## 🔍 Scan Methods
+The system continuously scans the network for, **New devices**, **New connections** (re-connections), **Disconnections**, **"Always Connected" devices down**, Devices **IP changes** and **Internet IP address changes**. Scanning methods are:
   - **Method 1: arp-scan**. The arp-scan system utility is used to search
         for devices on the network using arp frames.
   - **Method 2: Pi-hole**. This method is optional and complementary to
@@ -33,84 +29,89 @@ Up to three scanning methods are used:
         examines the DHCP leases (addresses assigned) to find active devices
         that were not discovered by the other methods.
 
-## Components
-The system consists of two parts:
+## 🧩 Integrations 
+   - [Apprise](https://hub.docker.com/r/caronc/apprise), [Pushsafer](https://www.pushsafer.com/), [NTFY](https://ntfy.sh/)
+   - [Webhooks](https://github.com/jokob-sk/Pi.Alert/blob/main/docs/WEBHOOK_N8N.md) 
+   - [Home Assistant](https://github.com/jokob-sk/Pi.Alert/blob/main/docs/HOME_ASSISTANT.md) 
+   - [API endpoint](https://github.com/jokob-sk/Pi.Alert/blob/main/docs/API.md)
+   - [Plugin system](https://github.com/jokob-sk/Pi.Alert/tree/main/front/plugins) for custom script monitoring
 
-- **Back**, in charge of:
-  - Scan the network searching connected devices using the scanning methods
-        described
-  - Store the information in the DB
-  - Report the changes detected by e-mail
-
-  | ![Report 1][report1] | ![Report 2][report2] |
-  | -------------------- | -------------------- |
-
-- **Front**, a web frontal that allows:
-  - Manage the devices inventory and the characteristics
-  - Display in a visual way all the information collected by the back
-    - Sessions
-    - Connected devices
-    - Favorites
-    - Events
-    - Presence
-    - Concurrent devices
-    - Down alerts
-    - IP's
-    - ...
-
-  | ![Screen 1][screen1] | ![Screen 2][screen2] |
-  | -------------------- | -------------------- |
-  | ![Screen 3][screen3] | ![Screen 4][screen4] |
-
-
-# Installation
-<!--- --------------------------------------------------------------------- --->
-Initially designed to run on a Raspberry PI, probably it can run on many other
-Linux distributions.
-
-  - [Installation instructions](docs/INSTALL.md)
-
-
-## Device Management
+# 📥 Installation
 <!--- --------------------------------------------------------------------- --->
 
-  - [Device Management instructions](docs/DEVICE_MANAGEMENT.md)
+ ⚠ Only tested as a [docker container - follow these instructions here](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 or original instructions for [pucherot's original code](https://github.com/pucherot/Pi.Alert/)
 
+# 📑 Features   
+  - Display:
+    - Sessions, Connected devices, Favorites, Events, Presence, Concurrent devices, Down alerts, IP's
+    - Manual Nmap scans, Optional speedtest for Device "Internet"
+    - Simple Network relationship display
+  - Maintenance tasks and Settings like:    
+    - Theme Selection (blue, red, green, yellow, black, purple) and Light/Dark-Mode Switch        
+    - DB maintenance, Backup, Restore tools and CSV Export / Import
+    - Simple login Support
+  - 🌟[Plugin system](https://github.com/jokob-sk/Pi.Alert/tree/main/front/plugins)
+    - Create custom plugins with automatically generated settings and UI. 
+    - Monitor anything for changes
+    - Check the [instructions](https://github.com/jokob-sk/Pi.Alert/tree/main/front/plugins) carefully if you are up for a challenge! Current plugins include:
+      - Detecting Rogue DHCP servers via NMAP
+      - Monitoring HTTP status changes of domains/URLs 
+      - Import devices from DHCP.leases files, a UniFi controller, or an SNMP enabled router
+      - Creation of dummy devices to visualize your [network map](https://github.com/jokob-sk/Pi.Alert/blob/main/docs/NETWORK_TREE.md)
 
-## Other useful info
-<!--- --------------------------------------------------------------------- --->
+  | ![Screen 1][screen1] | ![Screen 2][screen2] | ![Screen 5][screen5]  |
+  |----------------------|----------------------| ----------------------| 
+  | ![Screen 3][screen3] | ![Screen 4][screen4] | ![Screen 6][screen6]  |  
+  | ![Screen 8][screen8] | ![Report 2][report2] | ![Screen 9][screen9]  | 
+ 
 
-### Powered by:
-  | Product      | Objetive                               |
-  | ------------ | -------------------------------------- |
-  | Python       | Programming language for the Back      |
-  | PHP          | Programming language for the Front-end |
-  | JavaScript   | Programming language for the Front-end |
-  | Bootstrap    | Front-end framework                    |
-  | Admin.LTE    | Bootstrap template                     |
-  | FullCalendar | Calendar component                     |
-  | Sqlite       | DB engine                              |
-  | Lighttpd     | Webserver                              |
-  | arp-scan     | Scan network using arp commands        |
-  | Pi.hole      | DNS Server with Ad-block               |
-  | dnsmasq      | DHCP Server                            |
+### 🔗 Other Alternatives
+
+  - [WatchYourLAN](https://github.com/aceberg/WatchYourLAN) - Lightweight network IP scanner with web GUI (Open source)
+  - [Fing](https://www.fing.com/) - Network scanner app for your Internet security (Commercial, Phone App, Proprietary hardware)
+
+### 📚 Documentation
+
+- Initial Docker Setup: [Docker instructions](https://github.com/jokob-sk/Pi.Alert/blob/main/dockerfiles/README.md)
+- App Usage and Configuration: [All Documentation](https://github.com/jokob-sk/Pi.Alert/blob/main/docs/README.md)
 
 ### License
-  GPL 3.0
-  [Read more here](docs/LICENSE.txt)
-
-### Contact
-  pi.alert.application@gmail.com
+  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)
   
-  ***Suggestions and comments are welcome***
+### 🥇 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
+      - [Data-Monkey](https://github.com/Data-Monkey): Split-up of the python.py file and more     
+      - Please see the [Git contributors](https://github.com/jokob-sk/Pi.Alert/graphs/contributors) for a full list of people and their contributions to the project
+
+## ☕ Support me
+
+<a href="https://github.com/sponsors/jokob-sk" target="_blank"><img src="https://i.imgur.com/X6p5ACK.png" alt="Sponsor Me on GitHub" style="height: 30px !important;width: 117px !important;" width="150px" ></a>
+<a href="https://www.buymeacoffee.com/jokobsk" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" style="height: 30px !important;width: 117px !important;" width="117px" height="30px" ></a>
+<a href="https://www.patreon.com/user?u=84385063" target="_blank"><img src="https://upload.wikimedia.org/wikipedia/commons/thumb/8/82/Patreon_logo_with_wordmark.svg/512px-Patreon_logo_with_wordmark.svg.png" alt="Support me on patreon" style="height: 30px !important;width: 117px !important;" width="117px" ></a>
+
+BTC: 1N8tupjeCK12qRVU2XrV17WvKK7LCawyZM
 
 <!--- --------------------------------------------------------------------- --->
-[main]:    ./docs/img/1_devices.jpg           "Main screen"
-[screen1]: ./docs/img/2_1_device_details.jpg  "Screen 1"
-[screen2]: ./docs/img/2_2_device_sessions.jpg "Screen 2"
-[screen3]: ./docs/img/2_3_device_presence.jpg "Screen 3"
-[screen4]: ./docs/img/3_presence.jpg          "Screen 4"
+[main]:    ./docs/img/devices_split.png       "Main screen"
+[screen1]: ./docs/img/device_details.png      "Screen 1"
+[screen2]: ./docs/img/events.png              "Screen 2"
+[screen3]: ./docs/img/presence.png            "Screen 3"
+[screen4]: ./docs/img/maintenance.png         "Screen 4"
+[screen5]: ./docs/img/network.png             "Screen 5"
+[screen6]: ./docs/img/settings.png            "Screen 6"
+[screen7]: ./docs/img/help_faq.png            "Screen 7"
+[screen8]: ./docs/img/plugins_webmon.png      "Screen 8"
+[screen9]: ./docs/img/device_nmap.png         "Screen 9"
 [report1]: ./docs/img/4_report_1.jpg          "Report sample 1"
 [report2]: ./docs/img/4_report_2.jpg          "Report sample 2"
+[main_dark]: /docs/img/1_devices_dark.jpg     "Main screen dark"
+[maintain_dark]: /docs/img/5_maintain.jpg     "Maintain screen dark"
 

back/pialert-cli

@@ -0,0 +1,141 @@
+#!/bin/bash
+SCRIPT=$(readlink -f $0)
+SCRIPTPATH=`dirname $SCRIPT`
+PIA_CONF_FILE=${SCRIPTPATH}'/../config/pialert.conf'
+
+case $1 in
+
+  help)
+    echo "pialert-cli v0.1 (https://github.com/leiweibau/Pi.Alert)"
+    echo "Usage: pialert-cli <command>"
+    echo ""
+    echo "The is a list of supported commands:"
+    echo ""
+    echo " set_login                - Sets the parameter PIALERT_WEB_PROTECTION in the config file to TRUE"
+    echo "                          - If the parameter is not present, it will be created. Additionally the" 
+    echo "                            default password '123456' is set."
+    echo ""
+    echo " unset_login              - Sets the parameter PIALERT_WEB_PROTECTION in the config file to FALSE"
+    echo "                          - If the parameter is not present, it will be created. Additionally the"
+    echo "                            default password '123456' is set."
+    echo ""
+    echo " set_password <password>  - Sets the new password as a hashed value."
+    echo "                          - If the PIALERT_WEB_PROTECTION parameter does not exist yet, it will be"
+    echo "                            created and set to 'True' (login enabled)"
+    echo ""
+    echo " set_autopassword         - Sets a new random password as a hashed value and show it plaintext in"
+    echo "                            the console."
+    echo "                          - If the PIALERT_WEB_PROTECTION parameter does not exist yet, it will be"
+    echo "                            created and set to 'True' (login enabled)"
+    echo ""
+    echo " disable_scan             - Stops all active scans"
+    echo "                          - Prevents new scans from starting"
+    echo ""
+    echo " enable_scan              - Stops all active scans"
+    echo "                          - Prevents new scans from starting"
+    echo ""
+    echo ""
+    ;;
+
+  set_login)
+    ## Check if PIALERT_WEB_PROTECTION exists
+    CHECK_PROT=$(grep "PIALERT_WEB_PROTECTION" $PIA_CONF_FILE | wc -l)
+    if [ $CHECK_PROT -eq 0 ]
+    then
+        ## Create PIALERT_WEB_PROTECTION and enable it
+        sed -i "/^VENDORS_DB.*/a PIALERT_WEB_PROTECTION = True" $PIA_CONF_FILE
+        sed -i "/^PIALERT_WEB_PROTECTION.*/a PIALERT_WEB_PASSWORD = '8d969eef6ecad3c29a3a629280e686cf0c3f5d5a86aff3ca12020c923adc6c92'" $PIA_CONF_FILE
+    else
+        ## Switch PIALERT_WEB_PROTECTION to enable
+        sed -i "/PIALERT_WEB_PROTECTION/c\PIALERT_WEB_PROTECTION = True" $PIA_CONF_FILE
+    fi
+    echo "Login is now enabled"
+    ;;
+
+  unset_login)
+    ## Check if PIALERT_WEB_PROTECTION exists
+    CHECK_PROT=$(grep "PIALERT_WEB_PROTECTION" $PIA_CONF_FILE | wc -l)
+    if [ $CHECK_PROT -eq 0 ]
+    then
+        ## Create PIALERT_WEB_PROTECTION and disable it
+        sed -i "/^VENDORS_DB.*/a PIALERT_WEB_PROTECTION = False" $PIA_CONF_FILE
+        sed -i "/^PIALERT_WEB_PROTECTION.*/a PIALERT_WEB_PASSWORD = '8d969eef6ecad3c29a3a629280e686cf0c3f5d5a86aff3ca12020c923adc6c92'" $PIA_CONF_FILE
+    else
+        ## Switch PIALERT_WEB_PROTECTION to disable
+        sed -i "/PIALERT_WEB_PROTECTION/c\PIALERT_WEB_PROTECTION = False" $PIA_CONF_FILE
+    fi
+    echo "Login is now disabled"
+    ;;
+
+  set_password)
+    PIA_PASS=$2
+    ## Check if PIALERT_WEB_PROTECTION exists
+    CHECK_PROT=$(grep "PIALERT_WEB_PROTECTION" $PIA_CONF_FILE | wc -l)
+    if [ $CHECK_PROT -eq 0 ]
+    then
+        ## Create PIALERT_WEB_PROTECTION and enable it
+        sed -i "/^VENDORS_DB.*/a PIALERT_WEB_PROTECTION = True" $PIA_CONF_FILE
+    fi
+    ## Prepare Hash
+    PIA_PASS_HASH=$(echo -n $PIA_PASS | sha256sum | awk '{print $1}')
+    echo "   The hashed password is:"
+    echo "   $PIA_PASS_HASH"
+    ## Check if the password parameter is set
+    CHECK_PWD=$(grep "PIALERT_WEB_PASSWORD" $PIA_CONF_FILE | wc -l)
+    if [ $CHECK_PWD -eq 0 ]
+    then
+        sed -i "/^PIALERT_WEB_PROTECTION.*/a PIALERT_WEB_PASSWORD = '$PIA_PASS_HASH'" $PIA_CONF_FILE
+    else
+        sed -i "/PIALERT_WEB_PASSWORD/c\PIALERT_WEB_PASSWORD = '$PIA_PASS_HASH'" $PIA_CONF_FILE
+    fi
+    echo ""
+    echo "The new password is set"
+    ;;
+
+  set_autopassword)
+    ## Check if PIALERT_WEB_PROTECTION exists
+    CHECK_PROT=$(grep "PIALERT_WEB_PROTECTION" $PIA_CONF_FILE | wc -l)
+    if [ $CHECK_PROT -eq 0 ]
+    then
+        ## Create PIALERT_WEB_PROTECTION and enable it
+        sed -i "/^VENDORS_DB.*/a PIALERT_WEB_PROTECTION = True" $PIA_CONF_FILE
+    fi
+    ## Create autopassword
+    PIA_AUTOPASS=$(cat /dev/urandom | tr -dc 'a-zA-Z0-9' | fold -w 8 | head -n 1)
+    echo "   The password is: $PIA_AUTOPASS"
+    ## Prepare Hash
+    PIA_AUTOPASS_HASH=$(echo -n $PIA_AUTOPASS | sha256sum | awk '{print $1}')
+    echo "   The hashed password is:"
+    echo "   $PIA_AUTOPASS_HASH"
+    ## Check if the password parameter is set
+    CHECK_PWD=$(grep "PIALERT_WEB_PASSWORD" $PIA_CONF_FILE | wc -l)
+    if [ $CHECK_PWD -eq 0 ]
+    then
+        ## Create password parameter
+        sed -i "/^PIALERT_WEB_PROTECTION.*/a PIALERT_WEB_PASSWORD = '$PIA_AUTOPASS_HASH'" $PIA_CONF_FILE
+    else
+        ## Overwrite password parameter
+        sed -i "/PIALERT_WEB_PASSWORD/c\PIALERT_WEB_PASSWORD = '$PIA_AUTOPASS_HASH'" $PIA_CONF_FILE
+    fi
+    echo ""
+    echo "The new password is set"
+    ;;
+
+  disable_scan)
+    ## stop active scans
+    sudo killall arp-scan
+    touch ${SCRIPTPATH}/../db/setting_stoparpscan
+    echo "The arp-scan is disabled"
+    ;;
+
+  enable_scan)
+    ## stop active scans
+    rm ${SCRIPTPATH}/../db/setting_stoparpscan
+    echo "The arp-scan is enabled"
+    ;;
+
+  *)
+    echo "pialert-cli v0.1 (https://github.com/leiweibau/Pi.Alert)"
+    echo "Use \"pialert-cli help\" for a list of supported commands."
+esac
+

back/pialert.conf

@@ -1,31 +0,0 @@
-VERSION           = '2.56'
-VERSION_YEAR      = '2021'
-VERSION_DATE      = '2021-01-15'
-
-DB_PATH           = '/home/pi/pialert/db/pialert.db'
-LOG_PATH          = '/home/pi/pialert/log'
-VENDORS_DB        = '/usr/share/arp-scan/ieee-oui.txt'
-PA_FRONT_URL      = 'http://pi.alert/deviceDetails.php?mac='
-PRINT_LOG         = False
-
-SMTP_SERVER       = 'smtp.gmail.com'
-SMTP_PORT         = 587
-SMTP_USER         = 'user@gmail.com'
-SMTP_PASS         = 'password'
-
-REPORT_MAIL       = False
-REPORT_FROM       = 'Pi.Alert <' + SMTP_USER +'>'
-REPORT_TO         = 'user@gmail.com'
-
-# QUERY_MYIP_SERVER = 'https://diagnostic.opendns.com/myip'
-QUERY_MYIP_SERVER = 'http://ipv4.icanhazip.com'
-DDNS_ACTIVE       = False
-DDNS_DOMAIN       = 'your_domain.freeddns.org'
-DDNS_USER         = 'dynu_user'
-DDNS_PASSWORD     = 'A0000000B0000000C0000000D0000000'
-DDNS_UPDATE_URL   = 'https://api.dynu.com/nic/update?'
-
-PIHOLE_ACTIVE     = False
-PIHOLE_DB         = '/etc/pihole/pihole-FTL.db'
-DHCP_ACTIVE       = False
-DHCP_LEASES       = '/etc/pihole/dhcp.leases'

back/pialert.cron

@@ -1,7 +0,0 @@
-#
-# Pi.Alert cron
-#
-0 3 * * 1      python ~/pialert/back/pialert.py update_vendors >~/pialert/log/pialert.vendors.log  2>&1
-*/1 * * * *    python ~/pialert/back/pialert.py internet_IP    >~/pialert/log/pialert.IP.log       2>&1
-*/5 * * * *    python ~/pialert/back/pialert.py 1              >~/pialert/log/pialert.1.log        2>&1
-*/15 * * * *   python ~/pialert/back/pialert.py 15             >~/pialert/log/pialert.15.log       2>&1

back/report_sample.html

@@ -0,0 +1,173 @@
+<!-- ---------------------------------------------------------------------------
+   #  Pi.Alert
+   #  Open Source Network Guard / WIFI & LAN intrusion detector 
+   #
+   #  repot_template.html - Back module. Template to email reporting in HTML format
+   #-------------------------------------------------------------------------------
+   #  Puche 2021                GNU GPLv3
+   #--------------------------------------------------------------------------- -->
+   <html>
+    <head></head>
+    <body>
+       <font face=sans-serif>
+          <table align=center width=100% cellpadding=0 cellspacing=0 style="border-radius: 5px;">
+             <tr>
+                <td bgcolor=#EFB956  align=center style="padding: 20px 10px 10px 10px; font-size: 30px; font-weight: bold; color:#000000; border-top-right-radius: 5px; border-top-left-radius: 5px; box-shadow: 0 4px 8px 0 rgba(0, 0, 0, 0.2)">
+                   Pi.Alert Report
+                </td>
+             </tr>
+             <tr>
+                <td bgcolor=#2656f1 width=100% align=center style="padding: 20px 10px 10px 10px; font-size: 20px; font-weight: bold; color:#ffffff; box-shadow: 0 4px 8px 0 rgba(0, 0, 0, 0.2)">
+                   <a style="color:#ffffff;cursor:pointer;" href="https://github.com/jokob-sk/Pi.Alert/releases">🆕 New version available 🆕</a>
+                </td>
+             </tr>
+             <tr>
+                <td>
+                   <table width=100% border=0 bgcolor=#FFD966 cellpadding=5px cellspacing=0 style="border-collapse: collapse; font-size: 15px; text-align:center; color:#404040">
+                      <tr>
+                         <td width=100%> Report Date: <b>2023-01-30 22:17</b> </td>
+                      </tr>
+                   </table>
+                </td>
+             </tr>
+             <tr>
+                <td bgcolor=#F5F5F5 height=200 valign=top style="padding: 10px">
+                   <table style="border-collapse: collapse; font-size: 12px; color:#70707" width="100%" cellspacing="0" cellpadding="3px" bordercolor="#C0C0C0" border="1">
+                      <tr>
+                         <th width='120px' style='color:blue; font-size: 12px;' bgcolor='#909090'  >New devices</th>
+                      </tr>
+                      <tr>
+                         <td>
+                            <table style="border-collapse: collapse; font-size: 12px; color:#70707" width="100%" cellspacing="0" cellpadding="3px" bordercolor="#C0C0C0" border="1">
+                               <tr>
+                                  <th width='120px' style='color:#F0F0F0' bgcolor='#909090'  >MAC</th>
+                                  <th width='120px' style='color:#F0F0F0' bgcolor='#909090'  >Datetime</th>
+                                  <th width='120px' style='color:#F0F0F0' bgcolor='#909090'  >IP</th>
+                                  <th width='120px' style='color:#F0F0F0' bgcolor='#909090'  >Event Type</th>
+                                  <th width='120px' style='color:#F0F0F0' bgcolor='#909090'  >Device name</th>
+                                  <th width='120px' style='color:#F0F0F0' bgcolor='#909090'  >Comments</th>
+                               </tr>
+                               <tr>
+                                  <td><a href="http://192.168.1.1:20211/deviceDetails.php?mac=00:00:00:ef:a5:6c">00:00:00:ef:a5:6c</a></td>
+                                  <td>2023-01-30 22:15:09</td>
+                                  <td>192.168.1.1</td>
+                                  <td>New Device</td>
+                                  <td>(name not found)</td>
+                                  <td></td>
+                               </tr>
+                               <tr>
+                                  <td><a href="http://192.168.1.1:20211/deviceDetails.php?mac=00:00:00:ef:a5:6c">00:00:00:ef:a5:6c</a></td>
+                                  <td>2023-01-30 22:17:59</td>
+                                  <td>192.168.1.82</td>
+                                  <td>New Device</td>
+                                  <td>(name not found)</td>
+                                  <td></td>
+                               </tr>
+                            </table>
+                         </td>
+                      </tr>
+                   </table>
+                   <table style="border-collapse: collapse; font-size: 12px; color:#70707" width="100%" cellspacing="0" cellpadding="3px" bordercolor="#C0C0C0" border="1">
+                      <tr>
+                         <th width='120px' style='color:blue; font-size: 12px;' bgcolor='#909090'  >Events</th>
+                      </tr>
+                      <tr>
+                         <td>
+                            <ul>
+                               <li>
+                                  <table style="border-collapse: collapse; font-size: 12px; color:#70707" width="100%" cellspacing="0" cellpadding="3px" bordercolor="#C0C0C0" border="1">
+                                     <tr>
+                                        <th width='120px' style='color:#F0F0F0' bgcolor='#909090'  >MAC</th>
+                                        <th width='120px' style='color:#F0F0F0' bgcolor='#909090'  >Datetime</th>
+                                        <th width='120px' style='color:#F0F0F0' bgcolor='#909090'  >IP</th>
+                                        <th width='120px' style='color:#F0F0F0' bgcolor='#909090'  >Event Type</th>
+                                        <th width='120px' style='color:#F0F0F0' bgcolor='#909090'  >Device name</th>
+                                        <th width='120px' style='color:#F0F0F0' bgcolor='#909090'  >Comments</th>
+                                     </tr>
+                                     <tr>
+                                        <td><a href="http://192.168.1.1:20211/deviceDetails.php?mac=00:00:00:ef:a5:6c">00:00:00:ef:a5:6c</a></td>
+                                        <td>2023-01-30 22:15:09</td>
+                                        <td>192.168.1.92</td>
+                                        <td>Disconnected</td>
+                                        <td>(name not found)</td>
+                                        <td></td>
+                                     </tr>
+                                  </table>
+                               </li>
+                            </ul>
+                         </td>
+                      </tr>
+                   </table>
+                   <table style="border-collapse: collapse; font-size: 12px; color:#70707" width="100%" cellspacing="0" cellpadding="3px" bordercolor="#C0C0C0" border="1">
+                      <tr>
+                         <th width='120px' style='color:blue; font-size: 12px;' bgcolor='#909090'  >Changed or new ports</th>
+                      </tr>
+                      <tr>
+                         <td>
+                            <table style="border-collapse: collapse; font-size: 12px; color:#70707" width="100%" cellspacing="0" cellpadding="3px" bordercolor="#C0C0C0" border="1">
+                               <tr>
+                                  <th>new</th>
+                               </tr>                              
+                               <tr>
+                                  <td>
+                                     <table style="border-collapse: collapse; font-size: 12px; color:#70707" width="100%" cellspacing="0" cellpadding="3px" bordercolor="#C0C0C0" border="1">
+                                        <tr>
+                                           <th width='120px' style='color:#F0F0F0' bgcolor='#909090'  >Name</th>
+                                           <th width='120px' style='color:#F0F0F0' bgcolor='#909090'  >MAC</th>
+                                           <th width='120px' style='color:#F0F0F0' bgcolor='#909090'  >Port</th>
+                                           <th width='120px' style='color:#F0F0F0' bgcolor='#909090'  >State</th>
+                                           <th width='120px' style='color:#F0F0F0' bgcolor='#909090'  >Service</th>
+                                           <th width='120px' style='color:#F0F0F0' bgcolor='#909090'  >Extra</th>
+                                        </tr>
+                                        <tr>
+                                           <td>New device</td>
+                                           <td><a href="http://192.168.1.1:20211/deviceDetails.php?mac=00:00:00:ef:a5:6c">00:00:00:ef:a5:6c</a></td>
+                                           <td>3263/tcp</td>
+                                           <td>open</td>
+                                           <td>ecolor-imager</td>
+                                           <td></td>
+                                        </tr>
+                                     </table>
+                                  </td>
+                               </tr>
+                               <tr>
+                                  <td>
+                                     <table style="border-collapse: collapse; font-size: 12px; color:#70707" width="100%" cellspacing="0" cellpadding="3px" bordercolor="#C0C0C0" border="1">
+                                        <tr>
+                                           <th width='120px' style='color:#F0F0F0' bgcolor='#909090'  >Name</th>
+                                           <th width='120px' style='color:#F0F0F0' bgcolor='#909090'  >MAC</th>
+                                           <th width='120px' style='color:#F0F0F0' bgcolor='#909090'  >Port</th>
+                                           <th width='120px' style='color:#F0F0F0' bgcolor='#909090'  >State</th>
+                                           <th width='120px' style='color:#F0F0F0' bgcolor='#909090'  >Service</th>
+                                           <th width='120px' style='color:#F0F0F0' bgcolor='#909090'  >Extra</th>
+                                        </tr>
+                                        <tr>
+                                           <td>New device</td>
+                                           <td><a href="http://192.168.1.1:20211/deviceDetails.php?mac=00:00:00:ef:a5:6c">00:00:00:ef:a5:6c</a></td>
+                                           <td>3264/tcp</td>
+                                           <td>open</td>
+                                           <td>ccmail</td>
+                                           <td></td>
+                                        </tr>
+                                     </table>
+                                  </td>
+                               </tr>
+                               
+                            </table>
+                         </td>
+                      </tr>
+                   </table>
+             <tr>
+                <td>
+                   <table width=100% bgcolor=#46802e cellpadding=5px cellspacing=0 style="font-size: 13px; font-weight: bold; border-bottom-left-radius: 5px; border-bottom-right-radius: 5px;">
+                      <tr>
+                         <td width=50% style="text-align:center"> Pi.Alert - Synology-NAS</td>
+                      </tr>
+                   </table>
+                </td>
+             </tr>
+          </table>
+       </font>
+    </body>
+ </html>
+ 

back/report_sample.txt

@@ -0,0 +1,50 @@
+Report Date: 2021-12-08 12:30
+Server:      Synology-NAS
+
+New Devices
+----------------------
+Name: 	(name not found)
+	MAC: 	2c:2c:2c:2c:2c:2c
+	IP: 	192.168.1.121
+	Time: 	2021-12-08 12:30
+	More Info: 	Micro-Star INTL CO., LTD.
+
+Name: 	(name not found)
+	MAC: 	2c:2c:2c:2c:2c:2c
+	IP: 	192.168.1.151
+	Time: 	2021-12-08 12:30
+	More Info: 	Espressif Inc.
+
+
+
+Events
+----------------------
+Name: 	Samsung
+	MAC: 	2c:2c:2c:2c:2c:2c
+	IP: 	192.168.1.27
+	Time: 	2021-12-08 12:30
+	Event: 	Connected
+	More Info: 	
+
+Name: 	(name not found)
+	MAC: 	2c:2c:2c:2c:2c:2c
+	IP: 	192.168.1.6
+	Time: 	2021-12-08 12:30
+	Event: 	Disconnected
+	More Info: 	
+
+Name: 	Google-Home-Mini
+	MAC: 	2c:2c:2c:2c:2c:2c
+	IP: 	192.168.1.16
+	Time: 	2021-12-08 12:30
+	Event: 	Disconnected
+	More Info: 	
+
+Name: 	(name not found)
+	MAC: 	2c:2c:2c:2c:2c:2c
+	IP: 	192.168.1.119
+	Time: 	2021-12-08 12:30
+	Event: 	Disconnected
+	More Info: 	
+
+

back/report_template.html

@@ -1,3 +1,12 @@
+<!-- ---------------------------------------------------------------------------
+#  Pi.Alert
+#  Open Source Network Guard / WIFI & LAN intrusion detector 
+#
+#  repot_template.html - Back module. Template to email reporting in HTML format
+#-------------------------------------------------------------------------------
+#  Puche 2021               GNU GPLv3
+#--------------------------------------------------------------------------- -->
+
 <html>
 
 <head>
@@ -5,20 +14,17 @@
 
 <body>
     <font face=sans-serif>
-    <table align=center width=80% border=1 bordercolor=#909090 cellpadding=0 cellspacing=0 style="border-collapse: collapse; box-shadow: 0 4px 8px 0 rgba(0, 0, 0, 0.2), 0 6px 20px 0 rgba(0, 0, 0, 0.5)">
+    <table align=center width=100% cellpadding=0 cellspacing=0 style="border-radius: 5px;">
         <tr>
-        <td bgcolor=#EFB956  align=center style="padding: 20px 10px 10px 10px; font-size: 36px; font-weight: bold; color:#7F6000; text-shadow: 4px 4px 6px #909090">
+        <td bgcolor=#EFB956  align=center style="padding: 20px 10px 10px 10px; font-size: 30px; font-weight: bold; color:#000000; border-top-right-radius: 5px; border-top-left-radius: 5px; box-shadow: 0 4px 8px 0 rgba(0, 0, 0, 0.2)">
             Pi.Alert Report
         </td>
         </tr>
-
+        
         <tr>
         <td>
-            <table width=100% border=0 bgcolor=#FFD966 cellpadding=5px cellspacing=0 style="border-collapse: collapse; font-size: 16px; text-align:center; color:#5F5000">
-            <tr>
-                <td width=33%> Report Date: <b><REPORT_DATE></b> </td>
-                <td width=34%> Scan Cycle: <b><SCAN_CYCLE></b> </td>
-                <td width=33%> Server: <b><SERVER_NAME></b> </td>
+            <table width=100% border=0 bgcolor=#FFD966 cellpadding=5px cellspacing=0 style="border-collapse: collapse; font-size: 15px; text-align:center; color:#404040">            <tr>
+                <td width=100%> Report Date: <b><REPORT_DATE></b> </td>
             </tr>
             </table>
         </td>
@@ -26,84 +32,21 @@
 
         <tr>
         <td bgcolor=#F5F5F5 height=200 valign=top style="padding: 10px">
-            <SECTION_INTERNET>
-            <p style="font-size: 24px; font-weight: bold; color:#C04040; text-shadow: 2px 2px 4px #A0A0A0"> Internet: </p> 
-
-            <table width=100% border=1 bordercolor=#C0C0C0 cellpadding=3px cellspacing=0 style="border-collapse: collapse; font-size: 12px; color:#707070; box-shadow: 0 4px 8px 0 rgba(0, 0, 0, 0.2)">
-                <tr bgcolor=#909090 style="color:#F0F0F0">
-                    <th width=140> Event Type </th>
-                    <th width=130> Datetime </th>
-                    <th width=100> IP </th>
-                    <th> Additional Info </th>
-                </tr>
-
-                <TABLE_INTERNET>
-            </table>
-
-            <br>
-            </SECTION_INTERNET>
-
-            <SECTION_NEW_DEVICES>
-            <p style="font-size: 14px; font-weight: bold; color:#C04040; text-shadow: 2px 2px 4px #A0A0A0"> New Devices: </p> 
-
-            <table width=100% border=1 bordercolor=#C0C0C0 cellpadding=3px cellspacing=0 style="border-collapse: collapse; font-size: 12px; color:#707070; box-shadow: 0 4px 8px 0 rgba(0, 0, 0, 0.2)">
-                <tr bgcolor=#909090 style="color:#F0F0F0">
-                    <th width=140> MAC </th>
-                    <th width=130> Datetime </th>
-                    <th width=100> IP </th>
-                    <th width=140> Device Name </th>
-                    <th> Vendor </th>
-                </tr>
-
-                <TABLE_NEW_DEVICES>
-            </table>
-
-            <br>
-            </SECTION_NEW_DEVICES>
-
-            <SECTION_DEVICES_DOWN>
-            <p style="font-size: 14px; font-weight: bold; color:#C04040; text-shadow: 2px 2px 4px #A0A0A0"> Devices Down: </p> 
-
-            <table width=100% border=1 bordercolor=#C0C0C0 cellpadding=3px cellspacing=0 style="border-collapse: collapse; font-size: 12px; color:#707070; box-shadow: 0 4px 8px 0 rgba(0, 0, 0, 0.2)">
-                <tr bgcolor=#909090 style="color:#F0F0F0">
-                    <th width=140> MAC </th>
-                    <th width=130> Datetime </th>
-                    <th width=100> IP </th>
-                    <th> Device Name </th>
-                </tr>
-
-                <TABLE_DEVICES_DOWN>
-            </table>
-
-            <br>
-            </SECTION_DEVICES_DOWN>
-
-            <SECTION_EVENTS>
-            <p style="font-size: 14px; font-weight: bold; color:#409040; text-shadow: 2px 2px 4px #A0A0A0"> Events: </p> 
-
-            <table width=100% border=1 bordercolor=#C0C0C0 cellpadding=3px cellspacing=0 style="border-collapse: collapse; font-size: 12px; color:#707070; box-shadow: 0 4px 8px 0 rgba(0, 0, 0, 0.2)">
-                <tr bgcolor=#909090 style="color:#F0F0F0">
-                    <th width=140> MAC </th>
-                    <th width=130> Datetime </th>
-                    <th width=100> IP </th>
-                    <th width=100> Event Type </th>
-                    <th width=140> Device Name </th>
-                    <th> Additional Info </th>
-                </tr>
-
-                <TABLE_EVENTS>
-            </table>
-            </SECTION_EVENTS>
+            
+                <INTERNET_TABLE>
+                <NEW_DEVICES_TABLE>            
+                <DOWN_DEVICES_TABLE>            
+                <EVENTS_TABLE>            
+                <PORTS_TABLE>
+                <PLUGINS_TABLE>
         </td>
         </tr>
         
         <tr>
         <td>
-            <table width=100% border=0 bgcolor=#70AD47 cellpadding=5px cellspacing=0 style="border-collapse: collapse; font-size: 12px; font-weight: bold; color:#385723">
+            <table width=100% bgcolor=#46802e cellpadding=5px cellspacing=0 style="font-size: 13px; font-weight: bold; border-bottom-left-radius: 5px; border-bottom-right-radius: 5px;">
                <tr>
-                    <td width=25% style="text-align:Left">   Puche <PIALERT_YEAR></td>
-                    <td width=50% style="text-align:center"> Pi.Alert <PIALERT_VERSION> &nbsp; / &nbsp; <PIALERT_VERSION_DATE>  </td>
-                    <td width=25% style="text-align:right">  GNU GPLv3</td>
+                    <td width=50% style="text-align:center"> Pi.Alert - <SERVER_NAME></td>                    
                 </tr>
             </table>
         </td>
@@ -111,4 +54,4 @@
     </table>
     </font>
 </body>
-</html>
+</html>

back/report_template.txt

@@ -1,27 +1,9 @@
-========================================
-            Pi.Alert Report
-========================================
-
-  Report Date: <REPORT_DATE>
-  Scan Cycle:  <SCAN_CYCLE>
-  Server:      <SERVER_NAME>
+Report Date: <REPORT_DATE>
+Server:      <SERVER_NAME>
 
+<SECTION_NEW_DEVICES>
+<SECTION_DEVICES_DOWN>
+<SECTION_EVENTS>
 <SECTION_INTERNET>
-Internet
-----------------------------------------------------------------------
-<TABLE_INTERNET>
-</SECTION_INTERNET><SECTION_NEW_DEVICES>
-New Devices
-----------------------------------------------------------------------
-<TABLE_NEW_DEVICES>
-</SECTION_NEW_DEVICES><SECTION_DEVICES_DOWN>
-Devices Down
-----------------------------------------------------------------------
-<TABLE_DEVICES_DOWN>
-</SECTION_DEVICES_DOWN><SECTION_EVENTS>
-Events
-----------------------------------------------------------------------
-<TABLE_EVENTS>
-</SECTION_EVENTS>
-----------------------------------------------------------------------
-Puche <PIALERT_YEAR>            Pi.Alert <PIALERT_VERSION> / <PIALERT_VERSION_DATE>             GNU GPLv3
+<PORTS_TABLE>
+<PLUGINS_TABLE>

back/report_template_new_version.html

@@ -0,0 +1,61 @@
+<!-- ---------------------------------------------------------------------------
+#  Pi.Alert
+#  Open Source Network Guard / WIFI & LAN intrusion detector 
+#
+#  repot_template.html - Back module. Template to email reporting in HTML format
+#-------------------------------------------------------------------------------
+#  Puche 2021                GNU GPLv3
+#--------------------------------------------------------------------------- -->
+
+<html>
+
+<head>
+</head>
+
+<body>
+    <font face=sans-serif>
+    <table align=center width=100% cellpadding=0 cellspacing=0 style="border-radius: 5px;">
+        <tr>
+        <td bgcolor=#EFB956  align=center style="padding: 20px 10px 10px 10px; font-size: 30px; font-weight: bold; color:#000000; border-top-right-radius: 5px; border-top-left-radius: 5px; box-shadow: 0 4px 8px 0 rgba(0, 0, 0, 0.2)">
+            Pi.Alert Report
+        </td>
+        </tr>
+        <tr> 
+            <td bgcolor=#2656f1 width=100% align=center style="padding: 20px 10px 10px 10px; font-size: 20px; font-weight: bold; color:#ffffff; box-shadow: 0 4px 8px 0 rgba(0, 0, 0, 0.2)">
+                <a style="color:#ffffff;cursor:pointer;" href="https://github.com/jokob-sk/Pi.Alert/releases">🆕 New version available 🆕</a>
+            </td>             
+        </tr>
+        <tr>
+        <td>
+            <table width=100% border=0 bgcolor=#FFD966 cellpadding=5px cellspacing=0 style="border-collapse: collapse; font-size: 15px; text-align:center; color:#404040">            <tr>
+                <td width=100%> Report Date: <b><REPORT_DATE></b> </td>
+            </tr>
+            </table>
+        </td>
+        </tr>
+
+        <tr>
+        <td bgcolor=#F5F5F5 height=200 valign=top style="padding: 10px">
+
+            <INTERNET_TABLE>
+            <NEW_DEVICES_TABLE>            
+            <DOWN_DEVICES_TABLE>            
+            <EVENTS_TABLE>            
+            <PORTS_TABLE>
+            <PLUGINS_TABLE>
+        
+        <tr>
+        <td>
+            <table width=100% bgcolor=#46802e cellpadding=5px cellspacing=0 style="font-size: 13px; font-weight: bold; border-bottom-left-radius: 5px; border-bottom-right-radius: 5px;">
+               <tr>
+                    <td width=50% style="text-align:center"> Pi.Alert - <SERVER_NAME></td>                    
+                </tr>
+            </table>
+        </td>
+        </tr>
+    </table>
+    </font>
+
+
+</body>
+</html>

back/update_vendors.sh

@@ -0,0 +1,64 @@
+#!/bin/sh
+# ------------------------------------------------------------------------------
+#  Pi.Alert
+#  Open Source Network Guard / WIFI & LAN intrusion detector 
+#
+#  update_vendors.sh - Back module. IEEE Vendors db update
+# ------------------------------------------------------------------------------
+#  Puche 2021 / 2022+ jokob             jokob@duck.com                GNU GPLv3
+# ------------------------------------------------------------------------------
+
+# ----------------------------------------------------------------------
+#  Main directories to update:
+#    /usr/share/arp-scan
+#    /usr/share/ieee-data
+#    /var/lib/ieee-data
+# ----------------------------------------------------------------------
+
+
+# ----------------------------------------------------------------------
+echo Updating... /usr/share/ieee-data/
+cd /usr/share/ieee-data/
+
+sudo mkdir -p 2_backup
+sudo cp *.txt 2_backup
+sudo cp *.csv 2_backup
+echo ""
+echo Download Start
+echo ""
+sudo curl $1  -LO https://standards-oui.ieee.org/iab/iab.csv \
+              -LO https://standards-oui.ieee.org/iab/iab.txt \
+              -LO https://standards-oui.ieee.org/oui28/mam.csv \
+              -LO https://standards-oui.ieee.org/iab/iab.txt \
+              -LO https://standards-oui.ieee.org/oui28/mam.csv \
+              -LO https://standards-oui.ieee.org/oui28/mam.txt \
+              -LO https://standards-oui.ieee.org/oui36/oui36.csv \
+              -LO https://standards-oui.ieee.org/oui36/oui36.txt \
+              -LO https://standards-oui.ieee.org/oui/oui.csv \
+              -LO https://standards-oui.ieee.org/oui/oui.txt
+echo ""
+echo Download Finished
+
+# ----------------------------------------------------------------------
+echo ""
+echo Updating... /usr/share/arp-scan/
+cd /usr/share/arp-scan
+
+sudo mkdir -p 2_backup
+sudo cp *.txt 2_backup
+
+# Update from /usb/lib/ieee-data
+sudo get-iab -v
+sudo get-oui -v
+
+# Update from ieee website
+# sudo get-iab -v -u http://standards-oui.ieee.org/iab/iab.txt
+# sudo get-oui -v -u http://standards-oui.ieee.org/oui/oui.txt
+
+# Update from ieee website develop
+# sudo get-iab -v -u http://standards.ieee.org/develop/regauth/iab/iab.txt
+# sudo get-oui -v -u http://standards.ieee.org/develop/regauth/oui/oui.txt
+
+# Update from Sanitized oui (linuxnet.ca)
+# sudo get-oui -v -u https://linuxnet.ca/ieee/oui.txt
+

back/vendors_db_update.sh

@@ -1,54 +0,0 @@
-#!/bin/sh
-#
-# Update MAC Vendor DB
-#
-# /usr/share/arp-scan
-# /usr/share/ieee-data
-# /var/lib/ieee-data
-# ----------------------------------------------------------------------
-
-
-# ----------------------------------------------------------------------
-echo Updating... /usr/share/ieee-data/
-cd /usr/share/ieee-data/
-
-sudo mkdir -p 2_backup
-sudo cp *.txt 2_backup
-sudo cp *.csv 2_backup
-
-sudo curl -# -O http://standards-oui.ieee.org/iab/iab.csv
-sudo curl -# -O http://standards-oui.ieee.org/iab/iab.txt
-
-sudo curl -# -O http://standards-oui.ieee.org/oui28/mam.csv
-sudo curl -# -O http://standards-oui.ieee.org/oui28/mam.txt
-
-sudo curl -# -O http://standards-oui.ieee.org/oui36/oui36.csv
-sudo curl -# -O http://standards-oui.ieee.org/oui36/oui36.txt
-
-sudo curl -# -O http://standards-oui.ieee.org/oui/oui.csv
-sudo curl -# -O http://standards-oui.ieee.org/oui/oui.txt
-
-
-# ----------------------------------------------------------------------
-echo ""
-echo Updating... /usr/share/arp-scan/
-cd /usr/share/arp-scan
-
-sudo mkdir -p 2_backup
-sudo cp *.txt 2_backup
-
-# Update from /usb/lib/ieee-data
-sudo get-iab -v
-sudo get-oui -v
-
-# Update from ieee website
-# sudo get-iab -v -u http://standards-oui.ieee.org/iab/iab.txt
-# sudo get-oui -v -u http://standards-oui.ieee.org/oui/oui.txt
-
-# Update from ieee website develop
-# sudo get-iab -v -u http://standards.ieee.org/develop/regauth/iab/iab.txt
-# sudo get-oui -v -u http://standards.ieee.org/develop/regauth/oui/oui.txt
-
-# Update from Sanitized oui (linuxnet.ca)
-# sudo get-oui -v -u https://linuxnet.ca/ieee/oui.txt
-

back/webhook_json_sample.json

@@ -0,0 +1,87 @@
+[
+    {
+        "headers": {
+            "host": "192.168.1.82:5678",
+            "user-agent": "curl/7.74.0",
+            "accept": "*/*",
+            "content-type": "application/json",
+            "content-length": "872"
+        },
+        "params": {},
+        "query": {},
+        "body": {
+            "username": "Pi.Alert",
+            "text": "There are new notifications",
+            "attachments": [
+                {
+                    "title": "Pi.Alert Notifications",
+                    "title_link": "",
+                    "text": {
+                      "internet": [],
+                      "new_devices": [{
+                        "MAC": "74:ac:74:ac:74:ac",
+                        "Datetime": "2023-01-30 22:15:09",
+                        "IP": "192.168.1.1",
+                        "Event Type": "New Device",
+                        "Device name": "(name not found)",
+                        "Comments": null
+                      }],
+                      "down_devices": [],
+                      "events": [{
+                        "MAC": "74:ac:74:ac:74:ac",
+                        "Datetime": "2023-01-30 22:15:09",
+                        "IP": "192.168.1.92",
+                        "Event Type": "Disconnected",
+                        "Device name": "(name not found)",
+                        "Comments": null
+                      }, {
+                        "MAC": "74:ac:74:ac:74:ac",
+                        "Datetime": "2023-01-30 22:15:09",
+                        "IP": "192.168.1.150",
+                        "Event Type": "Disconnected",
+                        "Device name": "(name not found)",
+                        "Comments": null
+                      }],
+                      "ports": [{
+                        "new": {
+                          "Name": "New device",
+                          "MAC": "74:ac:74:ac:74:ac",
+                          "Port": "22/tcp",
+                          "State": "open",
+                          "Service": "ssh",
+                          "Extra": ""
+                        }
+                      }, {
+                        "new": {
+                          "Name": "New device",
+                          "MAC": "74:ac:74:ac:74:ac",
+                          "Port": "53/tcp",
+                          "State": "open",
+                          "Service": "domain",
+                          "Extra": ""
+                        }
+                      }, {
+                        "new": {
+                          "Name": "New device",
+                          "MAC": "74:ac:74:ac:74:ac",
+                          "Port": "80/tcp",
+                          "State": "open",
+                          "Service": "http",
+                          "Extra": ""
+                        }
+                      }, {
+                        "new": {
+                          "Name": "New device",
+                          "MAC": "74:ac:74:ac:74:ac",
+                          "Port": "443/tcp",
+                          "State": "open",
+                          "Service": "https",
+                          "Extra": ""
+                        }
+                      }]
+                    }
+                }
+            ]
+        }
+    }
+]

config/pialert.conf

@@ -0,0 +1,118 @@
+#-----------------AUTOGENERATED FILE-----------------#
+#                                                    #
+#         Generated:  2022-12-30_22-19-40            #
+#                                                    #
+#   Config file for the LAN intruder detection app:  #
+#      https://github.com/jokob-sk/Pi.Alert          #
+#                                                    #
+#-----------------AUTOGENERATED FILE-----------------#
+
+
+# General
+#---------------------------
+# Scan using interface eth0
+# SCAN_SUBNETS    = ['192.168.1.0/24 --interface=eth0']
+#
+# Scan multiple interfaces (eth1 and eth0):
+# SCAN_SUBNETS    = [ '192.168.1.0/24 --interface=eth1', '192.168.1.0/24 --interface=eth0' ]
+SCAN_SUBNETS=['192.168.1.0/24 --interface=eth1']
+PRINT_LOG=False
+TIMEZONE='Europe/Berlin'
+PIALERT_WEB_PROTECTION=False
+PIALERT_WEB_PASSWORD='8d969eef6ecad3c29a3a629280e686cf0c3f5d5a86aff3ca12020c923adc6c92'
+INCLUDED_SECTIONS=['internet','new_devices','down_devices','events']
+SCAN_CYCLE_MINUTES=5
+DAYS_TO_KEEP_EVENTS=90
+# Used for generating links in emails. Make sure not to add a trailing slash!
+REPORT_DASHBOARD_URL='http://pi.alert'
+
+
+# Email
+#---------------------------
+REPORT_MAIL=False
+SMTP_SERVER='smtp.gmail.com'
+SMTP_PORT=587
+REPORT_TO='user@gmail.com'
+REPORT_FROM='Pi.Alert <user@gmail.com>'
+SMTP_SKIP_LOGIN=False
+SMTP_USER='user@gmail.com'
+SMTP_PASS='password'
+SMTP_SKIP_TLS=False
+
+
+# Webhooks
+#---------------------------
+REPORT_WEBHOOK=False
+WEBHOOK_URL='http://n8n.local:5555/webhook-test/aaaaaaaa-aaaa-aaaa-aaaaa-aaaaaaaaaaaa'
+WEBHOOK_PAYLOAD='json'                 # webhook payload data format for the "body > attachements > text" attribute 
+                                       # in https://github.com/jokob-sk/Pi.Alert/blob/main/docs/webhook_json_sample.json 
+                                       #   supported values: 'json', 'html' or 'text'
+                                       #   e.g.: for discord use 'html'
+WEBHOOK_REQUEST_METHOD='GET'
+
+
+# Apprise
+#---------------------------
+REPORT_APPRISE=False
+APPRISE_HOST='http://localhost:8000/notify'
+APPRISE_URL='mailto://smtp-relay.sendinblue.com:587?from=user@gmail.com&name=apprise&user=user@gmail.com&pass=password&to=user@gmail.com'
+
+
+# NTFY
+#---------------------------
+REPORT_NTFY=False
+NTFY_HOST='https://ntfy.sh'
+NTFY_TOPIC='replace_my_secure_topicname_91h889f28'
+NTFY_USER='user'
+NTFY_PASSWORD='passw0rd'
+
+
+# PUSHSAFER
+#---------------------------
+REPORT_PUSHSAFER=False
+PUSHSAFER_TOKEN='ApiKey'
+
+
+# MQTT
+#---------------------------
+REPORT_MQTT=False
+MQTT_BROKER='192.168.1.2'
+MQTT_PORT=1883
+MQTT_USER='mqtt'
+MQTT_PASSWORD='passw0rd'
+MQTT_QOS=0
+MQTT_DELAY_SEC=2
+
+
+# DynDNS
+#---------------------------
+DDNS_ACTIVE=False
+DDNS_DOMAIN='your_domain.freeddns.org'
+DDNS_USER='dynu_user'
+DDNS_PASSWORD='A0000000B0000000C0000000D0000000'
+DDNS_UPDATE_URL='https://api.dynu.com/nic/update?'
+
+
+# PiHole
+#---------------------------
+# if enabled you need to map '/etc/pihole/pihole-FTL.db' in docker-compose.yml
+PIHOLE_ACTIVE=False
+# if enabled you need to map '/etc/pihole/dhcp.leases' in docker-compose.yml
+DHCP_ACTIVE=False
+
+
+# Pholus
+#---------------------------
+PHOLUS_ACTIVE=False
+PHOLUS_TIMEOUT=120
+PHOLUS_FORCE=False
+PHOLUS_DAYS_DATA=7
+PHOLUS_RUN='once'
+PHOLUS_RUN_TIMEOUT=600
+PHOLUS_RUN_SCHD='0 4 * * *'
+
+
+#-------------------IMPORTANT INFO-------------------#
+#   This file is ingested by a python script, so if  #
+#        modified it needs to use python syntax      #
+#-------------------IMPORTANT INFO-------------------#

docker-compose.yml

@@ -0,0 +1,55 @@
+version: "3"
+services:
+  pialert:
+    privileged: true
+    build:
+      dockerfile: Dockerfile
+      context: .
+      cache_from:
+        - type=registry,ref=docker.io/jokob-sk/pi.alert:buildcache
+    container_name: pialert
+    network_mode: host
+    restart: unless-stopped
+    volumes:
+      # - ${APP_DATA_LOCATION}/pialert_dev/config:/home/pi/pialert/config
+      - ${APP_DATA_LOCATION}/pialert/config:/home/pi/pialert/config
+      # - ${APP_DATA_LOCATION}/pialert_dev/db:/home/pi/pialert/db      
+      - ${APP_DATA_LOCATION}/pialert/db:/home/pi/pialert/db           
+      # (optional) useful for debugging if you have issues setting up the container
+      - ${LOGS_LOCATION}:/home/pi/pialert/front/log      
+      # ---------------------------------------------------------------------------
+      # DELETE START anyone trying to use this file: comment out / delete BELOW lines, they are only for development purposes
+      - ${APP_DATA_LOCATION}/pialert/dhcp_samples/dhcp1.leases:/mnt/dhcp1.leases
+      - ${APP_DATA_LOCATION}/pialert/dhcp_samples/dhcp2.leases:/mnt/dhcp2.leases
+      # - ${DEV_LOCATION}/back/pialert.py:/home/pi/pialert/back/pialert.py
+      - ${DEV_LOCATION}/pialert:/home/pi/pialert/pialert      
+      # - ${DEV_LOCATION}/back/report_template.html:/home/pi/pialert/back/report_template.html
+      # - ${DEV_LOCATION}/back/report_template_new_version.html:/home/pi/pialert/back/report_template_new_version.html
+      # - ${DEV_LOCATION}/back/report_template.txt:/home/pi/pialert/back/report_template.txt
+      - ${DEV_LOCATION}/pholus:/home/pi/pialert/pholus
+      - ${DEV_LOCATION}/dockerfiles:/home/pi/pialert/dockerfiles
+      - ${APP_DATA_LOCATION}/pialert/php.ini:/etc/php/7.4/fpm/php.ini      
+      # - ${DEV_LOCATION}/front/api:/home/pi/pialert/front/api
+      - ${DEV_LOCATION}/front/css:/home/pi/pialert/front/css
+      - ${DEV_LOCATION}/front/lib/AdminLTE:/home/pi/pialert/front/lib/AdminLTE
+      - ${DEV_LOCATION}/front/js:/home/pi/pialert/front/js
+      - ${DEV_LOCATION}/front/php:/home/pi/pialert/front/php
+      - ${DEV_LOCATION}/front/deviceDetails.php:/home/pi/pialert/front/deviceDetails.php
+      - ${DEV_LOCATION}/front/devices.php:/home/pi/pialert/front/devices.php
+      - ${DEV_LOCATION}/front/events.php:/home/pi/pialert/front/events.php
+      - ${DEV_LOCATION}/front/plugins.php:/home/pi/pialert/front/plugins.php
+      - ${DEV_LOCATION}/front/pluginsCore.php:/home/pi/pialert/front/pluginsCore.php
+      - ${DEV_LOCATION}/front/help_faq.php:/home/pi/pialert/front/help_faq.php
+      - ${DEV_LOCATION}/front/index.php:/home/pi/pialert/front/index.php
+      - ${DEV_LOCATION}/front/maintenance.php:/home/pi/pialert/front/maintenance.php
+      - ${DEV_LOCATION}/front/network.php:/home/pi/pialert/front/network.php
+      - ${DEV_LOCATION}/front/presence.php:/home/pi/pialert/front/presence.php
+      - ${DEV_LOCATION}/front/settings.php:/home/pi/pialert/front/settings.php      
+      - ${DEV_LOCATION}/front/plugins:/home/pi/pialert/front/plugins      
+      # DELETE END anyone trying to use this file: comment out / delete ABOVE lines, they are only for development purposes
+      # ---------------------------------------------------------------------------
+    environment:
+      - TZ=${TZ}
+      - PORT=${PORT}
+      - HOST_USER_ID=${HOST_USER_ID}
+      - HOST_USER_GID=${HOST_USER_GID}

dockerfiles/README.md

@@ -0,0 +1,207 @@
+[![Docker](https://img.shields.io/github/actions/workflow/status/jokob-sk/Pi.Alert/docker_prod.yml?label=Build&logo=GitHub)](https://github.com/jokob-sk/Pi.Alert/actions/workflows/docker_prod.yml)
+[![GitHub Committed](https://img.shields.io/github/last-commit/jokob-sk/Pi.Alert?color=40ba12&label=Committed&logo=GitHub&logoColor=fff)](https://github.com/jokob-sk/Pi.Alert)
+[![Docker Size](https://img.shields.io/docker/image-size/jokobsk/pi.alert?label=Size&logo=Docker&color=0aa8d2&logoColor=fff)](https://hub.docker.com/r/jokobsk/pi.alert)
+[![Docker Pulls](https://img.shields.io/docker/pulls/jokobsk/pi.alert?label=Pulls&logo=docker&color=0aa8d2&logoColor=fff)](https://hub.docker.com/r/jokobsk/pi.alert)
+[![Docker Pushed](https://img.shields.io/badge/dynamic/json?color=0aa8d2&logoColor=fff&label=Pushed&query=last_updated&url=https%3A%2F%2Fhub.docker.com%2Fv2%2Frepositories%2Fjokobsk%2Fpi.alert%2F&logo=docker&link=http://left&link=https://hub.docker.com/repository/docker/jokobsk/pi.alert)](https://hub.docker.com/r/jokobsk/pi.alert)
+
+# 🐳 A docker image for Pi.Alert 
+
+🐳 [Docker hub](https://registry.hub.docker.com/r/jokobsk/pi.alert) | 📑 [Docker instructions](https://github.com/jokob-sk/Pi.Alert/blob/main/dockerfiles/README.md) | 🆕 [Release notes](https://github.com/jokob-sk/Pi.Alert/releases) | 📚 [All Docs](https://github.com/jokob-sk/Pi.Alert/tree/main/docs)
+
+<a href="https://raw.githubusercontent.com/jokob-sk/Pi.Alert/main/docs/img/devices_split.png" target="_blank">
+  <img src="https://raw.githubusercontent.com/jokob-sk/Pi.Alert/main/docs/img/devices_split.png" width="300px" />
+</a>
+<a href="https://raw.githubusercontent.com/jokob-sk/Pi.Alert/main/docs/img/network.png" target="_blank">
+  <img src="https://raw.githubusercontent.com/jokob-sk/Pi.Alert/main/docs/img/network.png" width="300px" />
+</a>
+
+
+## 📕 Basic Usage 
+
+- You will have to run the container on the host network, e.g: 
+
+```yaml
+docker run -d --rm --network=host \
+  -v local/path/pialert/config:/home/pi/pialert/config \
+  -v local/path/pialert/db:/home/pi/pialert/db \
+  -e TZ=Europe/Berlin \
+  -e PORT=20211 \
+  jokobsk/pi.alert:latest
+  ```
+- The initial scan can take up-to 15min (with 50 devices and MQTT). Subsequent ones 3 and 5 minutes so wait that long for all of the scans to run.
+
+### Docker environment variables
+
+| Variable | Description | Default |
+| :------------- |:-------------| -----:|
+| `PORT`      |Port of the web interface  |  `20211` |
+|`TZ` |Time zone to display stats correctly. Find your time zone [here](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)  |  `Europe/Berlin` |
+|`HOST_USER_GID`    |User ID (UID) to map the user in the container to a server user with sufficient read&write permissions on the mapped files   |  `1000` |
+|`HOST_USER_ID` |User Group ID (GID)  to map the user group in the container to a server user group with sufficient read&write permissions on the mapped files    |    `1000` |
+
+### Docker paths
+
+| | Path | Description |
+| :------------- | :------------- |:-------------| 
+| **Required** | `:/home/pi/pialert/config` | Folder which will contain the `pialert.conf` file (see below for details)  | 
+| **Required** | `:/home/pi/pialert/db` | Folder which will contain the `pialert.db` file  | 
+|Optional| `:/home/pi/pialert/front/log` |  Logs folder useful for debugging if you have issues setting up the container  | 
+|Optional| `:/etc/pihole/pihole-FTL.db` |  PiHole's `pihole-FTL.db` database file. Required if you want to use PiHole  | 
+|Optional| `:/etc/pihole/dhcp.leases` |  PiHole's `dhcp.leases` file. Required if you want to use PiHole  | 
+|Optional| `:/home/pi/pialert/front/api` |  A simple [API endpoint](https://github.com/jokob-sk/Pi.Alert/blob/main/docs/API.md) containing static (but regularly updated) json and other files.   | 
+
+
+### Config (`pialert.conf`)
+
+- If unavailable, the app generates a default `pialert.conf` and `pialert.db` file on the first run.
+- The preferred way is to manage the configuration via the Settings section in the UI.
+- You can modify [pialert.conf](https://github.com/jokob-sk/Pi.Alert/tree/main/config) directly, if needed.
+
+#### Important settings
+
+These are the most important settings to get at least some output in your Devices screen. Usually, only one approach is used, but you should be able to combine these approaches.
+
+##### For arp-scan: ENABLE_ARPSCAN, SCAN_SUBNETS
+
+- ❗ To use the arp-scan method, you need to set the `SCAN_SUBNETS` variable. See the documentation on how [to setup SUBNETS, VLANs & limitations](https://github.com/jokob-sk/Pi.Alert/blob/main/docs/SUBNETS.md) 
+
+##### For pihole: PIHOLE_ACTIVE, DHCP_ACTIVE
+
+* `PIHOLE_ACTIVE`: You need to map `:/etc/pihole/pihole-FTL.db in the docker-compose.yml` file if you enable this setting.
+* `DHCP_ACTIVE` : You need to map `:/etc/pihole/dhcp.leases in the docker-compose.yml` file if you enable this setting.
+
+### **Common issues** 
+
+💡 Before creating a new issue, please check if a similar issue was [already resolved](https://github.com/jokob-sk/Pi.Alert/issues?q=is%3Aissue+is%3Aclosed). 
+
+⚠ Check also common issues and [debugging tips](https://github.com/jokob-sk/Pi.Alert/blob/main/docs/DEBUG_TIPS.md). 
+
+## 📄 Examples
+
+### Example 1
+
+```yaml
+version: "3"
+services:
+  pialert:
+    container_name: pialert
+    image: "jokobsk/pi.alert:latest"      
+    network_mode: "host"        
+    restart: unless-stopped
+    volumes:
+      - local/path/pialert/config:/home/pi/pialert/config
+      - local/path/pialert/db:/home/pi/pialert/db      
+      # (optional) useful for debugging if you have issues setting up the container
+      - local/path/logs:/home/pi/pialert/front/log
+    environment:
+      - TZ=Europe/Berlin      
+      - HOST_USER_ID=1000
+      - HOST_USER_GID=1000
+      - PORT=20211
+```
+
+To run the container execute: `sudo docker-compose up -d`
+
+### Example 2
+
+Example by [SeimuS](https://github.com/SeimusS).
+
+```yaml
+  pialert:
+    container_name: PiAlert
+    hostname: PiAlert
+    privileged: true
+    image: jokobsk/pi.alert:latest
+    environment:
+      - TZ=Europe/Bratislava
+    restart: always
+    volumes:
+      - ./pialert/pialert_db:/home/pi/pialert/db
+      - ./pialert/pialert_config:/home/pi/pialert/config
+    network_mode: host
+```
+
+To run the container execute: `sudo docker-compose up -d`
+
+### Example 3
+
+`docker-compose.yml` 
+
+```yaml
+version: "3"
+services:
+  pialert:
+    container_name: pialert
+    image: "jokobsk/pi.alert:latest"      
+    network_mode: "host"        
+    restart: unless-stopped
+    volumes:
+      - ${APP_DATA_LOCATION}/pialert/config:/home/pi/pialert/config
+      - ${APP_DATA_LOCATION}/pialert/db/pialert.db:/home/pi/pialert/db/pialert.db      
+      # (optional) useful for debugging if you have issues setting up the container
+      - ${LOGS_LOCATION}:/home/pi/pialert/front/log
+    environment:
+      - TZ=${TZ}      
+      - HOST_USER_ID=${HOST_USER_ID}
+      - HOST_USER_GID=${HOST_USER_GID}
+      - PORT=${PORT}
+```
+
+`.env` file
+
+```yaml
+#GLOBAL PATH VARIABLES
+
+APP_DATA_LOCATION=/path/to/docker_appdata
+APP_CONFIG_LOCATION=/path/to/docker_config
+LOGS_LOCATION=/path/to/docker_logs
+
+#ENVIRONMENT VARIABLES
+
+TZ=Europe/Paris
+HOST_USER_ID=1000
+HOST_USER_GID=1000
+PORT=20211
+
+#DEVELOPMENT VARIABLES
+
+DEV_LOCATION=/path/to/local/source/code
+```
+
+To run the container execute: `sudo docker-compose --env-file /path/to/.env up`
+
+### Example 4
+
+Courtesy of [pbek](https://github.com/pbek). The volume `pialert_db` is used by the db directory. The two config files are mounted directly from a local folder to their places in the config folder. You can backup the `docker-compose.yaml` folder and the docker volumes folder.
+
+```yaml
+  pialert:
+    image: jokobsk/pi.alert
+    ports:
+      - "80:20211/tcp"
+    environment:
+      - TZ=Europe/Vienna
+    networks:
+      local:
+        ipv4_address: 192.168.1.2
+    restart: unless-stopped
+    volumes:
+      - pialert_db:/home/pi/pialert/db
+      - ./pialert/pialert.conf:/home/pi/pialert/config/pialert.conf      
+```
+
+## 🏅 Recognitions
+
+Big thanks to <a href="https://github.com/Macleykun">@Macleykun</a> for help and tips&tricks for Dockerfile(s):
+
+<a href="https://github.com/Macleykun">
+  <img src="https://avatars.githubusercontent.com/u/26381427?size=50"> 
+</a>
+
+## ☕ Support me
+
+<a href="https://github.com/sponsors/jokob-sk" target="_blank"><img src="https://i.imgur.com/X6p5ACK.png" alt="Sponsor Me on GitHub" style="height: 30px !important;width: 117px !important;" width="150px" ></a>
+<a href="https://www.buymeacoffee.com/jokobsk" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" style="height: 30px !important;width: 117px !important;" width="117px" height="30px" ></a>
+<a href="https://www.patreon.com/user?u=84385063" target="_blank"><img src="https://upload.wikimedia.org/wikipedia/commons/thumb/8/82/Patreon_logo_with_wordmark.svg/512px-Patreon_logo_with_wordmark.svg.png" alt="Support me on patreon" style="height: 30px !important;width: 117px !important;" width="117px" ></a>
+
+BTC: 1N8tupjeCK12qRVU2XrV17WvKK7LCawyZM

dockerfiles/start.sh

@@ -0,0 +1,33 @@
+#!/bin/sh
+/home/pi/pialert/dockerfiles/user-mapping.sh
+
+# # if custom variables not set we do not need to do anything
+# if [ -n "${TZ}" ]; then    
+#   FILECONF=/home/pi/pialert/config/pialert.conf 
+#   if [ -f "$FILECONF" ]; then
+#     sed -ie "s|Europe/Berlin|${TZ}|g" /home/pi/pialert/config/pialert.conf 
+#   else 
+#     sed -ie "s|Europe/Berlin|${TZ}|g" /home/pi/pialert/back/pialert.conf_bak 
+#   fi
+# fi
+
+if [ -n "${PORT}" ]; then  
+  sed -ie 's/listen 20211/listen '${PORT}'/g' /etc/nginx/sites-available/default
+fi 
+
+# I hope this will fix DB permission issues going forward
+FILEDB=/home/pi/pialert/db/pialert.db
+if [ -f "$FILEDB" ]; then
+    chown -R www-data:www-data /home/pi/pialert/db/pialert.db
+fi
+
+chmod -R a+rw /home/pi/pialert/front/log
+chmod -R a+rw /home/pi/pialert/config
+
+/etc/init.d/php7.4-fpm start
+/etc/init.d/nginx start
+
+# cron -f
+#python /home/pi/pialert/back/pialert.py
+# echo "[DEBUG] DATA MONKEY VERSION ..."
+python /home/pi/pialert/pialert/

dockerfiles/user-mapping.sh

@@ -0,0 +1,29 @@
+#!/bin/bash
+
+if [ -z "${USER}" ]; then
+  echo "We need USER to be set!"; exit 100
+fi
+
+# if both not set we do not need to do anything
+if [ -z "${HOST_USER_ID}" -a -z "${HOST_USER_GID}" ]; then
+    echo "Nothing to do here." ; exit 0
+fi
+
+# reset user_?id to either new id or if empty old (still one of above
+# might not be set)
+USER_ID=${HOST_USER_ID:=$USER_ID}
+USER_GID=${HOST_USER_GID:=$USER_GID}
+
+LINE=$(grep -F "${USER}" /etc/passwd)
+# replace all ':' with a space and create array
+array=( ${LINE//:/ } )
+
+# home is 5th element
+USER_HOME=${array[4]}
+
+sed -i -e "s/^${USER}:\([^:]*\):[0-9]*:[0-9]*/${USER}:\1:${USER_ID}:${USER_GID}/"  /etc/passwd
+sed -i -e "s/^${USER}:\([^:]*\):[0-9]*/${USER}:\1:${USER_GID}/"  /etc/group
+
+chown -R ${USER_ID}:${USER_GID} ${USER_HOME}
+
+exec su - "${USER}"

docs/API.md

@@ -0,0 +1,98 @@
+## API endpoints
+
+PiAlert comes with a simple API. These API endpoints are static files, that are periodically updated based on your settings. 
+
+
+### When are the endpoints updated
+
+Once you enable the API (`ENABLE_API` setting), the endpoints are updated when objects in the API endpoints are changed:
+
+### Location of the endpoints
+
+In the container, these files are located under the `/home/pi/pialert/front/api/` folder and thus on the `<pialert_url>/api/<File name>` url.
+
+### Available endpoints
+
+You can access the following files:
+
+  | File name | Description | 
+  |----------------------|----------------------| 
+  | `notification_text.txt` | The plain text version of the last notification. |
+  | `notification_text.html` | The full HTML of the last email notification. |
+  | `notification_json_final.json` | The json version of the last notification (e.g. used for webhooks - [sample JSON](https://github.com/jokob-sk/Pi.Alert/blob/main/back/webhook_json_sample.json)). |
+  | `table_devices.json` | The current (at the time of the last update as mentioned above on this page) state of all of the available Devices detected by the app. |
+  | `table_nmap_scan.json` | The current state of the discovered ports by the regular NMAP scans. |
+  | `table_pholus_scan.json` | The latest state of the [pholus](https://github.com/jokob-sk/Pi.Alert/tree/main/pholus) (A multicast DNS and DNS Service Discovery Security Assessment Tool) scan results. |
+  | `table_plugins_events.json` | The list of the unprocessed (pending) notification events (plugins_events DB table). |
+  | `table_plugins_history.json` | The list of notification events history. |  
+  | `table_plugins_objects.json` | The content of the plugins_objects table. Find more info on the [Plugin system here](https://github.com/jokob-sk/Pi.Alert/tree/main/front/plugins)|
+  | `language_strings.json` | The content of the language_strings table, which in turn is loaded from the plugins `config.json` definitions. |  
+  | `table_custom_endpoint.json` | A custom endpoint generated by the SQL query specified by the `API_CUSTOM_SQL` setting. |
+  | `table_settings.json` | The content of the settings table. |
+  
+  Current/latest state of the aforementioned files depends on your settings.
+
+### JSON Data format
+
+The endpoints starting with the `table_` prefix contain most, if not all, data contained in the corresponding database table. The common format for those is:
+
+```JSON
+{
+  "data": [
+        {
+          "db_column_name": "data",
+          "db_column_name2": "data2"      
+        }, 
+        {
+          "db_column_name": "data3",
+          "db_column_name2": "data4" 
+        }
+    ]
+}
+
+```
+
+Example JSON of the `table_devices.json` endpoint with two Devices (database rows):
+
+```JSON
+{
+  "data": [
+        {
+          "dev_MAC": "Internet",
+          "dev_Name": "Net - Huawei",
+          "dev_DeviceType": "Router",
+          "dev_Vendor": null,
+          "dev_Group": "Always on",
+          "dev_FirstConnection": "2021-01-01 00:00:00",
+          "dev_LastConnection": "2021-01-28 22:22:11",
+          "dev_LastIP": "192.168.1.24",
+          "dev_StaticIP": 0,
+          "dev_PresentLastScan": 1,
+          "dev_LastNotification": "2023-01-28 22:22:28.998715",
+          "dev_NewDevice": 0,
+          "dev_Network_Node_MAC_ADDR": "",
+          "dev_Network_Node_port": "",
+          "dev_Icon": "globe"
+        }, 
+        {
+          "dev_MAC": "a4:8f:ff:aa:ba:1f",
+          "dev_Name": "Net - USG",
+          "dev_DeviceType": "Firewall",
+          "dev_Vendor": "Ubiquiti Inc",
+          "dev_Group": "",
+          "dev_FirstConnection": "2021-02-12 22:05:00",
+          "dev_LastConnection": "2021-07-17 15:40:00",
+          "dev_LastIP": "192.168.1.1",
+          "dev_StaticIP": 1,
+          "dev_PresentLastScan": 1,
+          "dev_LastNotification": "2021-07-17 15:40:10.667717",
+          "dev_NewDevice": 0,
+          "dev_Network_Node_MAC_ADDR": "Internet",
+          "dev_Network_Node_port": 1,
+          "dev_Icon": "shield-halved"
+      }
+    ]
+}
+
+```
+

docs/DATABASE.md

@@ -0,0 +1,47 @@
+  
+  # A high-level description of the datbase structure
+
+  ⚠ Disclaimer: As I'm not the original author, some of the information might be inaccurate. Feel free to submit a PR to correct anything within this page or documentation in general. 
+
+  The MAC address is used as a foreign key in most cases. 
+
+  ## 🔍Tables overview
+  
+  | Table name | Description  | Sample data |
+  |----------------------|----------------------| ----------------------| 
+  | CurrentScan | Result of the current scan | ![Screen1][screen1]  |  
+  | Devices     | The main devices database that also contains the Network tree mappings. If `ScanCycle` is set to `0` device is not scanned. | ![Screen2][screen2]  | 
+  | DHCP_Leases | Used for importing devices from DHCP_Leases files. Also leveraged by some plugins. | ![Screen3][screen3]  | 
+  | Events | Used to collect connection/disconnection events. | ![Screen4][screen4]  | 
+  | Nmap_Scan | Contains results of the scheduled Nmap scan, that is also displayed in the Nmap tab on each device. | ![Screen5][screen5]  | 
+  | Online_History   | Used to display the `Device presence over time` chart  | ![Screen6][screen6]  | 
+  | Parameters       | Used to pass values between the frontend and backend. | ![Screen7][screen7]  | 
+  | Pholus_Scan      | Scan results of the Pholus python network penetration script. | ![Screen8][screen8]  | 
+  | PiHole_Network   | Table to copy the devices from the PiHole database | ![Screen9][screen9]  | 
+  | Plugins_Events   | For capturing events exposed by a plugin via the `last_result.log` file. If unique then saved into the `Plugins_Objects` table. Entries are deleted once processed and stored in the `Plugins_History` and/or `Plugins_Objects` tables.  | ![Screen10][screen10]  | 
+  | Plugins_History  | History of all entries from the `Plugins_Events` table | ![Screen11][screen11]  | 
+  | Plugins_Language_Strings  | Language strings colelcted from the plugin `config.json` files used for string resolution in the frontend. | ![Screen12][screen12]  | 
+  | Plugins_Objects  | Unique objects detected by individual plugins. | ![Screen13][screen13]  | 
+  | ScanCycles  | (obsolete) Used to determine and identify different scan cycles. | ![Screen14][screen14]  | 
+  | Sessions  | Used to display sessions in the charts | ![Screen15][screen15]  | 
+  | Settings  | Database representation of the sum of all settings from `pialert.conf` and plugins coming from `config.json` files. | ![Screen16][screen16]  | 
+
+
+
+  [screen1]: /docs/img/DATABASE/CurrentScan.png
+  [screen2]: /docs/img/DATABASE/Devices.png
+  [screen3]: /docs/img/DATABASE/DHCP_Leases.png
+  [screen4]: /docs/img/DATABASE/Events.png
+  [screen5]: /docs/img/DATABASE/Nmap_Scan.png
+  [screen6]: /docs/img/DATABASE/Online_History.png
+  [screen7]: /docs/img/DATABASE/Parameters.png
+  [screen8]: /docs/img/DATABASE/Pholus_Scan.png
+  [screen9]: /docs/img/DATABASE/PiHole_Network.png
+  [screen10]: /docs/img/DATABASE/Plugins_Events.png
+  [screen11]: /docs/img/DATABASE/Plugins_History.png
+  [screen12]: /docs/img/DATABASE/Plugins_Language_Strings.png
+  [screen13]: /docs/img/DATABASE/Plugins_Objects.png
+  [screen14]: /docs/img/DATABASE/ScanCycles.png
+  [screen15]: /docs/img/DATABASE/Sessions.png
+  [screen16]: /docs/img/DATABASE/Settings.png
+

docs/DEBUG_INVALID_JSON.md

@@ -0,0 +1,31 @@
+# How to debug the Invalid JSON response error
+
+Check the the HTTP response of the failing backend call by following these steps:
+
+- Open developer console in your browser (usually, e. g. for Chrome, key F12 on the keyboard).
+- Follow the steps in this screenshot: 
+
+![F12DeveloperConsole][F12DeveloperConsole]
+
+- Copy the URL causing the error and enter it in the address bar of your browser directly and hit enter. The copied URLs could look something like this (notice the query strings at the end):
+  - `http://<pialert URL>:20211/php/server/devices.php?action=getDevicesTotals`
+  - `http://<pialert URL>:20211/php/server/devices.php?action=getDevicesList&status=all`
+
+- Post the error response in the existing issue thread on GitHub or create a new issue and include the redacted response of the failing query.
+
+For reference, the above queries should return results in the following format:
+
+First URL:
+
+![array][array]
+
+Second URL:
+
+![json][json]
+
+You can copy and paste any JSON result (result of the second query) into an online JSON checker, such as [this one](https://jsonchecker.com/) to check if it's valid.
+
+
+[F12DeveloperConsole]:    ./img/DEBUG/Invalid_JSON_repsonse_debug.png           "F12DeveloperConsole"
+[array]:                  ./img/DEBUG/array_result_example.png                  "array"
+[json]:                   ./img/DEBUG/JSON_result_example.png                   "json"

docs/DEBUG_TIPS.md

@@ -0,0 +1,84 @@
+# Debugging and troubleshooting
+
+Please follow tips 1 - 4 to get a more detailed error. 
+
+## 1. More Logging 📃
+
+When debugging an issue always set the highest log level:
+
+`LOG_LEVEL='debug'`
+
+
+## 2. Surfacing errors when container restarts 🔁
+
+Start the container via the **terminal** with a command similar to this one:
+
+```bash
+docker run --rm --network=host \
+  -v local/path/pialert/config:/home/pi/pialert/config \
+  -v local/path/pialert/db:/home/pi/pialert/db \
+  -e TZ=Europe/Berlin \
+  -e PORT=20211 \
+  jokobsk/pi.alert:latest
+
+```
+
+> ⚠ Please note, don't use the `-d` parameter so you see the error when the container crashes. Use this error in your issue description.
+
+## 3. Check the _dev image and open issues ❓
+
+If possible, check if your issue got fixed in the `_dev` image before opening a new issue. The container is:
+
+`jokobsk/pi.alert_dev:latest`
+
+> ⚠ Please backup your DB and config beforehand!
+
+Please also search [open issues](https://github.com/jokob-sk/Pi.Alert/issues).
+
+## 4. Disable restart behavior 🛑
+
+To prevent a Docker container from automatically restarting in a Docker Compose file, specify the restart policy as `no`:
+
+```yaml
+version: '3'
+
+services:
+  your-service:
+    image: your-image:tag
+    restart: no
+    # Other service configurations...
+```
+
+## 📃Common issues
+
+### Permissions
+
+* If facing issues (AJAX errors, can't write to DB, empty screen, etc,) make sure permissions are set correctly, and check the logs under `/home/pi/pialert/front/log`. 
+* To solve permission issues you can try setting the owner and group of the `pialert.db` by executing the following on the host system: `docker exec pialert chown -R www-data:www-data /home/pi/pialert/db/pialert.db`. 
+* Map to local User and Group IDs. Specify the enviroment variables `HOST_USER_ID` and `HOST_USER_GID` if needed.
+* If still facing issues, try to map the pialert.db file (⚠ not folder) to `:/home/pi/pialert/db/pialert.db` (see Examples below for details)
+
+### Container restarts / crashes
+
+* Check the logs for details. Often a required setting for a notification method is missing. 
+
+### unable to resolve host
+
+* Check that your `SCAN_SUBNETS` variable is using the correct mask and `--interface` as outlined in the instructions above. 
+
+### Invalid JSON
+
+Check the [Invalid JSON errors debug help](/docs/DEBUG_INVALID_JSON.md) docs on how to proceed.
+
+### sudo execution failing (e.g.: on arpscan) on a Raspberry Pi 4 
+
+> sudo: unexpected child termination condition: 0
+
+Resolution based on [this issue](https://github.com/linuxserver/docker-papermerge/issues/4#issuecomment-1003657581)
+
+```
+wget ftp.us.debian.org/debian/pool/main/libs/libseccomp/libseccomp2_2.5.3-2_armhf.deb
+sudo dpkg -i libseccomp2_2.5.3-2_armhf.deb
+```
+
+The link above will probably break in time too. Go to https://packages.debian.org/sid/armhf/libseccomp2/download to find the new version number and put that in the url.

docs/DEVICE_MANAGEMENT.md

@@ -18,7 +18,7 @@ To edit device information:
   - **Owner**: Device owner (The list is self-populated with existing owners)
   - **Type**: Select a device type from the dropdown list (Smartphone, Table,
       Laptop, TV, router, ....) or type a new device type
-  - **Vendor**: Automatically updated by Pi.Alert
+  - **Vendor**: Automatically updated by Pi.Alert when empty or unknown
   - **Favorite**: Mark the device as favorite and then it will appears at the
       begining of the device list
   - **Group**: Select a grouper ('Always on', 'Personal', Friends') or type
@@ -79,11 +79,19 @@ decides to change the MAC).
   
 ### License
   GPL 3.0
-  [Read more here](LICENSE.txt)
+  [Read more here](../LICENSE.txt)
 
-### Contact
-  pi.alert.application@gmail.com
+### Contact 
+
+  Always use the Issue tracker for the correct fork, for example: 
   
+  [jokob-sk/Pi.Alert](https://github.com/jokob-sk/Pi.Alert/issues). Please also follow the guidelines on:
+
+  - ➕ [Pull Request guidelines](https://github.com/jokob-sk/Pi.Alert/tree/main/docs#-pull-requests-prs) 
+  - 🙏 [Feature request guidelines](https://github.com/jokob-sk/Pi.Alert/tree/main/docs#-feature-requests) 
+  - 🐛 [Issue guidelines](https://github.com/jokob-sk/Pi.Alert/tree/main/docs#-submitting-an-issue-or-bug)
+
+    
   ***Suggestions and comments are welcome***
 
 

docs/HOME_ASSISTANT.md

@@ -0,0 +1,42 @@
+# Overview
+
+PiAlert comes with MQTT support, allowing you to show all detected devices as devices in Home Assistant. It also supplies a collection of stats, such as number of online devices.
+
+## ⚠ Note 
+
+- Please note that discovery takes about ~10s per device.
+- Deleting of devices is not handled automatically. Please use [MQTT Explorer](https://mqtt-explorer.com/) to delete devices in the broker (Home Assistant), if needed. 
+
+
+## 🧭 Guide
+
+> 💡 This guide was tested only with the Mosquitto MQTT broker
+
+1. Enable Mosquitto MQTT in Home Assistant by following the [documentation](https://www.home-assistant.io/integrations/mqtt/)
+
+2. Configure a user name and password on your broker.
+
+3. Note down the following details that you will need to configure PiAlert:
+   - MQTT host url (usually your Home Assistant IP)
+   - MQTT broker port
+   - User
+   - Password
+
+4. Ope the `PiAlert` > `Settings` > `MQTT` settings group
+   - Enable MQTT
+   - Fill in the details from above
+   - Fill in remaining settings as per description
+
+
+## 📷 Screenshots
+
+  | ![Screen 1][sensors] | ![Screen 2][history] | 
+  |----------------------|----------------------| 
+  | ![Screen 3][list] | ![Screen 4][overview] | 
+  
+
+  [sensors]:  /docs/img/HOME_ASISSTANT/PiAlert-HomeAssistant-Device-as-Sensors.png       "sensors"
+  [history]:  /docs/img/HOME_ASISSTANT/PiAlert-HomeAssistant-Device-Presence-History.png "history"
+  [list]:     /docs/img/HOME_ASISSTANT/PiAlert-HomeAssistant-Devices-List.png            "list"  
+  [overview]: /docs/img/HOME_ASISSTANT/PiAlert-HomeAssistant-Overview-Card.png           "overview"
+

docs/ICONS.md

@@ -0,0 +1,30 @@
+## Icons overview
+
+Icons are used to visually distinguish devices in the app in most of the device listing tables and the [network tree](/docs/NETWORK_TREE.md). Currently only free [Font Awesome](https://fontawesome.com/search?o=r&m=free) icons (up-to v 6.4.0) are supported (I have an unblockable [sponsorship goal](https://github.com/sponsors/jokob-sk) to add the material design icon pack).  
+
+![Raspberry Pi with a brand icon](/docs/img/ICONS/devices-icons.png)
+
+## ⚙ How to use custom device Icons
+
+You can assign icons individually on each device in the Details tab.
+
+![Raspberry Pi device details](/docs/img/ICONS/device-icon.png)
+
+- You can click into the `Icon` field or click the Pencil (2) icon in the above screenshot to enter any text. Only [free Font Awesome](https://fontawesome.com/search?o=r&m=free) icons in the following format will work:
+
+  1. For any value that is only prefixed with `fa-`, you can enter the value directly, such as `server`, `tv`, `ethernet`. 
+  2. If you want to add another classname, e.g. `fa-brands`, you can enter `brands fa-[fontawesome-icon-name]`, so for `apple` that is using the syntax`fa-brands fa-apple`, you would enter `brands fa-apple`.
+
+- If you want to mass-apply an icon to all devices of the same device type (Field marked (4) in the above screenshot), you can click the copy button (Marked (1) in the above screenshot). A confirmation prompt is displayed. If you proceed, icons of all devices set to the same device type as the current device, will be overwritten with the current device's icon.
+
+- The dropdown (3) contains all icons already used in the app for device icons. You need to navigate away or refresh the page once you add a new icon. 
+
+## 🌟 Pro Font Awesome icons
+
+If you own the premium package of Font Awesome icons you can mount it in your Docker container the following way:
+
+```yaml
+/font-awesome:/home/pi/pialert/front/lib/AdminLTE/bower_components/font-awesome:ro
+```
+
+You can use the full range of Font Awesome icons afterwards. 

docs/INSTALL.md

@@ -1,215 +0,0 @@
-# Pi.Alert Installation
-<!--- --------------------------------------------------------------------- --->
-Initially designed to run on a Raspberry PI, probably it can run on many other
-Linux distributions.
-
-Estimated time: 20'
-
-### Dependencies
-  | Dependency | Comments                                                 |
-  | ---------- | -------------------------------------------------------- |
-  | Lighttpd   | Probably works on other webservers / not tested          |
-  | arp-scan   | Required for Scan Method 1                               |
-  | Pi.hole    | Optional. Scan Method 2. Check devices doing DNS queries |
-  | dnsmasq    | Optional. Scan Method 3. Check devices using DHCP server |
-  | IEEE HW DB | Necessary to identified Device vendor                    |
-
-# Installation process
-<!--- --------------------------------------------------------------------- --->
-
-## Raspberry Setup
-<!--- --------------------------------------------------------------------- --->
-1 - Install 'Raspberry Pi OS'
-  - Instructions https://www.raspberrypi.org/documentation/installation/installing-images/
-  - *Lite version (without Descktop) is enough for Pi.Alert*
-
-2 - Activate ssh
-  - Create a empty file with name 'ssh' in the boot partition of the SD
-
-3 - Start the raspberry
-
-4 - Login to the system with pi user
-```
-  user: pi
-  password: raspberry
-```
-
-5 - Change the default password of pi user
-```
-  passwd
-```
-
-6 - Setup the basic configuration
-```
-  sudo raspi-config
-```
-
-7 - Optionally, configure a static IP in raspi-config
-
-8 - Update the OS
-```
-  sudo apt-get update
-  sudo apt-get upgrade
-  sudo reboot
-```
-
-## Pi-hole Setup
-<!--- --------------------------------------------------------------------- --->
-1- Links & Doc
-  - https://pi-hole.net/
-  - https://github.com/pi-hole/pi-hole
-  - https://github.com/pi-hole/pi-hole/#one-step-automated-install
-
-2 - Login to the system with pi user
-
-3 - Install Pi-hole
-```
-    curl -sSL https://install.pi-hole.net | bash
-```
-  - Mark "Install web admin interface"
-  - Mark "Install web server lighttpd"
-
-4 - Configure Pi-hole admin password
-```
-    pihole -a -p PASSWORD
-```
-
-5 - Connect to web admin panel
-  - http://192.168.1.x/admin/
-  - (*replace 192.168.1.x with your Raspberry IP*)
-
-6 - Activate DHCP server
-  - Pi-hole -> Settings -> DHCP -> Mark "DHCP server enabled"
-
-7 - Add pi.alert DNS Record
-  - Pi-hole -> Local DNS -> DNS Records -> Add new domain /IP
-    - pi.alert    192.168.1.x
-    - (*replace 192.168.1.x with your Raspberry IP*)
-
-8 - Deactivate your current DHCP Server (*Normaly at your router or AP*)
-
-9 - Renew your computer IP to unsure you are using the new DHCP and DNS server
-  - Windows: cmd -> ipconfig /renew
-  - Linux: shell -> sudo dhclient -r; sudo dhclient
-  - Mac: Apple menu -> System Preferences -> Network -> Select the network ->
-    Advanced -> TCP/IP -> Renew DHCP Lease
-
-## arp-scan & Python
-<!--- --------------------------------------------------------------------- --->
-1 - Install arp-scan utility and test
-```
-  sudo apt-get install arp-scan
-  sudo arp-scan -l
-```
-
-2 - Install Python & packages
-```
-  sudo apt-get install python-setuptools
-  sudo apt install python-pip
-
-  pip install netaddr
-  pip install dpkt
-  pip install MacLookup
-```
-
-
-## Pi.Alert
-<!--- --------------------------------------------------------------------- --->
-1- Download Pi.Alert and uncompress
-```
-  curl -LO https://github.com/pucherot/Pi.Alert/raw/main/install/pialert_latest.tar
-  tar xvf pialert_latest.tar
-  rm pialert_latest.tar
-```
-
-2 - Public the front portal
-```
-  sudo ln -s /home/pi/pialert/front /var/www/html/pialert
-```
-
-3 - Update lighttpd config
-```
-  sudo sh -c "printf '\n\n\$HTTP[\"host\"] == \"pi.alert\" {\n  server.document-root = \"/var/www/html/pialert/\"\n}\n' >> /etc/lighttpd/external.conf"
-  sudo /etc/init.d/lighttpd restart
-```
-
-4 - If you want to use email reporting with gmail
-  - Go to your Google Account https://myaccount.google.com/
-  - On the left navigation panel, click Security
-  - On the bottom of the page, in the Less secure app access panel,
-    click Turn on access
-  - Click Save button
-
-5 - Config Pialert parameters
-```
-  nano  ~/pialert/back/pialert.conf
-```
-  - If you want to use email reporting, configure this parameters
-```
-  REPORT_MAIL     = True
-  SMTP_USER       = 'user@gmail.com'
-  SMTP_PASS       = 'password'
-  REPORT_TO       = 'user@gmail.com'
-```
-
-  - If you want to update your Dynamic DNS, configure this parameters
-```
-  DDNS_ACTIVE     = True
-  DDNS_DOMAIN     = 'your_domain.freeddns.org'
-  DDNS_USER       = 'dynu_user'
-  DDNS_PASSWORD   = 'A0000000B0000000C0000000D0000000'
-  DDNS_UPDATE_URL = 'https://api.dynu.com/nic/update?'
-```
-
-  - If you have installed Pi.hole and DHCP, activate this parameters
-```
-  PIHOLE_ACTIVE   = True
-  DHCP_ACTIVE     = True
-```
-
-6 - Update vendors DB
-```
-  python ~/pialert/back/pialert.py update_vendors
-```
-
-7 - Test Pi.Alert Scan
-```
-  python ~/pialert/back/pialert.py internet_IP
-  python ~/pialert/back/pialert.py 1
-```
-
-8 - Add crontab jobs
-```
-  (crontab -l 2>/dev/null; cat ~/pialert/back/pialert.cron) | crontab -
-```
-
-9 - Add permissions to the web-server user
-```
-  sudo chgrp -R www-data ~/pialert/back ~/pialert/back/pialert.conf ~/pialert/front ~/pialert/db
-  chmod -R 770 ~/pialert/back ~/pialert/back/pialert.conf ~/pialert/front ~/pialert/db
-```
-
-10 - Check DNS record por pi.alert (explained in point 7 of Pi.hole installing)
-   - Add pi.alert DNS Record
-     - Pi-hole -> Local DNS -> DNS Records -> Add new domain /IP
-       - pi.alert    192.168.1.x
-       - (*replace 192.168.1.x with your Raspberry IP*)
-
-11 - Use admin panel to configure the devices
-   - http://pi.alert/
-   - http://192.168.1.x/pialert/
-     - (*replace 192.168.1.x with your Raspberry IP*)
-
-
-## Device Management
-<!--- --------------------------------------------------------------------- --->
-
-  - [Device Management instructions](./DEVICE_MANAGEMENT.md)
-
-
-### License
-  GPL 3.0
-  [Read more here](LICENSE.txt)
-
-### Contact
-  pi.alert.application@gmail.com

docs/NETWORK_TREE.md

@@ -0,0 +1,54 @@
+## How to setup your Network page
+
+Make sure you have a root device with the MAC `Internet` (No other MAC addresses are currently supported as the root node).
+
+## ⚡Quick setup:
+
+* Go to Devices > Device Details. 
+* Find the device(s) you want to use as network devices (network nodes). 
+* Set the Type of such a device to one of the following: AP, Firewall, Gateway, PLC, Powerline, Router, Switch, USB LAN Adapter, USB WIFI Adapter and WLAN.
+* Save and go to Network where the devices you've marked as network devices (by selecting the Type as mentioned above) will show up as tabs.
+* You can now assign the Unassigend devices to the correct network node.
+
+
+## 🔍Detailed example:
+
+In this example you will setup a device named `rapberrypi` as a `Switch` in our network. 
+
+### 1) Device details page
+
+- Go to the `Devices` (1) page:
+
+![Device details](/docs/img/NETWORK_TREE/Device_Details_Network_Type.png)
+
+- In the (2) `Details` tab navigate to the the `Type` (3) dropdown and select the type `Switch` (4).
+
+> Note: Only the following device types will show up as selectable Network nodes ( = devices you can connect other devices to):
+> AP, Firewall, Gateway, Hypervisor, PLC, Powerline, Router, Switch, USB LAN Adapter, USB WIFI Adapter and WLAN.
+
+- Assign a device to your root device from the `Node` (5) dropdown which has the MAC `Internet` (6) (Your name may differ, but the MAC needs to be set to `Internet` - this is done by default). 
+
+- Save your changes (7)
+
+### 1) Network page
+
+- Navigate to your `Network` (1) page:
+
+![Network page](/docs/img/NETWORK_TREE/Network_Page.png)
+
+- Notice the newly added `raspberrypi` (2) tab which now represents a network node, also showing up in the tree (3).
+- As we asssigned the `raspberrypi` in the previous 1) Device details page section to the `Internet` parent network node in step (6), the link is also showing up in the tree diagram (4)
+- We can now assign the device `(AppleTV)` (5) to this `raspberrypi` node, representing a network Switch in this example
+
+### 1) Network page with 2 levels
+
+- After clicking the `Assign` button in the previous section, the `(AppleTV)` (1) device is now connected to our `raspberrypi` (2).
+
+![Network page with 2 levels](/docs/img/NETWORK_TREE/Network_Page_2_Levels.png)
+
+- You can see the `raspberrypi` represents the Network node type `Switch` (3)
+- The `(AppleTV)` to `raspberrypi` connection is also displayed in the table of `Connected devices` (4).
+- You can also see that our `raspberrypi` node is connected to it's Parent network device node with the MAC `Internet` (5). This connection again shows up in the tree (6) as well.
+
+
+

docs/RANDOM_MAC.md

@@ -4,7 +4,7 @@
 The latest versions of some operating systems (IOS and Android) incorporate a
 new & interesting functionality to improve privacy: **Random MACs**.
 
-This functionality allows you to **hide the true MAC** of the device and
+This functionality allows you to **hide the real MAC** of the device and
 **assign a random MAC** when we connect to WIFI networks.
 
 This behavior is especially useful when connecting to WIFI's that we do not
@@ -16,12 +16,12 @@ WIFI's**, in this way, Pi.Alert will be able to identify the device, and it
 will not identify it as a new device every so often (every time IOS or Android
 decides to change the MAC).
 
-### IOS
+## IOS
 ![ios][ios]
 
   - [Use private Wi-Fi addresses in iOS 14](https://support.apple.com/en-us/HT211227)
 
-### Android
+## Android
 ![Android][Android]
 
   - [How to Disable MAC Randomization in Android 10](https://support.boingo.com/s/article/How-to-Disable-MAC-Randomization-in-Android-10-Android-Q)
@@ -30,10 +30,17 @@ decides to change the MAC).
 
 ### License
   GPL 3.0
-  [Read more here](LICENSE.txt)
+  [Read more here](../LICENSE.txt)
 
 ### Contact
-  pi.alert.application@gmail.com
+  Always use the Issue tracker for the correct fork, for example: 
+  
+  [jokob-sk/Pi.Alert](https://github.com/jokob-sk/Pi.Alert/issues). Please also follow the guidelines on:
+
+  - ➕ [Pull Request guidelines](https://github.com/jokob-sk/Pi.Alert/tree/main/docs#-pull-requests-prs) 
+  - 🙏 [Feature request guidelines](https://github.com/jokob-sk/Pi.Alert/tree/main/docs#-feature-requests) 
+  - 🐛 [Issue guidelines](https://github.com/jokob-sk/Pi.Alert/tree/main/docs#-submitting-an-issue-or-bug)
+
   
   ***Suggestions and comments are welcome***
 

docs/README.md

@@ -0,0 +1,109 @@
+## Documentation overview
+
+In the app hover over settings or fields/labels or click blue in-app ❔ (question-mark) icons to get to relevant documentation pages.
+
+![In-app help](/docs/img/GENERAL/in-app-help.png)
+
+There is also an in-app Help / FAQ section that should be answering frequently asked questions.
+
+### 📥 Installation
+
+ ⚠ Only tested as a [docker container - follow these instructions here](https://github.com/jokob-sk/Pi.Alert/blob/main/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 or original instructions for [pucherot's original code](https://github.com/pucherot/Pi.Alert/)
+
+
+### 📚 Table of contents
+
+#### 🐛 Debugging help & tips
+
+- [Debugging tips](/docs/DEBUG_TIPS.md)
+- [Invalid JSON errors debug help](/docs/DEBUG_INVALID_JSON.md)
+
+#### 🔝 Popular/Suggested
+
+- [API endpoints details](/docs/API.md)
+- [Plugin system details and how to develop your own](/front/plugins/README.md)
+- [Network treemap configuration](/docs/NETWORK_TREE.md)
+- [Gmail as SMTP server for sending emails](/docs/SMTP_GMAIL.md)
+- [Subnets and VLANs configuration for arp-scan](/docs/SUBNETS.md)
+- [Home Assistant](/docs/HOME_ASSISTANT.md)
+
+#### ⚙ System Management
+
+- [Manage devices (legacy docs)](/docs/DEVICE_MANAGEMENT.md)
+- [Random MAC/MAC icon meaning (legacy docs)](/docs/RANDOM_MAC.md)
+- [Custom Icons configuration and support](/docs/ICONS.md)
+
+#### 🔎 Examples
+
+- [N8N webhook example](/docs/WEBHOOK_N8N.md)
+
+#### ♻ Misc
+
+- [New Version notifications](/docs/VERSIONS.md)
+- [Version history (legacy)](/docs/VERSIONS_HISTORY.md)
+- [Database structure](/docs/DATABASE.md)
+- [Reverse proxy with SWAG](/docs/REVERSE_PROXY.md)
+
+Feel free to suggest or submit new docs via a PR. 
+
+## 👨‍💻 Development priorities
+
+Priorities from highest to lowest:
+
+* 🔼 Fixing core functionality bugs not solvable with workarounds
+* 🔵 New core functionality unlocking other opportunities (e.g.: plugins) 
+* 🔵 Refactoring enabling faster implementation of future functionality 
+* 🔽 (low) UI functionality & improvements (PRs welcome 😉)
+
+Design philosophy: Focus on core functionality and leverage existing apps and tools to make PiAlert integrate into other workflows. 
+
+Examples: 
+
+    1. Supporting apprise makes more sense than implementing multiple individual notification gateways
+    2. Implementing regular expression support across settings for validation makes more sense than validating one setting with a specific expression. 
+
+UI-specific requests are a low priority as the framework picked by the original developer is not very extensible (and afaik doesn't support components) and has limited mobile support. Also, I argue the value proposition is smaller than working on something else.
+
+Feel free to submit PRs if interested. try to **keep the PRs small/on-topic** so they are easier to review and approve. 
+
+That being said, I'd reconsider if more people and or recurring sponsors file a request 😉.
+
+## 🙏 Feature requests
+
+Please be as detailed as possible with **workarounds** you considered and why a native feature is the better way. This gives me better context and will make it more likely to be implemented. Ideally, a feature request should be in the format "I want to be able to do XYZ so that ZYX. I considered these approaches XYZ".
+
+## ➕ Pull requests (PRs)
+
+If you submit a PR please:
+
+1. Check that your changes are backward compatible with existing installations and with a blank setup. 
+2. Existing features should always be preserved. 
+3. Keep the PR small, on-topic and don't change code that is not necessary for the PR to work
+4. New features code should ideally be re-usable for different purposes, not be for a very narrow use-case.
+5. New functionality should ideally be implemented via the Plugins system, if possible.
+
+Suggested test cases:
+
+- Blank setup with no DB or config
+- Existing DB / config
+- Sending a notification (e. g. Delete a device and wait for a scan to run) and testing all notification gateways, especially:
+-   Email, Apprise (e.g. via Telegram), webhook (e.g. via Discord), MQTT (e.g. via HomeAssitant)
+- Saving settings
+- Test a couple of plugins
+- Check the Error log for anything unusual
+
+Some additional context:
+
+* Permanent settings/config is stored in the `pialert.conf` file
+* Currently temporary (session?) settings are stored in the `Parameters` DB table as key-value pairs. This table is wiped during a container rebuild/restart and its values are re-initialized from cookies/session data from the browser. 
+
+## 🐛 Submitting an issue or bug
+
+Before submitting a new issue please spend a couple of minutes on research:
+
+* Check [🛑 Common issues](https://github.com/jokob-sk/Pi.Alert/tree/main/dockerfiles#-common-issues) 
+* Check [💡 Closed issues](https://github.com/jokob-sk/Pi.Alert/issues?q=is%3Aissue+is%3Aclosed) if a similar issue was solved in the past.
+* When submitting an issue ❗[enable debug](https://github.com/jokob-sk/Pi.Alert/blob/main/docs/DEBUG_TIPS.md)❗
+
+⚠ Please follow the pre-defined issue template to resolve your issue faster.

docs/REVERSE_PROXY.md

@@ -0,0 +1,65 @@
+# Reverse Proxy Configuration
+
+Reverse proxy example by using LinuxServer's SWAG container.
+
+> Submitted by [s33d1ing](https://github.com/s33d1ing). 🙏
+
+## [linuxserver/swag](https://github.com/linuxserver/docker-swag)
+
+In the SWAG container create `/config/nginx/proxy-confs/pialert.subfolder.conf` with the following contents:
+
+``` nginx
+## Version 2023/02/05
+# make sure that your pialert container is named pialert
+# pialert does not require a base url setting
+
+# Since Pi.Alert uses a Host network, you may need to use the IP address of the system running Pi.Alert for $upstream_app.
+
+location /pialert {
+    return 301 $scheme://$host/pialert/;
+}
+
+location ^~ /pialert/ {
+    # enable the next two lines for http auth
+    #auth_basic "Restricted";
+    #auth_basic_user_file /config/nginx/.htpasswd;
+
+    # enable for ldap auth (requires ldap-server.conf in the server block)
+    #include /config/nginx/ldap-location.conf;
+
+    # enable for Authelia (requires authelia-server.conf in the server block)
+    #include /config/nginx/authelia-location.conf;
+
+    # enable for Authentik (requires authentik-server.conf in the server block)
+    #include /config/nginx/authentik-location.conf;
+
+    include /config/nginx/proxy.conf;
+    include /config/nginx/resolver.conf;
+
+    set $upstream_app pialert;
+    set $upstream_port 20211;
+    set $upstream_proto http;
+
+    proxy_pass $upstream_proto://$upstream_app:$upstream_port;
+    proxy_set_header Accept-Encoding "";
+
+    proxy_redirect ~^/(.*)$ /pialert/$1;
+    rewrite ^/pialert/?(.*)$ /$1 break;
+
+    sub_filter_once off;
+    sub_filter_types *;
+
+    sub_filter 'href="/' 'href="/pialert/';
+
+    sub_filter '(?>$host)/css' '/pialert/css';
+    sub_filter '(?>$host)/js'  '/pialert/js';
+
+    sub_filter '/img' '/pialert/img';
+    sub_filter '/lib' '/pialert/lib';
+    sub_filter '/php' '/pialert/php';
+}
+```
+
+
+
+

docs/SMTP_GMAIL.md

@@ -0,0 +1,15 @@
+## Use the Gmail SMTP server
+    
+1) Create an app password by following the instructions from Google, you need to Enable 2FA for this to work.
+[https://support.google.com/accounts/answer/185833](https://support.google.com/accounts/answer/185833)
+
+2) Specify the following settings:
+
+```python
+    SMTP_SKIP_TLS=True
+    SMTP_FORCE_SSL=True 
+    SMTP_PORT=465
+    SMTP_SERVER='smtp.gmail.com'
+    SMTP_PASS='16-digit passcode from google'
+```
+

docs/SUBNETS.md

@@ -0,0 +1,48 @@
+# Subnets configuration for arp-scan
+
+You need to specify the network interface and the network mask. You can also configure multiple subnets and specify VLANS (see exceptions below).
+
+## Examples
+
+* Examples for one and two subnets  (❗ Note the `['...', '...']` format):
+   * One subnet: `SCAN_SUBNETS    = ['192.168.1.0/24 --interface=eth0']`
+   * Two subnets:  `SCAN_SUBNETS    = ['192.168.1.0/24 --interface=eth0', '192.168.1.0/24 --interface=eth1 -vlan=107']` 
+
+## Explanation
+
+### Network mask
+
+**Example value: `192.168.1.0/24`**
+
+The arp-scan time itself depends on the number of IP addresses to check. 
+
+> The number of IPs to check depends on the [network mask](https://www.calculator.net/ip-subnet-calculator.html) you set on the `SCAN_SUBNETS` setting. 
+> For example, a `/24` mask results in 256 IPs to check, whereas a `/16` mask checks around 65,536. Every IP takes a couple of seconds. This means that with an incorrect configuration, the arp-scan will take hours to complete instead of seconds.
+
+Specify the network filter (which **significantly** speeds up the scan process). For example, the filter `192.168.1.0/24` covers IP ranges 192.168.1.0 to 192.168.1.255.
+
+### Network interface (adapter)
+
+**Example value: `--interface=eth0`**
+
+The adapter will probably be `eth0` or `eth1`. (Run `iwconfig` in the container to find your interface name(s)) 
+
+> Run `iwconfig` in your container to find your interface name(s) (e.g.: `eth0`, `eth1`). 
+
+### VLANs
+
+**Example value: `-vlan=107`**
+
+- Append e.g.: ` -vlan=107` to the interface field (e.g.: `eth0 -vlan=107`) for multiple vlans. More details in this [comment in this issue](https://github.com/jokob-sk/Pi.Alert/issues/170#issuecomment-1419902988)
+
+#### VLAN 🔍Example:
+
+![Vlan configuration example](/docs/img/SUBNETS/subnets_vlan.png)
+
+#### Support for VLANS (& exceptions)
+
+Please note the accessibility of the macvlans when they are configured on the same computer. My understanding this is a general networking behavior, but feel free to clarify via a PR/issue.
+
+- Pi.Alert does not detect the macvlan container when it is running on the same computer.
+- Pi.Alert recognizes the macvlan container when it is running on a different computer.
+

docs/VERSIONS.md

@@ -0,0 +1,25 @@
+## Am I running the latest released version?
+
+Since version 23.01.14 PiAlert uses a simple timestamp-based version check to verify if a new version is available. You can check the [current and past releases here](https://github.com/jokob-sk/Pi.Alert/releases), or have a look at what I'm [currently working on](https://github.com/jokob-sk/Pi.Alert/issues/138). 
+
+If you are not on the latest version, the app will notify you, that a new released version is avialable the following way:
+
+### 📧 Via email on a notification event
+
+If any notification occurs and an email is sent, the email will contain a note that a new version is available. See the sample email below:
+
+![Sample email if a new version is available](/docs/img/VERSIONS/new-version-available-email.png)
+
+### 🆕 In the UI
+
+In the UI via a notification Icon and via a custom message in the Maintenance section.
+
+![UI screenshot if a new version is available](/docs/img/VERSIONS/new-version-available-maintenance.png)
+
+For a comparison, this is how the UI looks like if you are on the latest stable image:
+
+![UI screenshot if on latest version](/docs/img/VERSIONS/latest-version-maintenance.png)
+
+## Implementation details
+
+During build a [/home/pi/pialert/front/buildtimestamp.txt](https://github.com/jokob-sk/Pi.Alert/blob/092797e75ccfa8359444ad149e727358ac4da05f/Dockerfile#L44) file is created. The app then periodically checks if a new release is available with a newer timestamp in GitHub's rest-based JSON endpoint (check the `def isNewVersion():` method in `pialert.py` for details).   

docs/VERSIONS_HISTORY.md

@@ -0,0 +1,87 @@
+# Pi.Alert Version History
+<!--- --------------------------------------------------------------------- --->
+
+  | Version | Description                                                     |
+  | ------- | --------------------------------------------------------------- |
+  |  v3.00  | Major set of New features & Enhancements                        |
+  |  v2.70  | New features & Usability improvements in the web prontal        |
+  |  v2.61  | Bug fixing                                                      |
+  |  v2.60  | Improved the compability of installation process (Ubuntu)       |
+  |  v2.56  | Bug fixing                                                      |
+  |  v2.55  | Bug fixing                                                      |
+  |  v2.52  | Bug fixing                                                      |
+  |  v2.51  | Bug fixing                                                      |
+  |  v2.50  | First public release                                            |
+
+
+# 🆕 2022+ [Newest Release notes](https://github.com/jokob-sk/Pi.Alert/issues/138)
+
+## Pi.Alert v3.02
+<!--- --------------------------------------------------------------------- --->
+ **PENDING UPDATE DOC**
+  - Fixed: UNIQUE constraint failed with Local MAC #114
+
+
+## Pi.Alert v3.01
+<!--- --------------------------------------------------------------------- --->
+ **PENDING UPDATE DOC**
+  - Fixed: Problem with local MAC & IP (raspberry) #106
+ 
+
+## Pi.Alert v3.00
+<!--- --------------------------------------------------------------------- --->
+ **PENDING UPDATE DOC**
+  - `arp-scan` config options: interface, several subnets. #101 #15
+  - Next/previos button while editing devices #66 #37
+  - Internet presence/sessions monitoring #63
+  - Logical delete / archive / hide Device #93
+  - Flag to mark device with random MAC's #87
+  - New Device Types predefined in combobox #92
+  - Ask before leave the page with unsaved changes #104
+  - Option to don't mark devices as new during installation #94
+  - Uninstall script #62
+  - Fixed: Error updating name of devices w/o IP #97
+  - Fixed: Deleted devices reappear #84
+  - Fixed: Device running Pi.Alert must be marked as "on-line" #76
+  - Fixed: Incorrect calculation of presence hours #102
+  - Fixed: Problem redirect to homepage clicking in logo #103
+
+
+## Pi.Alert v2.70
+<!--- --------------------------------------------------------------------- --->
+  - Added Client names resolution #43
+  - Added Check to mark devices as "known" #16
+  - Remember "Show XXX entries" dropdown value #16 #26
+  - Remember "sorting" in devices #16
+  - Remember "Device panel " in device detail #16
+  - Added "All" option to "Show x Entries" option #16
+  - Added optional Location field (Door, Basement, etc.) to devices #16
+  - "Device updated successfully" message now is not modal #16
+  - Now is possible to delete Devices #16
+  - Added Device Type Singleboard Computer (SBC) #16
+  - Allowed to use " in device name #42
+
+
+## Pi.Alert v2.60
+<!--- --------------------------------------------------------------------- --->
+  - `pialert.conf` moved from `back` to `config` folder
+  - `pialert.conf` splitted in two files: `pialert.conf` and `version.conf`
+  - Added compatibility with Python 3 (default version installed with Ubuntu)
+  - Added compatibility in the Installation guide with Ubuntu server
+  - Eliminated some unnecessary packages from the installation
+  
+
+
+### License
+  GPL 3.0
+  [Read more here](../LICENSE.txt)
+
+### Contact
+  Always use the Issue tracker for the correct fork, for example: 
+  
+  [jokob-sk/Pi.Alert](https://github.com/jokob-sk/Pi.Alert/issues). Please also follow the guidelines on:
+
+  - ➕ [Pull Request guidelines](https://github.com/jokob-sk/Pi.Alert/tree/main/docs#-pull-requests-prs) 
+  - 🙏 [Feature request guidelines](https://github.com/jokob-sk/Pi.Alert/tree/main/docs#-feature-requests) 
+  - 🐛 [Issue guidelines](https://github.com/jokob-sk/Pi.Alert/tree/main/docs#-submitting-an-issue-or-bug)
+

docs/WEBHOOK_N8N.md

@@ -0,0 +1,18 @@
+### Create a simple n8n workflow
+
+![n8n workflow](/docs/img/WEBHOOK_N8N/n8n_workflow.png)
+
+### Specify your email template 
+See [sample JSON](https://github.com/jokob-sk/Pi.Alert/blob/main/back/webhook_json_sample.json) if you want to see the JSON paths used in the email template below
+![Email template](/docs/img/WEBHOOK_N8N/n8n_send_email_settings.png)
+
+```
+Events count: {{ $json["body"]["attachments"][0]["text"]["events"].length }}
+New devices count: {{ $json["body"]["attachments"][0]["text"]["new_devices"].length }}
+```
+
+### Get your webhook in n8n
+![n8n webhook URL](/docs/img/WEBHOOK_N8N/n8n_webhook_settings.png)
+
+### Configure PiAlert to point to the above URL
+![PiAlert config](/docs/img/WEBHOOK_N8N/Webhook_settings.png)