From 7653ddce6316e0a7ee984528a86c5146744861f9 Mon Sep 17 00:00:00 2001 From: jokob-sk Date: Sun, 7 Apr 2024 09:44:37 +1000 Subject: [PATCH] =?UTF-8?q?PiAlert=20->=20NetAlertX=20=E2=9C=8D?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/ISSUE_TEMPLATE/i-have-an-issue.yml | 4 +- .github/workflows/docker_cache-cleaner.yml | 2 +- .github/workflows/docker_dev.yml | 2 +- CONTRIBUTING | 4 +- README.md | 24 +++++----- back/pialert.conf | 6 +-- back/report_sample.html | 8 ++-- back/report_template.html | 8 ++-- back/report_template_new_version.html | 10 ++-- back/update_vendors.sh | 2 +- back/webhook_json_sample.json | 4 +- docker-compose.yml | 6 +-- dockerfiles/README.md | 36 +++++++-------- dockerfiles/README_ES.md | 26 +++++------ docs/API.md | 6 +-- docs/BACKUPS.md | 12 ++--- docs/DEBUG_PLUGINS.md | 4 +- docs/DEBUG_TIPS.md | 4 +- docs/DEVICE_MANAGEMENT.md | 16 +++---- docs/FRONTEND_DEVELOPMENT.md | 2 +- docs/HW_INSTALL.md | 4 +- docs/NETWORK_TREE.md | 2 +- docs/RANDOM_MAC.md | 10 ++-- docs/README.md | 10 ++-- docs/REVERSE_PROXY.md | 14 +++--- docs/SETTINGS_SYSTEM.md | 4 +- docs/SUBNETS.md | 8 ++-- docs/VERSIONS.md | 4 +- docs/VERSIONS_HISTORY.md | 10 ++-- docs/WEBHOOK_N8N.md | 2 +- docs/WEBHOOK_SECRET.md | 4 +- docs/WEB_UI_PORT_DEBUG.md | 2 +- front/css/pialert.css | 2 +- front/deviceDetails.php | 8 ++-- front/devices.php | 2 +- front/events.php | 2 +- front/index.php | 4 +- front/js/pialert_common.js | 2 +- front/js/ui_components.js | 2 +- front/maintenance.php | 8 ++-- front/network.php | 2 +- front/php/server/db.php | 2 +- front/php/server/dbHelper.php | 2 +- front/php/server/devices.php | 2 +- front/php/server/events.php | 2 +- front/php/server/internetinfo.php | 2 +- front/php/server/nslookup.php | 2 +- front/php/server/parameters.php | 2 +- front/php/server/traceroute.php | 2 +- front/php/server/util.php | 4 +- front/php/templates/build.php | 2 +- front/php/templates/footer.php | 10 ++-- front/php/templates/header.php | 18 ++++---- front/php/templates/language/de_de.json | 38 +++++++-------- front/php/templates/language/en_us.json | 40 ++++++++-------- front/php/templates/language/es_es.json | 46 +++++++++---------- front/php/templates/language/fr_fr.json | 2 +- front/php/templates/language/ru_ru.json | 40 ++++++++-------- front/php/templates/notification.php | 2 +- front/php/templates/version.php | 2 +- front/plugins.php | 2 +- front/plugins/README.md | 16 +++---- front/plugins/README_DE.md | 16 +++---- front/plugins/README_ES.md | 16 +++---- front/plugins/_publisher_apprise/apprise.py | 4 +- front/plugins/_publisher_email/config.json | 6 +-- front/plugins/_publisher_email/email_smtp.py | 2 +- front/plugins/_publisher_mqtt/README.md | 2 +- front/plugins/_publisher_mqtt/config.json | 2 +- front/plugins/_publisher_mqtt/mqtt.py | 2 +- front/plugins/_publisher_ntfy/ntfy.py | 4 +- front/plugins/_publisher_pushover/pushover.py | 2 +- .../plugins/_publisher_pushsafer/pushsafer.py | 6 +-- front/plugins/_publisher_webhook/README.md | 2 +- front/plugins/_publisher_webhook/config.json | 10 ++-- front/plugins/_publisher_webhook/webhook.py | 6 +-- front/plugins/arp_scan/README.md | 4 +- front/plugins/arp_scan/README_DE.md | 4 +- front/plugins/arp_scan/README_ES.md | 4 +- front/plugins/csv_backup/README.md | 6 +-- front/plugins/csv_backup/README_DE.md | 4 +- front/plugins/csv_backup/README_ES.md | 4 +- .../plugins/events_notifications/config.json | 2 +- front/plugins/internet_speedtest/script.py | 4 +- front/plugins/known_template/config.json | 2 +- front/plugins/newdev_template/config.json | 2 +- front/plugins/nmap_scan/README_ES.md | 2 +- front/plugins/pholus_scan/README.md | 2 +- front/plugins/pholus_scan/README_ES.md | 2 +- front/plugins/pholus_scan/config.json | 4 +- front/plugins/snmp_discovery/config.json | 4 +- front/plugins/undiscoverables/README.md | 2 +- front/plugins/undiscoverables/README_DE.md | 2 +- front/plugins/undiscoverables/README_ES.md | 2 +- front/pluginsCore.php | 2 +- front/presence.php | 2 +- front/report.php | 2 +- front/settings.php | 2 +- front/systeminfo.php | 2 +- front/workflows.php | 2 +- install/index.html | 2 +- install/install.debian.sh | 2 +- pialert/README.md | 8 ++-- pialert/README_ES.md | 8 ++-- pialert/__init__.py | 2 +- pialert/__main__.py | 6 +-- pialert/conf.py | 2 +- pialert/const.py | 2 +- pialert/database.py | 2 +- pialert/helper.py | 4 +- pialert/logger.py | 2 +- pialert/reporting.py | 2 +- test/__init__.py | 2 +- update_sponsors.py | 2 +- 114 files changed, 362 insertions(+), 362 deletions(-) mode change 100644 => 100755 front/php/templates/language/es_es.json mode change 100644 => 100755 front/php/templates/language/fr_fr.json diff --git a/.github/ISSUE_TEMPLATE/i-have-an-issue.yml b/.github/ISSUE_TEMPLATE/i-have-an-issue.yml index 84e6bf98..f5aedbf0 100755 --- a/.github/ISSUE_TEMPLATE/i-have-an-issue.yml +++ b/.github/ISSUE_TEMPLATE/i-have-an-issue.yml @@ -7,7 +7,7 @@ body: label: Is there an existing issue for this? description: Please search to see if an open or closed issue already exists for the bug you encountered. options: - - label: I have searched the existing open and closed issues and I checked the docs https://github.com/jokob-sk/Pi.Alert/tree/main/docs + - label: I have searched the existing open and closed issues and I checked the docs https://github.com/jokob-sk/NetAlertX/tree/main/docs required: true - type: textarea attributes: @@ -60,7 +60,7 @@ body: attributes: label: pialert.log description: | - Logs with debug enabled (https://github.com/jokob-sk/Pi.Alert/blob/main/docs/DEBUG_TIPS.md) ⚠ + Logs with debug enabled (https://github.com/jokob-sk/NetAlertX/blob/main/docs/DEBUG_TIPS.md) ⚠ ***Generally speaking, all bug reports should have logs provided.*** Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. Additionally, any additional info? Screenshots? References? Anything that will give us more context about the issue you are encountering! diff --git a/.github/workflows/docker_cache-cleaner.yml b/.github/workflows/docker_cache-cleaner.yml index 53925563..8d7f61e7 100755 --- a/.github/workflows/docker_cache-cleaner.yml +++ b/.github/workflows/docker_cache-cleaner.yml @@ -19,7 +19,7 @@ jobs: - uses: actions/delete-package-versions@v4 with: - package-name: pi.alert + package-name: netalertx package-type: container min-versions-to-keep: 0 delete-only-untagged-versions: true \ No newline at end of file diff --git a/.github/workflows/docker_dev.yml b/.github/workflows/docker_dev.yml index 2986418f..9e0f3202 100755 --- a/.github/workflows/docker_dev.yml +++ b/.github/workflows/docker_dev.yml @@ -20,7 +20,7 @@ jobs: packages: write if: > contains(github.event.head_commit.message, 'PUSHPROD') != 'True' && - github.repository == 'jokob-sk/Pi.Alert' + github.repository == 'jokob-sk/NetAlertX' steps: - name: Checkout uses: actions/checkout@v4 diff --git a/CONTRIBUTING b/CONTRIBUTING index fb332236..423166a5 100755 --- a/CONTRIBUTING +++ b/CONTRIBUTING @@ -6,8 +6,8 @@ The issue tracker is the preferred channel for bug reports, features requests an Before submitting a new issue please spend a couple of minutes on research: -* Check [🛑 Common issues](https://github.com/jokob-sk/Pi.Alert/blob/main/docs/DEBUG_TIPS.md#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. +* Check [🛑 Common issues](https://github.com/jokob-sk/NetAlertX/blob/main/docs/DEBUG_TIPS.md#common-issues) +* Check [💡 Closed issues](https://github.com/jokob-sk/NetAlertX/issues?q=is%3Aissue+is%3Aclosed) if a similar issue was solved in the past. ## Pull-requests (PRs) diff --git a/README.md b/README.md index 22f0a454..ba4ba353 100755 --- a/README.md +++ b/README.md @@ -1,14 +1,14 @@ # 💻🔍 Network security scanner & notification framework -Get visibility of what's going on on your WIFI/LAN network. Schedule scans for devices, port changes and get alerts if unknown devices or changes are found. Write your own [Plugins](https://github.com/jokob-sk/Pi.Alert/tree/main/front/plugins#readme) with auto-generated UI and in-build notification system. Build out and easily maintain your network source of truth (NSoT). +Get visibility of what's going on on your WIFI/LAN network. Schedule scans for devices, port changes and get alerts if unknown devices or changes are found. Write your own [Plugins](https://github.com/jokob-sk/NetAlertX/tree/main/front/plugins#readme) with auto-generated UI and in-build notification system. Build out and easily maintain your network source of truth (NSoT). -[![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) +[![GitHub Committed](https://img.shields.io/github/last-commit/jokob-sk/NetAlertX?color=40ba12&label=Committed&logo=GitHub&logoColor=fff)](https://github.com/jokob-sk/NetAlertX) [![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) -[![GitHub Release](https://img.shields.io/github/v/release/jokob-sk/Pi.Alert?color=0aa8d2&logoColor=fff&logo=GitHub)](https://github.com/jokob-sk/Pi.Alert/releases) +[![GitHub Release](https://img.shields.io/github/v/release/jokob-sk/NetAlertX?color=0aa8d2&logoColor=fff&logo=GitHub)](https://github.com/jokob-sk/NetAlertX/releases) [![GitHub Sponsors](https://img.shields.io/github/sponsors/jokob-sk?style=social)](https://github.com/sponsors/jokob-sk) - | 🐳 [Docker hub](https://registry.hub.docker.com/r/jokobsk/pi.alert) | 📑 [Docker guide](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) | + | 🐳 [Docker hub](https://registry.hub.docker.com/r/jokobsk/pi.alert) | 📑 [Docker guide](https://github.com/jokob-sk/NetAlertX/blob/main/dockerfiles/README.md) |🆕 [Release notes](https://github.com/jokob-sk/NetAlertX/releases) | 📚 [All Docs](https://github.com/jokob-sk/NetAlertX/tree/main/docs) | |----------------------|----------------------| ----------------------| ----------------------| @@ -35,9 +35,9 @@ Get visibility of what's going on on your WIFI/LAN network. Schedule scans for d PiAlert combines several network and other scanning tools 🔍 with notifications 📧 into one user-friendly package 📦. - Set up a _kill switch ☠_ for your network via a smart plug with the available [Home Assistant](https://github.com/jokob-sk/Pi.Alert/blob/main/docs/HOME_ASSISTANT.md) integration. Implement custom automations with the [CSV device Exports 📤](https://github.com/jokob-sk/Pi.Alert/tree/main/front/plugins/csv_backup), [Webhooks](https://github.com/jokob-sk/Pi.Alert/blob/main/docs/WEBHOOK_N8N.md), or [API endpoints](https://github.com/jokob-sk/Pi.Alert/blob/main/docs/API.md) features. + Set up a _kill switch ☠_ for your network via a smart plug with the available [Home Assistant](https://github.com/jokob-sk/NetAlertX/blob/main/docs/HOME_ASSISTANT.md) integration. Implement custom automations with the [CSV device Exports 📤](https://github.com/jokob-sk/NetAlertX/tree/main/front/plugins/csv_backup), [Webhooks](https://github.com/jokob-sk/NetAlertX/blob/main/docs/WEBHOOK_N8N.md), or [API endpoints](https://github.com/jokob-sk/NetAlertX/blob/main/docs/API.md) features. - Extend the app if you want to create your own scanner [Plugin](https://github.com/jokob-sk/Pi.Alert/tree/main/front/plugins#readme) and handle the results and notifications in PiAlert. + Extend the app if you want to create your own scanner [Plugin](https://github.com/jokob-sk/NetAlertX/tree/main/front/plugins#readme) and handle the results and notifications in PiAlert. Looking forward to your contributions if you decide to share your work with the community ❤. @@ -47,10 +47,10 @@ Get visibility of what's going on on your WIFI/LAN network. Schedule scans for d | Features | Details | |-------------|-------------| -| 🔍 | The app scans your network for, **New devices**, **New connections** (re-connections), **Disconnections**, **"Always Connected" devices down**, Devices **IP changes** and **Internet IP address changes**. Discovery & scan methods include: **arp-scan**. **Pi-hole - DB import**, **Pi-hole - DHCP leases import**, **Generic DHCP leases import**. **UNIFI controller import**, **SNMP-enabled router import**. Check the [Plugins](https://github.com/jokob-sk/Pi.Alert/tree/main/front/plugins#readme) docs for more info on individual scans. | +| 🔍 | The app scans your network for, **New devices**, **New connections** (re-connections), **Disconnections**, **"Always Connected" devices down**, Devices **IP changes** and **Internet IP address changes**. Discovery & scan methods include: **arp-scan**. **Pi-hole - DB import**, **Pi-hole - DHCP leases import**, **Generic DHCP leases import**. **UNIFI controller import**, **SNMP-enabled router import**. Check the [Plugins](https://github.com/jokob-sk/NetAlertX/tree/main/front/plugins#readme) docs for more info on individual scans. | |📧 | Send notifications to more than 80+ services, including Telegram via [Apprise](https://hub.docker.com/r/caronc/apprise), or use [Pushsafer](https://www.pushsafer.com/), [Pushover](https://www.pushover.net/), or [NTFY](https://ntfy.sh/). | -|🧩 | Feed your data and device changes into [Home Assistant](https://github.com/jokob-sk/Pi.Alert/blob/main/docs/HOME_ASSISTANT.md), read [API endpoints](https://github.com/jokob-sk/Pi.Alert/blob/main/docs/API.md), or use [Webhooks](https://github.com/jokob-sk/Pi.Alert/blob/main/docs/WEBHOOK_N8N.md) to setup custom automation flows. | -|➕ | Build your own scanners with the [Plugin system](https://github.com/jokob-sk/Pi.Alert/tree/main/front/plugins#readme) | +|🧩 | Feed your data and device changes into [Home Assistant](https://github.com/jokob-sk/NetAlertX/blob/main/docs/HOME_ASSISTANT.md), read [API endpoints](https://github.com/jokob-sk/NetAlertX/blob/main/docs/API.md), or use [Webhooks](https://github.com/jokob-sk/NetAlertX/blob/main/docs/WEBHOOK_N8N.md) to setup custom automation flows. | +|➕ | Build your own scanners with the [Plugin system](https://github.com/jokob-sk/NetAlertX/tree/main/front/plugins#readme) | ## Installation & Documentation @@ -58,9 +58,9 @@ Get visibility of what's going on on your WIFI/LAN network. Schedule scans for d | Docs | Link | |-------------|-------------| -| 📥🐳 | [Docker instructions](https://github.com/jokob-sk/Pi.Alert/blob/main/dockerfiles/README.md) -| 📥💻 | [HW install (experimental 🧪)](https://github.com/jokob-sk/Pi.Alert/blob/main/docs/HW_INSTALL.md) | -| 📚 | [All Documentation](https://github.com/jokob-sk/Pi.Alert/blob/main/docs/README.md) (App Usage and Configuration) | +| 📥🐳 | [Docker instructions](https://github.com/jokob-sk/NetAlertX/blob/main/dockerfiles/README.md) +| 📥💻 | [HW install (experimental 🧪)](https://github.com/jokob-sk/NetAlertX/blob/main/docs/HW_INSTALL.md) | +| 📚 | [All Documentation](https://github.com/jokob-sk/NetAlertX/blob/main/docs/README.md) (App Usage and Configuration) | > Other Alternatives > diff --git a/back/pialert.conf b/back/pialert.conf index 35220bdb..d33e5daf 100755 --- a/back/pialert.conf +++ b/back/pialert.conf @@ -3,7 +3,7 @@ # Generated: 2022-12-30_22-19-40 # # # # Config file for the LAN intruder detection app: # -# https://github.com/jokob-sk/Pi.Alert # +# https://github.com/jokob-sk/NetAlertX # # # #-----------------AUTOGENERATED FILE-----------------# @@ -34,7 +34,7 @@ SMTP_RUN='disabled' # use 'on_notification' to enable SMTP_SERVER='smtp.gmail.com' SMTP_PORT=587 SMTP_REPORT_TO='user@gmail.com' -SMTP_REPORT_FROM='Pi.Alert ' +SMTP_REPORT_FROM='NetAlertX ' SMTP_SKIP_LOGIN=False SMTP_USER='user@gmail.com' SMTP_PASS='password' @@ -46,7 +46,7 @@ SMTP_SKIP_TLS=False WEBHOOK_RUN='disabled' # use 'on_notification' to enable 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 + # in https://github.com/jokob-sk/NetAlertX/blob/main/docs/webhook_json_sample.json # supported values: 'json', 'html' or 'text' # e.g.: for discord use 'html' WEBHOOK_REQUEST_METHOD='GET' diff --git a/back/report_sample.html b/back/report_sample.html index 5a535cf9..a00981a8 100755 --- a/back/report_sample.html +++ b/back/report_sample.html @@ -1,5 +1,5 @@ To edit device information: - Select "Devices" in the menu on the left of the screen @@ -11,7 +11,7 @@ To edit device information: > [!NOTE] > -> [Bulk-edit devices](https://github.com/jokob-sk/Pi.Alert/blob/main/docs/DEVICES_BULK_EDITING.md) by using the _CSV Export_ functionality in the _Maintenance_ section. +> [Bulk-edit devices](https://github.com/jokob-sk/NetAlertX/blob/main/docs/DEVICES_BULK_EDITING.md) by using the _CSV Export_ functionality in the _Maintenance_ section. ![Device Details][screen1] @@ -23,7 +23,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 when empty or unknown + - **Vendor**: Automatically updated by NetAlertX 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 @@ -66,7 +66,7 @@ know, but it **is totally useless when connecting to our own WIFI's** or known networks. **I recommend disabling this operation when connecting our devices to our own -WIFI's**, in this way, Pi.Alert will be able to identify the device, and it +WIFI's**, in this way, NetAlertX 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). @@ -89,11 +89,11 @@ decides to change the MAC). 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: + [jokob-sk/NetAlertX](https://github.com/jokob-sk/NetAlertX/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) + - ➕ [Pull Request guidelines](https://github.com/jokob-sk/NetAlertX/tree/main/docs#-pull-requests-prs) + - 🙏 [Feature request guidelines](https://github.com/jokob-sk/NetAlertX/tree/main/docs#-feature-requests) + - 🐛 [Issue guidelines](https://github.com/jokob-sk/NetAlertX/tree/main/docs#-submitting-an-issue-or-bug) ***Suggestions and comments are welcome*** diff --git a/docs/FRONTEND_DEVELOPMENT.md b/docs/FRONTEND_DEVELOPMENT.md index ad646d49..a88aa71d 100755 --- a/docs/FRONTEND_DEVELOPMENT.md +++ b/docs/FRONTEND_DEVELOPMENT.md @@ -43,4 +43,4 @@ Some useful frontend JavaScript functions: - `getSetting(string stringKey)` - method to retrieve settings in the frontend -Check the [pialert_common.js](https://github.com/jokob-sk/Pi.Alert/blob/main-2023-06-10/front/js/pialert_common.js) file for more frontend functions. \ No newline at end of file +Check the [pialert_common.js](https://github.com/jokob-sk/NetAlertX/blob/main-2023-06-10/front/js/pialert_common.js) file for more frontend functions. \ No newline at end of file diff --git a/docs/HW_INSTALL.md b/docs/HW_INSTALL.md index e3c8f0e9..da48e75a 100755 --- a/docs/HW_INSTALL.md +++ b/docs/HW_INSTALL.md @@ -35,13 +35,13 @@ Some facts about what and where something will be changed/installed by the HW in ## 📥 Installation via CURL ```bash -curl -o install.debian.sh https://raw.githubusercontent.com/jokob-sk/Pi.Alert/main/install/install.debian.sh && sudo chmod +x install.debian.sh && sudo ./install.debian.sh +curl -o install.debian.sh https://raw.githubusercontent.com/jokob-sk/NetAlertX/main/install/install.debian.sh && sudo chmod +x install.debian.sh && sudo ./install.debian.sh ``` ## 📥 Installation via WGET ```bash -wget https://raw.githubusercontent.com/jokob-sk/Pi.Alert/main/install/install.debian.sh -O install.debian.sh && sudo chmod +x install.debian.sh && sudo ./install.debian.sh +wget https://raw.githubusercontent.com/jokob-sk/NetAlertX/main/install/install.debian.sh -O install.debian.sh && sudo chmod +x install.debian.sh && sudo ./install.debian.sh ``` These commands will download the `install.debian.sh` script from the GitHub repository, make it executable with `chmod`, and then run it using `./install.debian.sh`. diff --git a/docs/NETWORK_TREE.md b/docs/NETWORK_TREE.md index a85e8b4b..91ed85d8 100755 --- a/docs/NETWORK_TREE.md +++ b/docs/NETWORK_TREE.md @@ -2,7 +2,7 @@ Make sure you have a root device with the MAC `Internet` (No other MAC addresses are currently supported as the root node) set to a network device type (e.g.: **Type**:`Router`). -> 💡 Tip: You can add dummy devices via the [Undiscoverables plugin](https://github.com/jokob-sk/Pi.Alert/blob/main/front/plugins/undiscoverables/README.md) +> 💡 Tip: You can add dummy devices via the [Undiscoverables plugin](https://github.com/jokob-sk/NetAlertX/blob/main/front/plugins/undiscoverables/README.md) > 💡 Tip: Export your configuration of the Network and Devices once in a while via the Export CSV feature under **Maintenance** -> **Backup/Restore** -> **CSV Export**. diff --git a/docs/RANDOM_MAC.md b/docs/RANDOM_MAC.md index fd109f3b..66412698 100755 --- a/docs/RANDOM_MAC.md +++ b/docs/RANDOM_MAC.md @@ -12,7 +12,7 @@ know, but it **is totally useless when connecting to our own WIFI's** or known networks. **I recommend disabling this operation when connecting our devices to our own -WIFI's**, in this way, Pi.Alert will be able to identify the device, and it +WIFI's**, in this way, NetAlertX 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). @@ -37,11 +37,11 @@ decides to change the MAC). ### 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: + [jokob-sk/NetAlertX](https://github.com/jokob-sk/NetAlertX/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) + - ➕ [Pull Request guidelines](https://github.com/jokob-sk/NetAlertX/tree/main/docs#-pull-requests-prs) + - 🙏 [Feature request guidelines](https://github.com/jokob-sk/NetAlertX/tree/main/docs#-feature-requests) + - 🐛 [Issue guidelines](https://github.com/jokob-sk/NetAlertX/tree/main/docs#-submitting-an-issue-or-bug) ***Suggestions and comments are welcome*** diff --git a/docs/README.md b/docs/README.md index f400bce3..5ff3df4e 100755 --- a/docs/README.md +++ b/docs/README.md @@ -13,11 +13,11 @@ There is also an in-app Help / FAQ section that should be answering frequently a #### 🐳 Docker (Fully supported) -- The main installation method is as a [docker container - follow these instructions here](https://github.com/jokob-sk/Pi.Alert/blob/main/dockerfiles/README.md). +- The main installation method is as a [docker container - follow these instructions here](https://github.com/jokob-sk/NetAlertX/blob/main/dockerfiles/README.md). #### 💻 Bare-metal / On-server (Experimental/community supported 🧪) -- [(Experimental 🧪) On-hardware instructions](https://github.com/jokob-sk/Pi.Alert/blob/main/docs/HW_INSTALL.md) +- [(Experimental 🧪) On-hardware instructions](https://github.com/jokob-sk/NetAlertX/blob/main/docs/HW_INSTALL.md) - Alternative bare-metal install forks: - [leiweibau's fork](https://github.com/leiweibau/Pi.Alert/) (maintained) @@ -129,8 +129,8 @@ Some additional context: Before submitting a new issue please spend a couple of minutes on research: -* Check [🛑 Common issues](https://github.com/jokob-sk/Pi.Alert/blob/main/docs/DEBUG_TIPS.md#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)❗ +* Check [🛑 Common issues](https://github.com/jokob-sk/NetAlertX/blob/main/docs/DEBUG_TIPS.md#common-issues) +* Check [💡 Closed issues](https://github.com/jokob-sk/NetAlertX/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/NetAlertX/blob/main/docs/DEBUG_TIPS.md)❗ ⚠ Please follow the pre-defined issue template to resolve your issue faster. diff --git a/docs/REVERSE_PROXY.md b/docs/REVERSE_PROXY.md index 018d9292..674ab469 100755 --- a/docs/REVERSE_PROXY.md +++ b/docs/REVERSE_PROXY.md @@ -4,7 +4,7 @@ > [!NOTE] -> There are 2 NGINX files for PiAlert, one for the bare-metal Debian install (`pialert.debian.conf`), and one for the docker container (`pialert.template.conf`). Both can be found in the [install](https://github.com/jokob-sk/Pi.Alert/tree/main/install) folder. Map, or use, the one appropriate for your setup. +> There are 2 NGINX files for PiAlert, one for the bare-metal Debian install (`pialert.debian.conf`), and one for the docker container (`pialert.template.conf`). Both can be found in the [install](https://github.com/jokob-sk/NetAlertX/tree/main/install) folder. Map, or use, the one appropriate for your setup. ## NGINX HTTP Configuration (Direct Path) @@ -302,7 +302,7 @@ In the SWAG container create `/config/nginx/proxy-confs/pialert.subfolder.conf` # 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. +# Since NetAlertX uses a Host network, you may need to use the IP address of the system running NetAlertX for $upstream_app. location /pialert { return 301 $scheme://$host/pialert/; @@ -352,9 +352,9 @@ location ^~ /pialert/ { ## Traefik -> Submitted by [Isegrimm](https://github.com/Isegrimm) 🙏 (based on this [discussion](https://github.com/jokob-sk/Pi.Alert/discussions/449#discussioncomment-7281442)) +> Submitted by [Isegrimm](https://github.com/Isegrimm) 🙏 (based on this [discussion](https://github.com/jokob-sk/NetAlertX/discussions/449#discussioncomment-7281442)) -Asuming the user already has a working Traefik setup, this is what's needed to make Pi.Alert work at a URL like www.domain.com/pialert/. +Asuming the user already has a working Traefik setup, this is what's needed to make NetAlertX work at a URL like www.domain.com/pialert/. Note: Everything in these configs assumes '**www.domain.com**' as your domainname and '**section31**' as an arbitrary name for your certificate setup. You will have to substitute these with your own. @@ -362,7 +362,7 @@ Also, I use the prefix '**pialert**'. If you want to use another prefix, change Content of my yaml-file (this is the generic Traefik config, which defines which ports to listen on, redirect http to https and sets up the certificate process). It also contains Authelia, which I use for authentication. -This part contains nothing specific to Pi.Alert. +This part contains nothing specific to NetAlertX. ```yaml version: '3.8' @@ -406,7 +406,7 @@ services: restart: u nless-stopped ``` -Snippet of the dynamic.toml file (referenced in the yml-file above) that defines the config for Pi.Alert: +Snippet of the dynamic.toml file (referenced in the yml-file above) that defines the config for NetAlertX: The following are self-defined keywords, everything else is traefik keywords: - pialert-router - pialert-service @@ -441,7 +441,7 @@ The following are self-defined keywords, everything else is traefik keywords: forceSlash = false ``` -To make Pi.Alert work with this setup I modified the default file at `/etc/nginx/sites-available/default` in the docker container by copying it to my local filesystem, adding the changes as specified by [cvc90](https://github.com/cvc90) and mounting the new file into the docker container, overwriting the original one. By mapping the file instead of changing the file in-place, the changes persist if an updated dockerimage is pulled. This is also a downside when the default file is updated, so I only use this as a temporary solution, until the dockerimage is updated with this change. +To make NetAlertX work with this setup I modified the default file at `/etc/nginx/sites-available/default` in the docker container by copying it to my local filesystem, adding the changes as specified by [cvc90](https://github.com/cvc90) and mounting the new file into the docker container, overwriting the original one. By mapping the file instead of changing the file in-place, the changes persist if an updated dockerimage is pulled. This is also a downside when the default file is updated, so I only use this as a temporary solution, until the dockerimage is updated with this change. Default-file: diff --git a/docs/SETTINGS_SYSTEM.md b/docs/SETTINGS_SYSTEM.md index bd205075..1207a6c1 100755 --- a/docs/SETTINGS_SYSTEM.md +++ b/docs/SETTINGS_SYSTEM.md @@ -32,7 +32,7 @@ The App generates two `pialert.conf` entries for every setting (Since version 23 > [!NOTE] > This is the preferred way adding settings going forward. I'll be likely migrating all app settings into plugin-based settings. -Plugin settings are loaded dynamically from the `config.json` of individual plugins. If a setting isn't defined in the `pialert.conf` file, it is initialized via the `default_value` property of a setting from the `config.json` file. Check the [Plugins documentation](https://github.com/jokob-sk/Pi.Alert/blob/main/front/plugins/README.md#-setting-object-structure), section `⚙ Setting object structure` for details on the structure of the setting. +Plugin settings are loaded dynamically from the `config.json` of individual plugins. If a setting isn't defined in the `pialert.conf` file, it is initialized via the `default_value` property of a setting from the `config.json` file. Check the [Plugins documentation](https://github.com/jokob-sk/NetAlertX/blob/main/front/plugins/README.md#-setting-object-structure), section `⚙ Setting object structure` for details on the structure of the setting. ![Screen 1][screen1] @@ -74,4 +74,4 @@ Here's a high-level description of the code: _____________________ -[screen1]: https://raw.githubusercontent.com/jokob-sk/Pi.Alert/main/docs/img/plugins_json_settings.png "Screen 1" \ No newline at end of file +[screen1]: https://raw.githubusercontent.com/jokob-sk/NetAlertX/main/docs/img/plugins_json_settings.png "Screen 1" \ No newline at end of file diff --git a/docs/SUBNETS.md b/docs/SUBNETS.md index 028b1045..e94ac6f7 100755 --- a/docs/SUBNETS.md +++ b/docs/SUBNETS.md @@ -44,12 +44,12 @@ The adapter will probably be `eth0` or `eth1`. (Check `System info` > `Network H **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) +- 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/NetAlertX/issues/170#issuecomment-1419902988) #### VLANs on a Hyper-V setup -> Community sourced content by [mscreations](https://github.com/mscreations) from this [discussion](https://github.com/jokob-sk/Pi.Alert/discussions/404). +> Community sourced content by [mscreations](https://github.com/mscreations) from this [discussion](https://github.com/jokob-sk/NetAlertX/discussions/404). > [!NOTE] > The setup this was tested on: Bare Metal -> Hyper-V on Win Server 2019 -> Ubuntu 22.04 VM -> Docker -> PiAlert. @@ -102,6 +102,6 @@ network: 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. +- NetAlertX does not detect the macvlan container when it is running on the same computer. +- NetAlertX recognizes the macvlan container when it is running on a different computer. diff --git a/docs/VERSIONS.md b/docs/VERSIONS.md index 3811a325..f74174b4 100755 --- a/docs/VERSIONS.md +++ b/docs/VERSIONS.md @@ -1,6 +1,6 @@ ## 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). +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/NetAlertX/releases), or have a look at what I'm [currently working on](https://github.com/jokob-sk/NetAlertX/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: @@ -22,4 +22,4 @@ For a comparison, this is how the UI looks like if you are on the latest stable ## 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). \ No newline at end of file +During build a [/home/pi/pialert/front/buildtimestamp.txt](https://github.com/jokob-sk/NetAlertX/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). \ No newline at end of file diff --git a/docs/VERSIONS_HISTORY.md b/docs/VERSIONS_HISTORY.md index a471625d..85883fde 100755 --- a/docs/VERSIONS_HISTORY.md +++ b/docs/VERSIONS_HISTORY.md @@ -14,7 +14,7 @@ | v2.50 | First public release | -# 🆕 2022+ [Newest Release notes](https://github.com/jokob-sk/Pi.Alert/issues/138) +# 🆕 2022+ [Newest Release notes](https://github.com/jokob-sk/NetAlertX/issues/138) ## Pi.Alert v3.02 @@ -79,9 +79,9 @@ ### 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: + [jokob-sk/NetAlertX](https://github.com/jokob-sk/NetAlertX/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) + - ➕ [Pull Request guidelines](https://github.com/jokob-sk/NetAlertX/tree/main/docs#-pull-requests-prs) + - 🙏 [Feature request guidelines](https://github.com/jokob-sk/NetAlertX/tree/main/docs#-feature-requests) + - 🐛 [Issue guidelines](https://github.com/jokob-sk/NetAlertX/tree/main/docs#-submitting-an-issue-or-bug) diff --git a/docs/WEBHOOK_N8N.md b/docs/WEBHOOK_N8N.md index c47fa9c9..b4536267 100755 --- a/docs/WEBHOOK_N8N.md +++ b/docs/WEBHOOK_N8N.md @@ -5,7 +5,7 @@ N8N can be used for more advanced conditional notification use cases. For exampl ![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 +See [sample JSON](https://github.com/jokob-sk/NetAlertX/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) ``` diff --git a/docs/WEBHOOK_SECRET.md b/docs/WEBHOOK_SECRET.md index b8929bc4..17d35d6e 100755 --- a/docs/WEBHOOK_SECRET.md +++ b/docs/WEBHOOK_SECRET.md @@ -2,7 +2,7 @@ ## How does the signing work? -Pi.Alert will use the configured secret to create a hash signature of the request body. This SHA256-HMAC signature will appear in the `X-Webhook-Signature` header of each request to the webhook target URL. You can use the value of this header to validate the request was sent by Pi.Alert. +NetAlertX will use the configured secret to create a hash signature of the request body. This SHA256-HMAC signature will appear in the `X-Webhook-Signature` header of each request to the webhook target URL. You can use the value of this header to validate the request was sent by NetAlertX. ## Activating webhook signatures @@ -12,7 +12,7 @@ All you need to do in order to add a signature to the request headers is to set There are a few things to keep in mind when validating the webhook delivery: -- Pi.Alert uses an HMAC hex digest to compute the hash +- NetAlertX uses an HMAC hex digest to compute the hash - The signature in the `X-Webhook-Signature` header always starts with `sha256=` - The hash signature is generated using the configured `WEBHOOK_SECRET` and the request body. - Never use a plain `==` operator. Instead, consider using a method like [`secure_compare`](https://www.rubydoc.info/gems/rack/Rack%2FUtils:secure_compare) or [`crypto.timingSafeEqual`](https://nodejs.org/api/crypto.html#cryptotimingsafeequala-b), which performs a "constant time" string comparison to help mitigate certain timing attacks against regular equality operators, or regular loops in JIT-optimized languages. diff --git a/docs/WEB_UI_PORT_DEBUG.md b/docs/WEB_UI_PORT_DEBUG.md index be598c32..bb93c508 100755 --- a/docs/WEB_UI_PORT_DEBUG.md +++ b/docs/WEB_UI_PORT_DEBUG.md @@ -3,7 +3,7 @@ When opening an issue please : 1. Include a screenshot of what you see when accessing `HTTP:///20211` (or your custom port) -1. [Follow steps 1, 2, 3, 4 on this page](https://github.com/jokob-sk/Pi.Alert/blob/main/docs/DEBUG_TIPS.md) +1. [Follow steps 1, 2, 3, 4 on this page](https://github.com/jokob-sk/NetAlertX/blob/main/docs/DEBUG_TIPS.md) 1. Execute the following in the container to see the processes and their ports and submit a screenshot of the result: 1. `sudo apt-get install lsof` 1. `sudo lsof -i` diff --git a/front/css/pialert.css b/front/css/pialert.css index 38abb975..58259c11 100755 --- a/front/css/pialert.css +++ b/front/css/pialert.css @@ -1,5 +1,5 @@ /* ----------------------------------------------------------------------------- -# Pi.Alert +# NetAlertX # Open Source Network Guard / WIFI & LAN intrusion detector # # pialert.css - Front module. CSS styles diff --git a/front/deviceDetails.php b/front/deviceDetails.php index 6f6dd510..7f104abc 100755 --- a/front/deviceDetails.php +++ b/front/deviceDetails.php @@ -1,6 +1,6 @@ -

+

@@ -442,7 +442,7 @@ - +
diff --git a/front/devices.php b/front/devices.php index e79742bb..acacf7e5 100755 --- a/front/devices.php +++ b/front/devices.php @@ -1,6 +1,6 @@ +