Merge branch 'main' of https://github.com/jokob-sk/NetAlertX

Restore manual naming of static leases using comments for MKSCAN + cleanups

.dockerignore

@@ -6,14 +6,10 @@
 docker-compose.yml
 Dockerfile
 Dockerfile.debian
-dockerfiles/LICENSE
-dockerfiles/README.md
-dockerfiles/README_ES.md
 docs
 LICENSE.txt
 README.md
 CONTRIBUTING
 FUNDING.yml
 config/.gitignore
-db/.gitignore
-
+db/.gitignore

Dockerfile

@@ -69,7 +69,7 @@ COPY --from=builder --chown=nginx:www-data ${INSTALL_DIR}/ ${INSTALL_DIR}/
 COPY install/crontab /etc/crontabs/root
 
 # Start all required services
-RUN ${INSTALL_DIR}/dockerfiles/pre-setup.sh
+RUN ${INSTALL_DIR}/dockerfiles/start.sh
 
 HEALTHCHECK --interval=30s --timeout=5s --start-period=15s --retries=2 \
     CMD curl -sf -o /dev/null ${LISTEN_ADDR}:${PORT}/php/server/query_json.php?file=app_state.json

README.md

@@ -8,8 +8,8 @@
 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).
 
 
-| 🐳 [Docker hub](https://registry.hub.docker.com/r/jokobsk/netalertx) |  📑 [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) | 🔌 [Plugins](https://github.com/jokob-sk/NetAlertX/blob/main/front/plugins/README.md) |
-|----------------------|----------------------| ----------------------|  ----------------------| ----------------------| 
+| [📑 Docker guide](https://github.com/jokob-sk/NetAlertX/blob/main/dockerfiles/README.md) | [🚀 Releases](https://github.com/jokob-sk/NetAlertX/releases) | [📚 Docs](https://github.com/jokob-sk/NetAlertX/tree/main/docs) | [🔌 Plugins](https://github.com/jokob-sk/NetAlertX/blob/main/front/plugins/README.md) | [🤖 Ask AI](https://gurubase.io/g/netalertx)
+|----------------------| ----------------------|  ----------------------| ----------------------| ----------------------| 
 
 ![showcase][showcase] 
 

docker-compose.yml

@@ -15,7 +15,7 @@ services:
       # - ${APP_DATA_LOCATION}/netalertx_dev/db:/app/db      
       - ${APP_DATA_LOCATION}/netalertx/db:/app/db           
       # (optional) useful for debugging if you have issues setting up the container
-      - ${DEV_LOCATION}/log:/app/log      
+      - ${APP_DATA_LOCATION}/netalertx/log:/app/log      
       # (API: OPTION 1) use for performance
       - type: tmpfs
         target: /app/api

dockerfiles/README.md

@@ -6,8 +6,8 @@
 
 # NetAlertX 🖧🔍 Network scanner & notification framework
 
-  | 🐳 [Docker hub](https://registry.hub.docker.com/r/jokobsk/netalertx) |  📑 [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) | 🔌 [Plugins](https://github.com/jokob-sk/NetAlertX/blob/main/front/plugins/README.md) |
-  |----------------------|----------------------| ----------------------|  ----------------------| ----------------------| 
+| [📑 Docker guide](https://github.com/jokob-sk/NetAlertX/blob/main/dockerfiles/README.md) | [🚀 Releases](https://github.com/jokob-sk/NetAlertX/releases) | [📚 Docs](https://github.com/jokob-sk/NetAlertX/tree/main/docs) | [🔌 Plugins](https://github.com/jokob-sk/NetAlertX/blob/main/front/plugins/README.md) | [🤖 Ask AI](https://gurubase.io/g/netalertx)
+|----------------------| ----------------------|  ----------------------| ----------------------| ----------------------| 
 
 <a href="https://raw.githubusercontent.com/jokob-sk/NetAlertX/main/docs/img/GENERAL/github_social_image.jpg" target="_blank">
   <img src="https://raw.githubusercontent.com/jokob-sk/NetAlertX/main/docs/img/GENERAL/github_social_image.jpg" width="1000px" />

dockerfiles/init.sh

@@ -1,7 +1,7 @@
 #!/usr/bin/with-contenv bash
 
 echo "---------------------------------------------------------"
-echo "[INSTALL]                                    Run setup.sh"
+echo "[INSTALL]                                    Run init.sh"
 echo "---------------------------------------------------------"
 
 export INSTALL_DIR=/app  # Specify the installation directory here
@@ -108,6 +108,8 @@ fi
 # Create the execution_queue.log and app_front.log files if they don't exist
 touch "${INSTALL_DIR}"/log/{app.log,execution_queue.log,app_front.log,app.php_errors.log,stderr.log,stdout.log,db_is_locked.log}
 touch "${INSTALL_DIR}"/api/user_notifications.json
+# Create plugins sub-directory if it doesn't exist in case a custom log folder is used
+mkdir -p "${INSTALL_DIR}"/log/plugins
 
 echo "[INSTALL] Fixing permissions after copied starter config & DB"
 chown -R nginx:www-data "${INSTALL_DIR}"/{config,log,db,api}

dockerfiles/start.sh

@@ -19,7 +19,7 @@ echo "oneshot" > /etc/s6-overlay/s6-rc.d/SetupOneshot/type
 echo "longrun" > /etc/s6-overlay/s6-rc.d/php-fpm/type
 echo "longrun" > /etc/s6-overlay/s6-rc.d/nginx/type
 echo "longrun" > /etc/s6-overlay/s6-rc.d/$APP_NAME/type
-echo -e "${INSTALL_DIR}/dockerfiles/setup.sh" > /etc/s6-overlay/s6-rc.d/SetupOneshot/up
+echo -e "${INSTALL_DIR}/dockerfiles/init.sh" > /etc/s6-overlay/s6-rc.d/SetupOneshot/up
 echo -e "#!/bin/execlineb -P\n/usr/sbin/php-fpm83 -F" > /etc/s6-overlay/s6-rc.d/php-fpm/run
 echo -e '#!/bin/execlineb -P\nnginx -g "daemon off;"' > /etc/s6-overlay/s6-rc.d/nginx/run
 echo -e '#!/bin/execlineb -P
@@ -38,6 +38,5 @@ touch /etc/s6-overlay/s6-rc.d/user/contents.d/{SetupOneshot,php-fpm,nginx,$APP_N
 touch /etc/s6-overlay/s6-rc.d/nginx/dependencies.d/php-fpm
 touch /etc/s6-overlay/s6-rc.d/$APP_NAME/dependencies.d/nginx
 
-
-
-rm -f $0
+# this removes the current file
+# rm -f $0

docs/API.md

@@ -1,7 +1,134 @@
-## API endpoints
+# API endpoints
 
-NetAlertX comes with a simple API. These API endpoints are static files, that are periodically updated based on your settings. 
+NetAlertX comes with a couple of API endpoints. All requests need to be authorized (executed in a logged in browser session) or you have to pass the value of the `API_TOKEN` settings as authorization bearer, for example:
 
+```graphql
+curl 'http://host:GRAPHQL_PORT/graphql' \
+  -X POST \
+  -H 'Authorization: Bearer API_TOKEN' \
+  -H 'Content-Type: application/json' \
+  --data '{
+    "query": "query GetDevices($options: PageQueryOptionsInput) { devices(options: $options) { devices { rowid devMac devName devOwner devType devVendor devLastConnection devStatus } count } }",
+    "variables": {
+      "options": {
+        "page": 1,
+        "limit": 10,
+        "sort": [{ "field": "devName", "order": "asc" }],
+        "search": "",
+        "status": "connected"
+      }
+    }
+  }'
+```
+
+## API Endpoint: GraphQL
+
+Endpoint URL: `php/server/query_graphql.php`
+Host: `same as front end (web ui)`
+Port: `20212` or as defined by the `GRAPHQL_PORT` setting
+
+### Example Query to Fetch Devices
+
+First, let's define the GraphQL query to fetch devices with pagination and sorting options.
+
+```graphql
+query GetDevices($options: PageQueryOptionsInput) {
+  devices(options: $options) {
+    devices {
+      rowid
+      devMac
+      devName
+      devOwner
+      devType
+      devVendor
+      devLastConnection
+      devStatus
+    }
+    count
+  }
+}
+```
+
+### `curl` Command
+
+You can use the following `curl` command to execute the query. 
+
+```sh
+curl 'http://host:GRAPHQL_PORT/graphql'   -X POST   -H 'Authorization: Bearer API_TOKEN'  -H 'Content-Type: application/json'   --data '{
+    "query": "query GetDevices($options: PageQueryOptionsInput) { devices(options: $options) { devices { rowid devMac devName devOwner devType devVendor devLastConnection devStatus } count } }",
+    "variables": {
+      "options": {
+        "page": 1,
+        "limit": 10,
+        "sort": [{ "field": "devName", "order": "asc" }],
+        "search": "",
+        "status": "connected"
+      }
+    }
+  }'
+```
+
+### Explanation:
+
+1. **GraphQL Query**:
+   - The `query` parameter contains the GraphQL query as a string.
+   - The `variables` parameter contains the input variables for the query.
+
+2. **Query Variables**:
+   - `page`: Specifies the page number of results to fetch.
+   - `limit`: Specifies the number of results per page.
+   - `sort`: Specifies the sorting options, with `field` being the field to sort by and `order` being the sort order (`asc` for ascending or `desc` for descending).
+   - `search`: A search term to filter the devices.
+   - `status`: The status filter to apply (valid values are `my_devices` (determined by the `UI_MY_DEVICES` setting), `connected`, `favorites`, `new`, `down`, `archived`, `offline`).
+
+3. **`curl` Command**:
+   - The `-X POST` option specifies that we are making a POST request.
+   - The `-H "Content-Type: application/json"` option sets the content type of the request to JSON.
+   - The `-d` option provides the request payload, which includes the GraphQL query and variables.
+
+### Sample Response
+
+The response will be in JSON format, similar to the following:
+
+```json
+{
+  "data": {
+    "devices": {
+      "devices": [
+        {
+          "rowid": 1,
+          "devMac": "00:11:22:33:44:55",
+          "devName": "Device 1",
+          "devOwner": "Owner 1",
+          "devType": "Type 1",
+          "devVendor": "Vendor 1",
+          "devLastConnection": "2025-01-01T00:00:00Z",
+          "devStatus": "connected"
+        },
+        {
+          "rowid": 2,
+          "devMac": "66:77:88:99:AA:BB",
+          "devName": "Device 2",
+          "devOwner": "Owner 2",
+          "devType": "Type 2",
+          "devVendor": "Vendor 2",
+          "devLastConnection": "2025-01-02T00:00:00Z",
+          "devStatus": "connected"
+        }
+      ],
+      "count": 2
+    }
+  }
+}
+```
+
+## API Endpoint: JSON files 
+
+These API endpoint are static files, that are periodically updated. 
+
+Endpoint URL: `php/server/query_json.php?file=<file name>`
+Host: `same as front end (web ui)`
+Port: `20211` or as defined by the $PORT docker environment variable (same as the port for the web ui)
 
 ### When are the endpoints updated
 
@@ -9,7 +136,7 @@ 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 `/app/api/` folder. You can acces sthem via the `/php/server/query_json.php?file=user_notifications.json` endpoint.
+In the container, these files are located under the `/app/api/` folder. You can access them via the `/php/server/query_json.php?file=user_notifications.json` endpoint.
 
 ### Available endpoints
 
@@ -95,3 +222,41 @@ Example JSON of the `table_devices.json` endpoint with two Devices (database row
 
 ```
 
+## API Endpoint: /log files
+
+To retrieve files from the `/app/log` folder. 
+
+Endpoint URL: `php/server/query_logs.php?file=<file name>`
+Host: `same as front end (web ui)`
+Port: `20211` or as defined by the $PORT docker environment variable (same as the port for the web ui)
+
+| File                     | Description                                      |
+|--------------------------|--------------------------------------------------|
+| `IP_changes.log`         | Logs of IP address changes                       |
+| `app.log`                | Main application log                             |
+| `app.php_errors`.log     | PHP error log                                    |
+| `app_front.log`          | Frontend application log                         |
+| `app_nmap.log`           | Logs of Nmap scan results                        |
+| `db_is_locked.log`       | Logs when the database is locked                 |
+| `execution_queue.log`    | Logs of execution queue activities               |
+| `plugins/`               | Directory for plugin-related files (not accessible) |
+| `report_output.html`     | HTML report output                               |
+| `report_output.json`     | JSON format report output                        |
+| `report_output.txt`      | Text format report output                        |
+| `stderr.log`             | Logs of standard error output                    |
+| `stdout.log`             | Logs of standard output                          |
+
+
+## API Endpoint: /config files
+
+To retrieve files from the `/app/config` folder. 
+
+Endpoint URL: `php/server/query_config.php?file=<file name>`
+Host: `same as front end (web ui)`
+Port: `20211` or as defined by the $PORT docker environment variable (same as the port for the web ui)
+
+| File                     | Description                                      |
+|--------------------------|--------------------------------------------------|
+| `devices.csv`            | Devices csv file                                 |
+| `app.conf`               | Application config file                          |
+

docs/BACKUPS.md

@@ -1,7 +1,8 @@
 # 💾 Backing things up
 
 > [!NOTE]
-> To backup 99% of your configuration backup at least the `/config` folder. Please read the whole page (or at least "Scenario 2: Corrupted database") for details.
+> To backup 99% of your configuration backup at least the `/app/config` folder. Please read the whole page (or at least "Scenario 2: Corrupted database") for details.
+> Please also note that database definitions might change over versions. The safest way is to restore your older backups into the **same version** of the app and then gradually upgarde between releases to the latest version.
 
 There are 3 artifacts that can be used to backup the application:
 
@@ -22,16 +23,17 @@ The core application configuration is in the `app.conf` file (See [Settings Syst
 - Notification settings
 - Scanner settings
 - Scheduled maintenance settings
-- UI configuration (80%)
+- UI configuration
 
 ### Core Device Data
 
-The core device data is backed up to the `devices_<timestamp>.csv` file via the [CSV Backup `CSVBCKP` Plugin](https://github.com/jokob-sk/NetAlertX/tree/main/front/plugins/csv_backup). This file contains data, such as:
+The core device data is backed up to the `devices_<timestamp>.csv` or `devices.csv` file via the [CSV Backup `CSVBCKP` Plugin](https://github.com/jokob-sk/NetAlertX/tree/main/front/plugins/csv_backup). This file contains data, such as:
 
 - Device names
-- Device Icons
-- Device Network configuration
+- Device icons
+- Device network configuration
 - Device categorization 
+- Device custom properties data
 
 ### Historical data
 
@@ -40,13 +42,13 @@ Historical data is stored in the `app.db` database (See [Database overview](http
 - Plugin objects
 - Plugin historical entries
 - History of Events, Notifications, Workflow Events
-- Presence History
+- Presence history
 
 ## 🧭 Backup strategies
 
 The safest approach to backups is to backup all of the above, by taking regular file system backups (I use [Kopia](https://github.com/kopia/kopia)). 
 
-Arguably, the most time is spent setting up the device list, so if only one file is kept I'd recommend to have a latest backup of the `devices_<timestamp>.csv` file, followed by the `app.conf` file. 
+Arguably, the most time is spent setting up the device list, so if only one file is kept I'd recommend to have a latest backup of the `devices_<timestamp>.csv` or `devices.csv` file, followed by the `app.conf` file. 
 
 ### Scenario 1: Full backup
 
@@ -54,8 +56,8 @@ End-result: Full restore
 
 #### Source artifacts:
 
-- `/db/app.db` (uncorrupted)
-- `/config/app.conf`
+- `/app/db/app.db` (uncorrupted)
+- `/app/config/app.conf`
 
 #### Recovery:
 
@@ -68,15 +70,15 @@ End-result: Partial restore (historical data & configurations from the Maintenan
 
 #### Source artifacts:
 
-- `/config/app.conf`
-- `/config/devices_<timestamp>.csv` or `/config/devices.csv`
+- `/app/config/app.conf`
+- `/app/config/devices_<timestamp>.csv` or `/app/config/devices.csv`
 
 #### Recovery:
 
 Even with a corrupted database you can recover what I would argue is 99% of the configuration. 
 
-- map the `/config/app.conf` file as described in the [Setup documentation](https://github.com/jokob-sk/NetAlertX/blob/main/dockerfiles/README.md#docker-paths).
-- rename the `devices_<timestamp>.csv` to `devices.csv` and place it in the `/config` folder
+- upload the `app.conf` file into the mounted `/app/config/` folder as described in the [Setup documentation](https://github.com/jokob-sk/NetAlertX/blob/main/dockerfiles/README.md#docker-paths).
+- rename the `devices_<timestamp>.csv` to `devices.csv` and place it in the `/app/config` folder
 - Restore the `devices.csv` backup via the [Maintenance section](https://github.com/jokob-sk/NetAlertX/blob/main/docs/DEVICES_BULK_EDITING.md)
 
 

docs/COMMUNITY_GUIDES.md

@@ -1,6 +1,6 @@
 # Community Guides
 
-Use the official installation guides at first and use community content as supplementary material. Open an issue if you'd like to add your link to the list 🙏 
+Use the official installation guides at first and use community content as supplementary material. Open an issue or PR if you'd like to add your link to the list 🙏 (Ordered by last update time)
 
 - ▶ [Home Lab Network Monitoring - Scotti-BYTE Enterprise Consulting Services](https://www.youtube.com/watch?v=0DryhzrQSJA) (July 2024)
 - 📄 [How to Install NetAlertX on Your Synology NAS - Marius hosting](https://mariushosting.com/how-to-install-pi-alert-on-your-synology-nas/) (Updated frequently)
@@ -12,5 +12,3 @@ Use the official installation guides at first and use community content as suppl
 - ▶ [Pi.Alert auf Synology & Docker by - Jürgen Barth](https://www.youtube.com/watch?v=-ouvA2UNu-A) (March 2023)
 - ▶ [Top Docker Container for Home Server Security - VirtualizationHowto](https://www.youtube.com/watch?v=tY-w-enLF6Q) (March 2023)
 - ▶ [Pi.Alert or WatchYourLAN can alert you to unknown devices appearing on your WiFi or LAN network - Danie van der Merwe](https://www.youtube.com/watch?v=v6an9QG2xF0) (November 2022)
-
-> Ordered by last update time. 

front/css/app.css

@@ -894,6 +894,7 @@ height: 50px;
 #settingsPage #add_option_NEWDEV_devOwner,
 #settingsPage #copy_icons_NEWDEV_devIcon,
 #settingsPage #add_icon_NEWDEV_devIcon,
+#settingsPage #add_option_NEWDEV_devSite,
 #settingsPage #add_option_NEWDEV_devType
 {
     display: none;

front/css/dark-patch.css

@@ -17,9 +17,9 @@ html {
   background-color: #353c42;
 }
 
-body {
+/* body {
   background-image: url('../img/boxed-bg-dark.png') !important;
-}
+} */
 
 body, .bg-yellow, .callout.callout-warning, .alert-warning, .label-warning, .modal-warning .modal-body {
 

front/css/system-dark-patch.css

@@ -19,9 +19,9 @@
     background-color: #353c42;
   }
 
-  body {
+  /* body {
     background-image: url('../img/boxed-bg-dark.png') !important;
-  }
+  } */
 
   body, .bg-yellow, .callout.callout-warning, .alert-warning, .label-warning, .modal-warning .modal-body {
 

front/deviceDetailsEdit.php

@@ -70,7 +70,7 @@
         // columns to hide
         hiddenFields = ["NEWDEV_devScan", "NEWDEV_devPresentLastScan" ]
         // columns to disable - conditional depending if a new dummy device is created
-        disabledFields =  mac == "new" ? ["NEWDEV_devLastNotification", "NEWDEV_devFirstConnection", "NEWDEV_devLastConnection"] : ["NEWDEV_devLastNotification", "NEWDEV_devFirstConnection", "NEWDEV_devLastConnection", "NEWDEV_devMac", "NEWDEV_devLastIP" ];
+        disabledFields =  mac == "new" ? ["NEWDEV_devLastNotification", "NEWDEV_devFirstConnection", "NEWDEV_devLastConnection"] : ["NEWDEV_devLastNotification", "NEWDEV_devFirstConnection", "NEWDEV_devLastConnection", "NEWDEV_devMac", "NEWDEV_devLastIP", "NEWDEV_devSyncHubNode" ];
         
         // Grouping of fields into categories with associated documentation links
         const fieldGroups = {
@@ -103,7 +103,7 @@
             },
             // Group for network details
             DevDetail_MainInfo_Network_Title: {
-                data: ["devParentMAC", "devParentPort", "devSSID", "devSite"],
+                data: ["devParentMAC", "devParentPort", "devSSID", "devSite", "devSyncHubNode"],
                 docs: "https://github.com/jokob-sk/NetAlertX/blob/main/docs/NETWORK_TREE.md",
                 iconClass: "fa fa-network-wired",
                 inputGroupClasses: "field-group col-lg-4 col-sm-6 col-xs-12",

front/multiEditCore.php

@@ -81,7 +81,7 @@
         
         settingsData = res["data"];
 
-        excludedColumns = ["NEWDEV_devMac", "NEWDEV_devFirstConnection", "NEWDEV_devLastConnection", "NEWDEV_devLastNotification", "NEWDEV_devLastIP", "NEWDEV_devStaticIP", "NEWDEV_devScan", "NEWDEV_devPresentLastScan", "NEWDEV_devCustomProps" ]
+        excludedColumns = ["NEWDEV_devMac", "NEWDEV_devFirstConnection", "NEWDEV_devLastConnection", "NEWDEV_devLastNotification", "NEWDEV_devStaticIP", "NEWDEV_devScan", "NEWDEV_devPresentLastScan", "NEWDEV_devCustomProps" ]
         
         const relevantColumns = settingsData.filter(set =>
             set.setGroup === "NEWDEV" &&

front/php/templates/footer.php

@@ -28,11 +28,10 @@
     
     <!-- To the right -->
     <div class="pull-right no-hidden-xs">
-      | <a href="https://github.com/jokob-sk/NetAlertX/tree/main/docs#documentation-overview" target="_blank">Docs <i class="fa fa-circle-question"></i></a>
-      | <a href="https://github.com/jokob-sk/NetAlertX/issues"><i class="fa-solid fa-bug"></i></a> 
-      | <a href="https://github.com/jokob-sk/NetAlertX/"><i class="fa-brands fa-github"></i></a> 
-      | <a href="https://discord.gg/UQnnHNYV"><i class="fa-brands fa-discord"></i></a> 
-      | <a href="mailto:netalertx@gmail.com?subject=NetAlertX"><i class="fa-solid fa-envelope"></i></a> 
+      | <a href="https://gurubase.io/g/netalertx" target="_blank" title="Ask AI"><i class="fa-regular fa-comment-dots fa-flip-horizontal"></i></a> 
+      | <a href="https://github.com/jokob-sk/NetAlertX/tree/main/docs#documentation-overview" target="_blank" title="Documentation"><i class="fa fa-book"></i></a>
+      | <a href="https://github.com/jokob-sk/NetAlertX/issues" target="_blank"><i class="fa-solid fa-bug" title="Report a bug"></i></a> 
+      | <a href="https://discord.com/invite/NczTUTWyRr" target="_blank"><i class="fa-brands fa-discord" title="Join Discord"></i></a> 
       | <?= lang('Maintenance_built_on');?>:  <?php include 'php/templates/build.php'; ?> 
       |  Version:  <?php include 'php/templates/version.php'; ?> 
       |     

front/plugins/icmp_scan/config.json

@@ -5,6 +5,7 @@
   "execution_order" : "Layer_4",
   "enabled": true,
   "data_source": "script",
+  "mapped_to_table": "CurrentScan",
   "show_ui": true,
   "data_filters": [
     {
@@ -130,6 +131,34 @@
         }
       ]
     },
+    {
+      "function": "IN_REGEX",
+      "type": {
+        "dataType": "string",
+        "elements": [
+          {
+            "elementType": "input",
+            "elementOptions": [],
+            "transformers": []
+          }
+        ]
+      },
+      "default_value": ".*",
+      "options": [],
+      "localized": ["name", "description"],
+      "name": [
+        {
+          "language_code": "en_us",
+          "string": "Inclusion REGEX"
+        }
+      ],
+      "description": [
+        {
+          "language_code": "en_us",
+          "string": "REGEX to specify which IPs are included in the scan. Examples: <code>192.168.1.*|10.0.0.1|172.16.5.*</code> (specific IPs or ranges). Use <code>.*</code> to include all IPs."
+        }
+      ]
+    },
     {
       "function": "RUN_SCHD",
       "type": {

front/plugins/icmp_scan/icmp.py

@@ -48,6 +48,7 @@ def main():
 
     timeout = get_setting_value('ICMP_RUN_TIMEOUT')
     args = get_setting_value('ICMP_ARGS')
+    in_regex = get_setting_value('ICMP_IN_REGEX')
  
     # Create a database connection
     db = DB()  # instance of class DB
@@ -62,9 +63,19 @@ def main():
     # Retrieve devices
     all_devices = device_handler.getAll()
 
-    mylog('verbose', [f'[{pluginName}] Devices to PING: {len(all_devices)}'])   
+    # Compile the regex for efficiency if it will be used multiple times
+    regex_pattern = re.compile(in_regex)
 
-    for device in all_devices:
+    # Filter devices based on the regex match
+    filtered_devices = [
+        device for device in all_devices 
+        if regex_pattern.match(device['devLastIP'])
+    ]
+
+
+    mylog('verbose', [f'[{pluginName}] Devices to PING: {len(filtered_devices)}'])   
+
+    for device in filtered_devices:
         is_online, output = execute_scan(device['devLastIP'], timeout, args)
 
         mylog('verbose', [f'[{pluginName}] ip: "{device['devLastIP']}" is_online: "{is_online}"'])

front/plugins/mikrotik_scan/config.json

@@ -2,7 +2,7 @@
   "code_name": "mikrotik_scan",
   "unique_prefix": "MTSCAN",
   "plugin_type": "device_scanner",
-  "execution_order" : "Layer_4",
+  "execution_order" : "Layer_1",
   "enabled": true,
   "data_source": "script",
   "mapped_to_table": "CurrentScan",
@@ -27,12 +27,6 @@
     }
   ],
   "params": [
-    {
-      "name": "ips",
-      "type": "sql",
-      "value": "SELECT devLastIP from DEVICES order by devMac",
-      "timeoutMultiplier": true
-    },
     {
       "name": "mt_host",
       "type": "setting",

front/plugins/mikrotik_scan/mikrotik.py

@@ -1,27 +1,16 @@
 #!/usr/bin/env python
 
 import os
-import pathlib
-import argparse
-import subprocess
 import sys
-import hashlib
-import csv
-import sqlite3
-import re
-from io import StringIO
-from datetime import datetime
 
 # Register NetAlertX directories
 INSTALL_PATH="/app"
 sys.path.extend([f"{INSTALL_PATH}/front/plugins", f"{INSTALL_PATH}/server"])
 
-from plugin_helper import Plugin_Object, Plugin_Objects, decodeBase64
-from logger import mylog, Logger, append_line_to_file
-from helper import timeNowTZ, get_setting_value
-from const import logPath, applicationPath, fullDbPath
-from database import DB
-from device import Device_obj
+from plugin_helper import Plugin_Objects
+from logger import mylog, Logger
+from helper import get_setting_value
+from const import logPath
 import conf
 from pytz import timezone
 from librouteros import connect
@@ -81,6 +70,7 @@ def get_entries(plugin_objects: Plugin_Objects) -> Plugin_Objects:
             comment = lease.get('comment')
             last_seen = lease.get('last-seen')
             status = lease.get('status')
+            device_name = comment or host_name or "(unknown)"
     
             mylog('verbose', [f"ID: {lease_id}, Address: {address}, MAC Address: {mac_address}, Host Name: {host_name}, Comment: {comment}, Last Seen: {last_seen}, Status: {status}"])
 
@@ -89,9 +79,9 @@ def get_entries(plugin_objects: Plugin_Objects) -> Plugin_Objects:
                     primaryId   = mac_address,
                     secondaryId = address,
                     watched1    = address,
-                    watched2    = host_name,
-                    watched3    = last_seen,
-                    watched4    = '',
+                    watched2    = device_name,
+                    watched3    = host_name,
+                    watched4    = last_seen,
                     extra       = '',
                     helpVal1    = comment, 
                     foreignKey  = mac_address)

front/plugins/newdev_template/config.json

@@ -1446,18 +1446,30 @@
     },
     {
       "function": "devSite",
+      "events": [
+        "add_option"
+      ],
       "type": {
         "dataType": "string",
         "elements": [
           {
-            "elementType": "input",
+            "elementType": "select",
             "elementOptions": [],
             "transformers": []
           }
         ]
       },
       "default_value": "",
-      "options": [],
+      "options": [
+        "{value}"
+      ],
+      "options_params": [
+        {
+          "name": "value",
+          "type": "sql",
+          "value": "SELECT DISTINCT '' AS id, '❌None' AS name UNION SELECT devSite AS id, devSite AS name FROM Devices WHERE devSite NOT IN ('', 'null') AND devSite IS NOT NULL ORDER BY id;"
+        }
+      ],
       "localized": [
         "name",
         "description"
@@ -1475,6 +1487,42 @@
         }
       ]
     },
+    {
+      "function": "devSyncHubNode",
+      "type": {
+        "dataType": "string",
+        "elements": [
+          {
+            "elementType": "input",
+            "elementOptions": [
+              {
+                "readonly": "true"
+              }
+            ],
+            "transformers": []
+          }
+        ]
+      },
+      "maxLength": 50,
+      "default_value": "",
+      "options": [],
+      "localized": [
+        "name",
+        "description"
+      ],
+      "name": [
+        {
+          "language_code": "en_us",
+          "string": "Sync Node"
+        }
+      ],
+      "description": [
+        {
+          "language_code": "en_us",
+          "string": "The name of the Sync Node. Uneditable - Auto-populated via the <a href=\"https://github.com/jokob-sk/NetAlertX/blob/main/front/plugins/sync/README.md\" target=\"_blank\">Sync plugin</a> if enabled."
+        }
+      ]
+    },
     {
       "function": "devCustomProps",
       "type": {
@@ -1488,7 +1536,7 @@
                 "columns": [
                   {
                     "settingKey": "CUSTPROP_icon",
-                    "optionsOverride":"setting.CUSTPROP_icon",
+                    "optionsOverride": "setting.CUSTPROP_icon",
                     "typeOverride": {
                       "dataType": "string",
                       "elements": [
@@ -1528,7 +1576,7 @@
                   },
                   {
                     "settingKey": "CUSTPROP_type",
-                    "optionsOverride":"setting.CUSTPROP_type",
+                    "optionsOverride": "setting.CUSTPROP_type",
                     "typeOverride": {
                       "dataType": "string",
                       "elements": [
@@ -1539,7 +1587,7 @@
                         }
                       ]
                     }
-                  },                  
+                  },
                   {
                     "settingKey": "CUSTPROP_name"
                   },

front/plugins/sync/README.md

@@ -5,11 +5,15 @@ The synchronization plugin is designed to synchronize data across multiple insta
 1. **💻 Devices**: Sends an encrypted `table_devices.json` file to synchronize the entire Devices database table.
 2. **🔌 Plugin Data**: Sends encrypted `last_result.log` files for individual plugins.
 
-> **Note:** `[n]` indicates a setting specified for the node instance, and `[n,h]` indicates a setting used on both the node and the hub instances.
+
+> [!TIP]
+> This plugin is usually used if you need to monitor inaccessible networks (WAN, VLAN etc.). Read the [Remote networks documentation](/docs/REMOTE_NETWORKS.md) for more details about these scenarios.
 
 ### Synchronization Modes
 
-The plugin operates in three different modes based on the configuration settings:
+The plugin operates in three different modes based on the configuration settings.
+
+> **Note:** `[n]` indicates a setting specified for the node instance, and `[n,h]` indicates a setting used on both the node and the hub instances.
 
 1. **Mode 1: PUSH (NODE)** - Sends data from the node to the hub.
    - This mode is activated if `SYNC_hub_url` is set and either `SYNC_devices` or `SYNC_plugins` is enabled.

front/plugins/sync/sync.py

@@ -125,8 +125,6 @@ def main():
     # Mode 2: PULL/GET (HUB)
     
     # PULLING DEVICES 
-    
-    file_dir = os.path.join(pluginsPath, 'sync')
     file_prefix = 'last_result'
     
     # pull data from nodes if specified
@@ -145,7 +143,7 @@ def main():
             log_file_name = f'{file_prefix}.{node_name}.log'
 
             # Write decoded data to log file
-            with open(os.path.join(file_dir, log_file_name), 'wb') as log_file:
+            with open(os.path.join(LOG_PATH, log_file_name), 'wb') as log_file:
                 log_file.write(decoded_data)
 
             message = f'[{pluginName}] Device data from node "{node_name}" written to {log_file_name}'
@@ -157,7 +155,7 @@ def main():
     # Create the file path
 
     # Get all "last_result" files from the sync folder, decode, rename them, and get the list of files
-    files_to_process = decode_and_rename_files(file_dir, file_prefix)
+    files_to_process = decode_and_rename_files(LOG_PATH, file_prefix)
     
     if len(files_to_process) > 0:
                 
@@ -181,11 +179,11 @@ def main():
 
                 # Store e.g. Node_1 from last_result.encoded.Node_1.1.log
                 tmp_SyncHubNodeName = ''
-                if len(file_name.split('.')) > 3:
-                    tmp_SyncHubNodeName = file_name.split('.')[2]   
+                if len(file_name.split('.')) > 2:
+                    tmp_SyncHubNodeName = file_name.split('.')[1]   
 
 
-                file_path = f"{INSTALL_PATH}/front/plugins/sync/{file_name}"
+                file_path = f"{LOG_PATH}/{file_name}"
                 
                 with open(file_path, 'r') as f:
                     data = json.load(f)
@@ -197,7 +195,7 @@ def main():
                             
                 # Rename the file to "processed_" + current name
                 new_file_name = f"processed_{file_name}"
-                new_file_path = os.path.join(file_dir, new_file_name)
+                new_file_path = os.path.join(LOG_PATH, new_file_name)
 
                 # Overwrite if the new file already exists
                 if os.path.exists(new_file_path):

front/plugins/unifi_import/script.py

@@ -213,7 +213,7 @@ def get_unifi_val(obj, key, default='null'):
                 if result not in ['','None', None, 'null']:
                     return result
     
-    mylog('debug', [f'[{pluginName}] Value not found for key "{key}" in obj "{json.dumps(obj)}"'])
+    mylog('trace', [f'[{pluginName}] Value not found for key "{key}" in obj "{json.dumps(obj)}"'])
     return default
 
 

front/settings.php

@@ -225,8 +225,15 @@ $settingsJSON_DB = json_encode($settings, JSON_HEX_TAG | JSON_HEX_AMP | JSON_HEX
 
                   pluginsData = res["data"];  
 
-                  // Sort settingsData alphabetically based on the "setGroup" property
+                  // Sort settingsData alphabetically, ensuring "General" is always first
                   settingsData.sort((a, b) => {
+                      if (a["setGroup"] === "General") {
+                          return -1; // Place "General" first
+                      }
+                      if (b["setGroup"] === "General") {
+                          return 1; // Place "General" first
+                      }
+                      // For other values, sort alphabetically
                       if (a["setGroup"] < b["setGroup"]) {
                           return -1;
                       }

install/start.debian.sh

@@ -100,6 +100,8 @@ fi
 # Create the execution_queue.log file if it doesn't exist
 touch "${INSTALL_DIR}"/log/{app.log,execution_queue.log,app_front.log,app.php_errors.log,stderr.log,stdout.log,db_is_locked.log}
 touch "${INSTALL_DIR}"/api/user_notifications.json
+# Create plugins sub-directory if it doesn't exist in case a custom log folder is used
+mkdir -p "${INSTALL_DIR}"/log/plugins
 
 # Fixing file permissions
 echo "[INSTALL] Fixing file permissions"