From a0b0c0ba19dfa5ff251f4b83284857a10ae3766d Mon Sep 17 00:00:00 2001 From: Jokob-sk Date: Sat, 22 Jul 2023 10:18:11 +1000 Subject: [PATCH] Docs --- README.md | 2 +- docker-compose.yml | 8 ++++---- dockerfiles/README.md | 2 +- docs/README.md | 10 +++++----- pialert/helper.py | 2 +- 5 files changed, 12 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 4915c58c..2a5c8004 100755 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ Scans for devices connected to your WIFI / LAN and alerts you if new and unknown [![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) -🐳 [Docker hub](https://registry.hub.docker.com/r/jokobsk/pi.alert) | 📄 [Dockerfile](https://github.com/jokob-sk/Pi.Alert/blob/main/Dockerfile) | 📚 [Docker instructions](https://github.com/jokob-sk/Pi.Alert/blob/main/dockerfiles/README.md) | 🆕 [Release notes](https://github.com/jokob-sk/Pi.Alert/releases) +🐳 [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 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: diff --git a/docker-compose.yml b/docker-compose.yml index fba9ac15..66290e76 100755 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -11,10 +11,10 @@ services: 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 + # - ${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 # --------------------------------------------------------------------------- diff --git a/dockerfiles/README.md b/dockerfiles/README.md index c0ad3917..c06d16d9 100755 --- a/dockerfiles/README.md +++ b/dockerfiles/README.md @@ -6,7 +6,7 @@ # 🐳 A docker image for Pi.Alert -🐳 [Docker hub](https://registry.hub.docker.com/r/jokobsk/pi.alert) | 📄 [Dockerfile](https://github.com/jokob-sk/Pi.Alert/blob/main/Dockerfile) | 📚 [Docker instructions](https://github.com/jokob-sk/Pi.Alert/blob/main/dockerfiles/README.md) | 🆕 [Release notes](https://github.com/jokob-sk/Pi.Alert/releases) +🐳 [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) diff --git a/docs/README.md b/docs/README.md index 86faa24c..95a8d291 100755 --- a/docs/README.md +++ b/docs/README.md @@ -49,12 +49,12 @@ Feel free to suggest or submit new docs via a PR. ## 👨‍💻 Development priorities -Highest to lowest: +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 +* 🔼 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. diff --git a/pialert/helper.py b/pialert/helper.py index 2c9fe5ae..947c66b7 100755 --- a/pialert/helper.py +++ b/pialert/helper.py @@ -66,7 +66,7 @@ def checkPermissionsOK(): dbW_access = (os.access(fullDbPath, os.W_OK)) mylog('none', ['\n']) - mylog('none', ['The container restarted (started). If this is unexpected check bit.ly/PiAlertDebug for troubleshooting tips.']) + mylog('none', ['The container restarted (started). If this is unexpected check https://bit.ly/PiAlertDebug for troubleshooting tips.']) mylog('none', ['\n']) mylog('none', ['Permissions check (All should be True)']) mylog('none', ['------------------------------------------------'])