Merge pull request #79 from juscghwe/main

QoL fixes
FreeTAKTeam · Feb 26, 2025 · 0db9cac · 0db9cac
2 parents 39ecd65 + 0645b7d
commit 0db9cac
Show file tree

Hide file tree

Showing 6 changed files with 55 additions and 5 deletions.
diff --git a/docs/API/.pages b/docs/API/.pages
@@ -1,4 +1,4 @@
 nav:
     - REST API:
-        - External API: REST_API_Doc.md
+        - Public API: REST_API_PublicDoc.md
         - Internal API: REST_API_InternalDoc.md
diff --git a/docs/API/REST_API_InternalDoc.md b/docs/API/REST_API_InternalDoc.md
@@ -1,9 +1,12 @@
 
 # REST API - Internal
 Internal APIs are primarily used by the FTS UI to communicate with the server. 
-See also the [REST API DOC](REST_API_Doc.md) for APIs used in integration
+See also the [REST API DOC](REST_API_PublicDoc.md) for APIs used in integration
 they may be used to create other user interfaces such as CLI.
 
+!!! Warning
+    This documentation is refering to 1.9 (deprecated). There might be changes regarding 2.x.
+
 In the current release (1.9), FTS supports following Internal API :
 
   * authenticate

diff --git a/docs/API/REST_API_Doc.md → docs/API/REST_API_PublicDoc.md b/docs/API/REST_API_Doc.md → docs/API/REST_API_PublicDoc.md
@@ -6,6 +6,9 @@ The API allows you to easily connect third parties to the TAK family,
 without the need to understand the complexity of the CoT structure or what a TCP connection is.
 FTS also supports an [Internal API](REST_API_InternalDoc.md).
 
+!!! Warning
+    This documentation is refering to 1.9 (deprecated). There might be changes regarding 2.x.
+
 ## How FTS manages the information
 
 FTS will send the  information coming through the API to all the connected clients,

diff --git a/docs/HowToHelp/WriteDocumentation.md b/docs/HowToHelp/WriteDocumentation.md
@@ -37,7 +37,8 @@ See Documentation Patterns below.
 
 ### Verify Processing
 
-The following description is only partially correct.
+!!! Warning
+    The following description is only partially correct.
 
 #### GitHub Pages
 

diff --git a/docs/Installation/mechanism/Ansible/ZeroTouchInstall.md b/docs/Installation/mechanism/Ansible/ZeroTouchInstall.md
@@ -108,10 +108,16 @@ to remember the IP address (MY_IPA) you have selected.
 ```bash
 export MY_IPA=<the appropriate IP address>
 ```
-??? example "Here is an example capturing the wired LAN address:"
+
+!!! note "Here are complete examples capturing the IP address:"
+    Wired, ethernet, RJ45
     ```bash
     export MY_IPA=$(ip -4 addr show eth0 | grep -oP '(?<=inet\s)\d+(\.\d+){3}')
     ```
+    WiFi
+    ```bash
+    export MY_IPA=$(ip -4 addr show wlan0 | grep -oP '(?<=inet\s)\d+(\.\d+){3}')
+    ```
 
 ## Run the Zero Touch Installer (ZTI)
 
@@ -251,6 +257,43 @@ it is time to make sure it is nominally working.
 * username: `admin`
 * password: `password`
 
+!!! note
+    When trying to log in for the first time, you might get a warning along the lines of `FTS Server is Not Reachable at {your IPA}`.
+    [Restarting the services](../../../administration/Operation/fts-service-mgmt.md) can help.
+
+### Node-Red issues
+
+Currently there is a know issue regarding the Node-Red integration. The following is based on the [YouTube-Video by Cßrv0 (external)](https://www.youtube.com/watch?v=Yaa1viiC6_M&t=25m0s). If you run into troubles following the text description, please refer to this video for additional help.
+
+This is due to a problem with nodeJS so we need to reinstall Node-Red at version 20:
+
+```bash
+bash <(curl -sL https://raw.githubusercontent.com/node-red/linux-installers/master/deb/update-nodejs-and-nodered) --node20
+```
+
+Accept the prompts following up depending on your needs.
+
+Finally you'll need to restart Node-Red:
+
+```bash
+sudo systemctl enable nodered.service
+sudo systemctl start nodered.service 
+```
+
+There still will be a known error regarding `worldmap` itself. To fix this you'll need to adjust the corresponding node within Node-Red.
+
+Login into Node-Red again and go to the `FTH Webdmap` flow and edit the `FTS Server` TCP node (with the woarning below). Change the properties to:
+
+```
+server: ${your IPA}
+port: 8087
+```
+
+Redeploy the flows. This should fix the issues.
+
+!!! note
+    Don't worry when your clients and COTs dont show up immediately. The worldmap needs some time to get up to date.
+
 ### Reconfiguration
 
 `ZeroTouch` will have configured the system and started the services for you. 

diff --git a/docs/Usage/VideoManagement.md b/docs/Usage/VideoManagement.md
@@ -8,4 +8,4 @@ you can:
 Additionally, 
 FTS will automatically send to all the connected clients 
 video streams information coming from FreeTAK UAS or TAK ICU 
-using the [API](../API/REST_API_Doc.md#managevideostream)
+using the [API](../API/REST_API_PublicDoc.md#managevideostream)