diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 0000000..84f09b2 --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1,8 @@ +{ + "files.watcherExclude": { + "**/.git/objects/**": true, + "**/.git/subtree-cache/**": true, + "**/node_modules/*/**": true, + "**/.hg/store/**": true + } +} \ No newline at end of file diff --git a/Makefile b/Makefile index 07a9837..facdcdf 100644 --- a/Makefile +++ b/Makefile @@ -1,4 +1,4 @@ -VERSION=0.1.6 +VERSION=0.1.7 all: gen test lint vet build build: pax diff --git a/README.md b/README.md index 3159262..c82c26f 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,5 @@ # PAX - People Counter Dashboard Service -stand by +This server provides a simple backend and dashboard for the Pax Counters. The Pax Counter is a device that counts the number of unique WiFi and Bluetooth devices it sees within a 5 minute time window. It then reports this count every 2 minutes via the [Span](https://span.lab5e.com/) service. + +The Pax Counter counts the number of unique MAC addresses (WiFi and BT) it sees within a 5 minute time window. It never reports the actual MAC addresses, only the unique count within that time window. Most personal devices tend to have some form of MAC address randomization that will change the MAC address every 10-15 minutes. We make no effort to try to identify devices beyond just counting the number of unique MAC addresses seen within a 5 minute window. diff --git a/docker-compose.yml b/docker-compose.yml new file mode 100644 index 0000000..1297b07 --- /dev/null +++ b/docker-compose.yml @@ -0,0 +1,10 @@ +version: '3.9' +services: + pax: + image: ghcr.io/lab5e/pax:latest + restart: on-error + ports: + - "4500:4500/tcp" + env_file: + - apitoken.env + diff --git a/frontend/dist/frontend/index.html b/frontend/dist/frontend/index.html index d5fc64e..16b0e68 100644 --- a/frontend/dist/frontend/index.html +++ b/frontend/dist/frontend/index.html @@ -8,6 +8,6 @@