From 99ed992b2296af7f182714e6e832c00b0c09bc69 Mon Sep 17 00:00:00 2001 From: Jonathan Flueren Date: Thu, 17 Aug 2023 21:01:43 +0200 Subject: [PATCH] Update README.md --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 17a5621..a2bbcee 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,8 @@ Tool to detect the presence of defined devices by their WiFi MAC addresses. ## How scanning works -Sets the wifi adapter into monitor mode, then listens to surrounding packets listing all detected devices into `wifi_map.yaml`. Resets the wifi adapter to normal mode for uploading the results, filters the results by the mac addresses in `identities.yaml` and sends all matched identities to the front-end webhook server in `website`. This server stores the presence information locally and displays it with `website/index.php` with a timestamp of the last update. +Sets the wifi adapter into monitor mode, then listens to surrounding packets listing all detected devices into `wifi_map.yaml`. +Then, periodically filters the results by the mac addresses that opted in on the website from `identities.json` and sends all matched identities to the website via a signed webhook. This website stores the presence information locally and displays it with `website/index.php` with a timestamp of the last update. ## What the website is capable of Shows the last update of the `upload.py` routine. It also allows to add identities by their name and mac and to delete identities by their mac. The mac addresses are hashed server-side and then stored into the world-accessible `identities.json`. @@ -15,13 +16,14 @@ Dependencies: Configs to change: - `scanner/live-scanner.sh`: - WiFi adapter name + - Possibly some more system-specific changes - `scanner/upload.py`: - URLs for webhook and identities - webhook secret - `public/update.php`: - webhook secret -Put `scanner` onto the scanning device (e.g. Raspberry Pi) and put `scanner/scan.sh` into a cron job. +Put `scanner` onto the scanning device (e.g. Raspberry Pi). Let `live-scanner.sh` and `live-uploader.sh` running in the background, e.g. by the Systemd services below. Put `website` onto a php-capable webserver and point your domain to it. ## Systemd services