docs + fixes to CustomProps

2025-12-06 17:15:38 -08:00 · 2025-01-02 10:15:58 +11:00
parent 2799d3598b
commit 729c24029f
10 changed files with 113 additions and 58 deletions
--- a/README.md
+++ b/README.md
@@ -19,8 +19,8 @@ Head to [https://netalertx.com/](https://netalertx.com/) for more gifs and scree
  <summary>📷 Click for more screenshots</summary>

  | ![Main screen][main] | ![device_details 1][device_details]  | ![Screen network][network] |
-  | ![presence][presence] | ![maintenance][maintenance] | ![settings][settings]  |
  |----------------------|----------------------|----------------------|
+  | ![presence][presence] | ![maintenance][maintenance] | ![settings][settings]  |
  | ![sync_hub][sync_hub] | ![report1][report1] | ![device_nmap][device_nmap]  |

 </details>
@@ -93,8 +93,6 @@ Thank you to all the wonderful people who are sponsoring this project.

 <!-- SPONSORS-LIST DO NOT MODIFY ABOVE -->

-
-
 <details>
  <summary>Click for more ways to donate</summary>
  
--- a/dockerfiles/README.md
+++ b/dockerfiles/README.md
@@ -1,4 +1,3 @@
-[![GitHub Committed](https://img.shields.io/github/last-commit/jokob-sk/NetAlertX?color=40ba12&label=Committed&logo=GitHub&logoColor=fff&style=for-the-badge)](https://github.com/jokob-sk/NetAlertX)
 [![Docker Size](https://img.shields.io/docker/image-size/jokobsk/netalertx?label=Size&logo=Docker&color=0aa8d2&logoColor=fff&style=for-the-badge)](https://hub.docker.com/r/jokobsk/netalertx)
 [![Docker Pulls](https://img.shields.io/docker/pulls/jokobsk/netalertx?label=Pulls&logo=docker&color=0aa8d2&logoColor=fff&style=for-the-badge)](https://hub.docker.com/r/jokobsk/netalertx)
 [![GitHub Release](https://img.shields.io/github/v/release/jokob-sk/NetAlertX?color=0aa8d2&logoColor=fff&logo=GitHub&style=for-the-badge)](https://github.com/jokob-sk/NetAlertX/releases)
@@ -67,12 +66,11 @@ See alternative [docked-compose examples](https://github.com/jokob-sk/NetAlertX/
 ### Initial setup

 - If unavailable, the app generates a default `app.conf` and `app.db` file on the first run.
- The preferred way is to manage the configuration via the Settings section in the UI.
- You can modify [app.conf](https://github.com/jokob-sk/NetAlertX/tree/main/config) directly, if needed.
+- The preferred way is to manage the configuration via the Settings section in the UI, if UI is inaccessible you can modify [app.conf](https://github.com/jokob-sk/NetAlertX/tree/main/back) in the `/app/config/` folder directly 

-### Setting up scanning
+### Setting up scanners

-You have to specify which network(s) should be scanned. This is done by entering subnets that are accessible from the host. Please specify at least one valid subnet and interface in the `SCAN_SUBNETS` setting and see the documentation on [How to set up multiple SUBNETS, VLANs and what are limitations](https://github.com/jokob-sk/NetAlertX/blob/main/docs/SUBNETS.md) for troubleshooting and more advanced scenarios. 
+You have to specify which network(s) should be scanned. This is done by entering subnets that are accessible from the host. If you use the default `ARPSCAN` plugin, you have to specify at least one valid subnet and interface in the `SCAN_SUBNETS` setting. See the documentation on [How to set up multiple SUBNETS, VLANs and what are limitations](https://github.com/jokob-sk/NetAlertX/blob/main/docs/SUBNETS.md) for troubleshooting and more advanced scenarios. 

 If you are running PiHole you can synchronize devices directly. Check the [PiHole configuration guide](https://github.com/jokob-sk/NetAlertX/blob/main/docs/PIHOLE_GUIDE.md) for details. 

--- a/docs/HW_INSTALL.md
+++ b/docs/HW_INSTALL.md
@@ -5,7 +5,7 @@ To download and install NetAlertX on the hardware/server directly use the `curl`
 > [!NOTE]
 > This is an Experimental feature 🧪 and it relies on community support.
 >
-> Looking for maintainers for this installation method 🙂
+> 🙏 Looking for maintainers for this installation method 🙂
 >
 > There is no guarantee that the install script or any other script will gracefully handle other installed software.
 > Data loss is a possibility, **it is recommended to install NetAlertX using the supplied Docker image**.
@@ -36,6 +36,9 @@ Some facts about what and where something will be changed/installed by the HW in

 ## 📥 Installation via CURL

+> [!TIP]  
+> If the below fails try grabbing and installing one of the [previous releases](https://github.com/jokob-sk/NetAlertX/releases) and run the installation from the zip package.
+
 ```bash
 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
 ```
--- a/front/deviceDetailsEdit.php
+++ b/front/deviceDetailsEdit.php
@@ -358,51 +358,51 @@
    showSpinner();

     // Update data to server using POST
-$.post('php/server/devices.php?action=setDeviceData', {
-    mac: $('#NEWDEV_devMac').val(),
-    name: encodeURIComponent($('#NEWDEV_devName').val().replace(/'/g, "")),
-    owner: encodeURIComponent($('#NEWDEV_devOwner').val().replace(/'/g, "")),
-    type: $('#NEWDEV_devType').val().replace(/'/g, ""),
-    vendor: encodeURIComponent($('#NEWDEV_devVendor').val().replace(/'/g, "")),
-    icon: encodeURIComponent($('#NEWDEV_devIcon').val()),
-    favorite: ($('#NEWDEV_devFavorite')[0].checked * 1),
-    group: encodeURIComponent($('#NEWDEV_devGroup').val().replace(/'/g, "")),
-    location: encodeURIComponent($('#NEWDEV_devLocation').val().replace(/'/g, "")),
-    comments: encodeURIComponent(encodeSpecialChars($('#NEWDEV_devComments').val())),
-    networknode: $('#NEWDEV_devParentMAC').val(),
-    networknodeport: $('#NEWDEV_devParentPort').val(),
-    ssid: $('#NEWDEV_devSSID').val(),
-    networksite: $('#NEWDEV_devSite').val(),
-    staticIP: ($('#NEWDEV_devStaticIP')[0].checked * 1),
-    scancycle: "1",
-    alertevents: ($('#NEWDEV_devAlertEvents')[0].checked * 1),
-    alertdown: ($('#NEWDEV_devAlertDown')[0].checked * 1),
-    skiprepeated: $('#NEWDEV_devSkipRepeated').val().split(' ')[0],
-    newdevice: ($('#NEWDEV_devIsNew')[0].checked * 1),
-    archived: ($('#NEWDEV_devIsArchived')[0].checked * 1),
-    devFirstConnection: ($('#NEWDEV_devFirstConnection').val()),
-    devLastConnection: ($('#NEWDEV_devLastConnection').val()),
-    devCustomProps: btoa(JSON.stringify(collectTableData("#NEWDEV_devCustomProps_table"))),
-    ip: ($('#NEWDEV_devLastIP').val()),
-    createNew: createNew
-}, function(msg) {
-    showMessage(msg);
+    $.post('php/server/devices.php?action=setDeviceData', {
+        mac: $('#NEWDEV_devMac').val(),
+        name: encodeURIComponent($('#NEWDEV_devName').val().replace(/'/g, "")),
+        owner: encodeURIComponent($('#NEWDEV_devOwner').val().replace(/'/g, "")),
+        type: $('#NEWDEV_devType').val().replace(/'/g, ""),
+        vendor: encodeURIComponent($('#NEWDEV_devVendor').val().replace(/'/g, "")),
+        icon: encodeURIComponent($('#NEWDEV_devIcon').val()),
+        favorite: ($('#NEWDEV_devFavorite')[0].checked * 1),
+        group: encodeURIComponent($('#NEWDEV_devGroup').val().replace(/'/g, "")),
+        location: encodeURIComponent($('#NEWDEV_devLocation').val().replace(/'/g, "")),
+        comments: encodeURIComponent(encodeSpecialChars($('#NEWDEV_devComments').val())),
+        networknode: $('#NEWDEV_devParentMAC').val(),
+        networknodeport: $('#NEWDEV_devParentPort').val(),
+        ssid: $('#NEWDEV_devSSID').val(),
+        networksite: $('#NEWDEV_devSite').val(),
+        staticIP: ($('#NEWDEV_devStaticIP')[0].checked * 1),
+        scancycle: "1",
+        alertevents: ($('#NEWDEV_devAlertEvents')[0].checked * 1),
+        alertdown: ($('#NEWDEV_devAlertDown')[0].checked * 1),
+        skiprepeated: $('#NEWDEV_devSkipRepeated').val().split(' ')[0],
+        newdevice: ($('#NEWDEV_devIsNew')[0].checked * 1),
+        archived: ($('#NEWDEV_devIsArchived')[0].checked * 1),
+        devFirstConnection: ($('#NEWDEV_devFirstConnection').val()),
+        devLastConnection: ($('#NEWDEV_devLastConnection').val()),
+        devCustomProps: btoa(JSON.stringify(collectTableData("#NEWDEV_devCustomProps_table"))),
+        ip: ($('#NEWDEV_devLastIP').val()),
+        createNew: createNew
+    }, function(msg) {
+        showMessage(msg);

-    // Remove navigation prompt "Are you sure you want to leave..."
-    window.onbeforeunload = null;
-    somethingChanged = false;
+        // Remove navigation prompt "Are you sure you want to leave..."
+        window.onbeforeunload = null;
+        somethingChanged = false;

-    // refresh API
-    updateApi("devices,appevents");
+        // refresh API
+        updateApi("devices,appevents");

-    // Callback function
-    if (typeof refreshCallback == 'function') {
-        refreshCallback(direction);
-    }
+        // Callback function
+        if (typeof refreshCallback == 'function') {
+            refreshCallback(direction);
+        }

-    // Everything loaded
-    hideSpinner();
-});
+        // Everything loaded
+        hideSpinner();
+    });

  }

--- a/front/devices.php
+++ b/front/devices.php
@@ -897,7 +897,7 @@ function getMacsOfShownDevices() {
 function renderCustomProps(custProps, mac) {
  // Decode and parse the custom properties

-  // console.log(custProps);  
+  console.log(custProps);  

  const props = JSON.parse(atob(custProps));
  let html = "";
--- a/front/php/server/query_replace_config.php
+++ b/front/php/server/query_replace_config.php
@@ -0,0 +1,55 @@
+<?php
+
+// ---- IMPORTS ----
+//------------------------------------------------------------------------------
+// Check if authenticated
+require_once $_SERVER['DOCUMENT_ROOT'] . '/php/templates/security.php';
+// Get init.php 
+require dirname(__FILE__).'/../server/init.php';
+// ---- IMPORTS ----
+
+global $fullConfPath;
+
+//------------------------------------------------------------------------------
+// Handle incoming requests
+if ($_SERVER['REQUEST_METHOD'] === 'POST') {
+    // Access the 'config' parameter from the POST request
+    $base64Data = $_POST['config'] ?? null;
+
+    if (!$base64Data) {
+        $msg = "Missing 'config' parameter.";
+        echo $msg;
+        http_response_code(400); // Bad request
+        die($msg);
+    }
+
+    // Decode incoming base64 data
+    $input = base64_decode($base64Data, true);
+
+    if ($input === false) {
+        $msg = "Invalid base64 data.";
+        echo $msg;
+        http_response_code(400); // Bad request
+        die($msg);
+    }
+
+    // Backup the original file
+    if (file_exists($fullConfPath)) {
+        copy($fullConfPath, $fullConfPath . ".bak");
+    }
+
+    // Write the new configuration
+    $file = fopen($fullConfPath, "w");
+    if (!$file) {
+        $msg = "Unable to open file!";
+        echo $msg;
+        http_response_code(500); // Server error
+        die($msg);
+    }
+
+    fwrite($file, $input);
+    fclose($file);
+
+    echo "Configuration saved successfully.";
+}
+?>
--- a/front/php/templates/language/en_us.json
+++ b/front/php/templates/language/en_us.json
@@ -285,7 +285,7 @@
    "Events_Tablelenght": "Show _MENU_ entries",
    "Events_Tablelenght_all": "All",
    "Events_Title": "Events",
-    "GRAPHQL_PORT_description": "The port number of the GraphQL server.",
+    "GRAPHQL_PORT_description": "The port number of the GraphQL server. Make sure the port is unique across all your applications on this host and NetAlertX instances.",
    "GRAPHQL_PORT_name": "GraphQL port",
    "Gen_Action": "Action",
    "Gen_Add": "Add",
@@ -489,7 +489,7 @@
    "Maintenance_themeselector_lable": "Select Skin",
    "Maintenance_themeselector_text": "The change takes place on the server side, so it affects all devices in use.",
    "Maintenance_version": "App updates",
-    "NETWORK_DEVICE_TYPES_description": "Which device types are allowed to be used as network devices in the Network view. The device type has to match exactly the <code>Type</code> setting on a specific device in Device details. Do not remove existing types, only add new ones.",
+    "NETWORK_DEVICE_TYPES_description": "Which device types are allowed to be used as network devices in the Network view. The device type has to match exactly the <code>Type</code> setting on a specific device in Device details. Add it on teh Device via the <code>+</code> button. Do not remove existing types, only add new ones.",
    "NETWORK_DEVICE_TYPES_name": "Network device types",
    "Navigation_About": "About",
    "Navigation_Devices": "Devices",
--- a/front/plugins/newdev_template/config.json
+++ b/front/plugins/newdev_template/config.json
@@ -716,7 +716,7 @@
      "description": [
        {
          "language_code": "en_us",
-          "string": "The type of the device."
+          "string": "The type of the device. Custom Network device types from the <code>NETWORK_DEVICE_TYPES</code> setting are not automatically added, you need to add it via the <code>+</code> button onthe device itself."
        }
      ]
    },
@@ -1330,7 +1330,7 @@
      "description": [
        {
          "language_code": "en_us",
-          "string": "Indicates whether the device is archived. The default value of the <code>Archived</code> checkbox."
+          "string": "Indicates whether the device is archived. If you archive a device and the device is offline it will be hidden from My Devices."
        }
      ]
    },
--- a/server/graphql_server/graphql_server_start.py
+++ b/server/graphql_server/graphql_server_start.py
@@ -32,8 +32,9 @@ def graphql_endpoint():
    api_token_value = get_setting_value("API_TOKEN")

    if incoming_header_token != f"Bearer {api_token_value}":
-        mylog('verbose', [f'[graphql_server] Unauthorized access attempt'])
-        return jsonify({"error": "Unauthorized"}), 401
+        msg = '[graphql_server] Unauthorized access attempt - make sure your GRAPHQL_PORT and API_TOKEN settings are correct.'
+        mylog('verbose', [msg])
+        return jsonify({"error": msg}), 401

    # Retrieve and log request data
    data = request.get_json()
--- a/server/helper.py
+++ b/server/helper.py
@@ -365,7 +365,7 @@ def setting_value_to_python_type(set_type, set_value):
    transformers    = element_with_input_value.get('transformers', [])

    # Convert value based on dataType and elementType
-    if dataType == 'string' and elementType in ['input', 'select', 'textarea']:
+    if dataType == 'string' and elementType in ['input', 'select', 'textarea', 'datatable']:
        value = reverseTransformers(str(set_value), transformers)

    elif dataType == 'integer' and (elementType == 'input' or elementType == 'select'):