Add hide_api_docs config option to hide API documentation on the web UI

Debian_Dockerfile

@@ -31,8 +31,10 @@ RUN DEBIAN_FRONTEND=noninteractive apt-get update \
 
 ARG WOLWEBPORT=8089
 ARG WOLWEBVDIR=/wolweb
+ARG WOLWEBHIDEAPIDOCS=false
 ENV WOLWEBPORT=${WOLWEBPORT}
 ENV WOLWEBVDIR=${WOLWEBVDIR}
+ENV WOLWEBHIDEAPIDOCS=${WOLWEBHIDEAPIDOCS}
 
 CMD ["/wolweb/wolweb"]
 

Dockerfile

@@ -30,8 +30,10 @@ RUN apk add --no-cache curl
 
 ARG WOLWEBPORT=8089
 ARG WOLWEBVDIR=/wolweb
+ARG WOLWEBHIDEAPIDOCS=false
 ENV WOLWEBPORT=${WOLWEBPORT}
 ENV WOLWEBVDIR=${WOLWEBVDIR}
+ENV WOLWEBHIDEAPIDOCS=${WOLWEBHIDEAPIDOCS}
 
 CMD ["/wolweb/wolweb"]
 

README.md

@@ -51,6 +51,7 @@ The application will use the following default values if they are not explicitly
 | Virtual Directory | A virtual directory to mount this application under | **/wolweb**
 | Broadcast IP and Port | This is broadcast IP address and port for the local network. *Please include the port :9* | **192.168.1.255:9**
 | Read Only | If set to true, the UI will be read only | **false**
+| Hide API Docs | If set to true, the API documentation section is hidden on the web UI | **false**
 
 You can override the default application configuration by using a config file or by setting environment variables. The application will first load values from config file and look for environment variables and overwrites values from the file with the values which were found in the environment.
 
@@ -62,7 +63,8 @@ You can override the default application configuration by using a config file or
     "port": 8089,
     "vdir":"/wolweb",
     "bcastip":"192.168.1.255:9",
-    "read_only":false
+    "read_only":false,
+    "hide_api_docs":false
 }
 ```
 **Using Environment Variables:**
@@ -76,6 +78,7 @@ You can override the default application configuration by using a config file or
 | WOLWEBVDIR | Override for default virtual directory
 | WOLWEBBCASTIP | Override for broadcast IP address and port
 | WOLWEBREADONLY | Override for read only mode of UI
+| WOLWEBHIDEAPIDOCS | Override for hiding the API documentation section on the web UI
 
 ## Devices (targets) - devices.json format
 ```json

config.json

@@ -3,5 +3,6 @@
     "port": 8089,
     "vdir": "/wolweb",
     "bcastip": "192.168.1.255:9",
-    "read_only": false
+    "read_only": false,
+    "hide_api_docs": false
 }

docker-compose.yml

@@ -22,3 +22,4 @@ services:
       WOLWEBPORT: "8089"
       #WOLWEBVDIR: "/wolweb"
       WOLWEBBCASTIP: "192.168.1.255:9"
+      #WOLWEBHIDEAPIDOCS: "false"

index.html

@@ -48,6 +48,7 @@ <h3>Devices</h3>
             </div>
         </div>
         <div id="GridDevices"></div>
+        {{ if not .HideAPIDocs }}
         <hr>
         <div class="section-header">
             <h3>Wake-up directly using HTTP Requests</h3>
@@ -99,6 +100,7 @@ <h6 style="margin-top: -4px; display: flex;">
             </table>
         </div>
         <hr>
+        {{ end }}
         <p style="font-size: 13px;">
             <i class="bi bi-github" style="margin-right: 4px;"></i>
             Project Page:&nbsp;<a href="https://github.com/sameerdhoot/wolweb">https://github.com/sameerdhoot/wolweb</a>
@@ -116,11 +118,13 @@ <h6 style="margin-top: -4px; display: flex;">
         window.vDir = "{{$.VDir}}"
         window.bCastIP = "{{$.BCastIP}}"
 
+        {{ if not .HideAPIDocs }}
         $( "#code-element" ).load( "static/api-sample.txt" , function() {
             hljs.highlightAll();
         });
 
         document.getElementById("app-vdir").innerHTML = window.vDir + "/wake/"
+        {{ end }}
 
         Toast.setMaxCount(3);
         Toast.enableQueue(true);

pages.go

@@ -14,15 +14,17 @@ var indexHtml string
 func renderHomePage(w http.ResponseWriter, r *http.Request) {
 
 	pageData := struct {
-		Devices  []Device
-		VDir     string
-		BCastIP  string
-		ReadOnly bool
+		Devices     []Device
+		VDir        string
+		BCastIP     string
+		ReadOnly    bool
+		HideAPIDocs bool
 	}{
-		Devices:  appData.Devices,
-		VDir:     appConfig.VDir,
-		BCastIP:  appConfig.BCastIP,
-		ReadOnly: appConfig.ReadOnly,
+		Devices:     appData.Devices,
+		VDir:        appConfig.VDir,
+		BCastIP:     appConfig.BCastIP,
+		ReadOnly:    appConfig.ReadOnly,
+		HideAPIDocs: appConfig.HideAPIDocs,
 	}
 	if appConfig.VDir == "/" {
 		pageData.VDir = ""

types.go

@@ -26,5 +26,6 @@ type AppConfig struct {
 	Port     int    `json:"port" env:"WOLWEBPORT" env-default:"8089"`
 	VDir     string `json:"vdir" env:"WOLWEBVDIR" env-default:"/wolweb"`
 	BCastIP  string `json:"bcastip" env:"WOLWEBBCASTIP" env-default:"192.168.1.255:9"`
-	ReadOnly bool   `json:"read_only" env:"WOLWEBREADONLY" env-default:"false"`
+	ReadOnly    bool   `json:"read_only" env:"WOLWEBREADONLY" env-default:"false"`
+	HideAPIDocs bool   `json:"hide_api_docs" env:"WOLWEBHIDEAPIDOCS" env-default:"false"`
 }