homebridge-config-ui-x 5.0.0-beta.9 → 5.0.0-beta.90

package/config.schema.json

@@ -26,7 +26,7 @@
         "title": "Homebridge UI Authentication",
         "type": "string",
         "default": "form",
-        "description": "The type of authentication to use for the Homebridge UI.",
+        "description": "Whether to enable authentication for the Homebridge UI with a username and password.",
         "oneOf": [
           {
             "title": "Require Authentication",
@@ -47,12 +47,12 @@
         "title": "UI Theme",
         "description": "The theme used for the UI.",
         "type": "string",
-        "default": "auto",
+        "default": "orange",
         "oneOf": [
           {
             "title": "Orange",
             "enum": [
-              "auto"
+              "orange"
             ]
           },
           {
@@ -156,14 +156,28 @@
           }
         ]
       },
-      "restart": {
-        "title": "Custom Restart Command",
+      "menuMode": {
+        "title": "Menu Mode",
+        "description": "Modes for the UI side menu.",
         "type": "string",
-        "description": "If no restart command is set the process will terminate with a non-zero exit code.",
-        "placeholder": "eg. sudo systemctl restart homebridge"
+        "default": "default",
+        "oneOf": [
+          {
+            "title": "Default",
+            "enum": [
+              "default"
+            ]
+          },
+          {
+            "title": "Freeze",
+            "enum": [
+              "freeze"
+            ]
+          }
+        ]
       },
       "temp": {
-        "title": "Path to OS Temp File",
+        "title": "OS Temp File Path",
         "type": "string",
         "placeholder": "eg. /sys/class/thermal/thermal_zone0/temp",
         "description": "If you are running Homebridge on a Raspberry Pi, you can enter the path to the OS temp file here. This will display the current temperature on the Homebridge status page."
@@ -372,52 +386,32 @@
           }
         ]
       },
-      "loginWallpaper": {
-        "title": "Path to Login Wallpaper Image File",
+      "wallpaper": {
+        "title": "Login Wallpaper Path",
         "description": "The full path to the .jpg file.",
         "type": "string",
         "placeholder": "eg. /home/pi/mywallpaper.jpg"
       },
-      "sudo": {
-        "title": "Use Sudo",
-        "type": "boolean",
-        "description": "If you are running Homebridge as root, you may need to enable this option."
-      },
       "homebridgePackagePath": {
         "title": "Path To Homebridge Module",
         "type": "string",
         "description": "If you have multiple versions of Homebridge installed, you can specify the path to the version you want to use here.",
         "placeholder": "eg. /usr/local/lib/node_modules/homebridge"
       },
-      "noFork": {
-        "title": "Do not run the Config UI web server in a separate process/thread",
-        "type": "boolean",
-        "description": "If you are running Homebridge in a container, you may need to enable this option."
-      },
       "host": {
         "title": "Host IP Address",
         "type": "string",
         "pattern": "^[^{}/ :\\\\]+(?::\\d+)?$",
-        "description": "The host ip address to listen on. In most cases this will be '::' or '0.0.0.0'",
+        "description": "The host IP address to listen on. In most cases this will be '::' or '0.0.0.0'.",
         "placeholder": "eg. 0.0.0.0"
       },
-      "debug": {
-        "title": " Enable / disable debug level logging",
-        "type": "boolean",
-        "description": "If enabled, the Homebridge UI will log debug level messages to the console."
-      },
-      "standalone": {
-        "title": "Tell Homebridge the plugin is operating in standalone mode",
-        "type": "boolean",
-        "description": "If you are running Homebridge in a container, you may need to enable this option."
-      },
       "sessionTimeout": {
-        "title": "Session Timeout (in seconds)",
+        "title": "Session Timeout (Seconds)",
         "type": "integer",
         "placeholder": 28800,
         "minimum": 600,
         "maximum": 86400000,
-        "description": "The number of seconds before a user session will timeout. Defaults to 8 hours.",
+        "description": "The number of seconds before a user will be logged out of the UI. Defaults to 8 hours.",
         "condition": {
           "functionBody": "return model.auth === 'form'"
         }
@@ -427,83 +421,6 @@
         "title": "Log Settings",
         "description": "The log settings for the Homebridge UI.",
         "properties": {
-          "method": {
-            "title": "Log Method",
-            "type": "string",
-            "default": "",
-            "description": "The method used to read the Homebridge log file.",
-            "required": true,
-            "oneOf": [
-              {
-                "title": "Default",
-                "enum": [
-                  ""
-                ]
-              },
-              {
-                "title": "From File",
-                "enum": [
-                  "file"
-                ]
-              },
-              {
-                "title": "Systemd",
-                "enum": [
-                  "systemd"
-                ]
-              },
-              {
-                "title": "Custom Command",
-                "enum": [
-                  "custom"
-                ]
-              }
-            ]
-          },
-          "path": {
-            "title": "Log File Path",
-            "type": "string",
-            "description": "Enter the full file path to your log file.",
-            "placeholder": "/var/log/homebridge.log",
-            "required": true,
-            "condition": {
-              "functionBody": "return (model.log && model.log.method==='file')"
-            }
-          },
-          "service": {
-            "title": "Systemd Service",
-            "type": "string",
-            "description": "Enter the systemd service name. Defaults to 'homebridge'.",
-            "placeholder": "homebridge",
-            "required": true,
-            "condition": {
-              "functionBody": "return (model.log && model.log.method==='systemd')"
-            }
-          },
-          "command": {
-            "title": "Custom Command",
-            "description": "This command should stream the logs to stdout.",
-            "type": "string",
-            "placeholder": "journalctl -f -n 100 -u homebridge",
-            "required": true,
-            "condition": {
-              "functionBody": "return (model.log && model.log.method==='custom')"
-            }
-          },
-          "tail": {
-            "type": "string",
-            "description": "Depreciated",
-            "condition": {
-              "functionBody": "return (model.log && (model.log.method==='custom' || model.log.method==='systemd' || model.log.method==='file'))"
-            }
-          },
-          "systemd": {
-            "type": "string",
-            "description": "Depreciated",
-            "condition": {
-              "functionBody": "return (model.log && (model.log.method==='custom' || model.log.method==='systemd' || model.log.method==='file'))"
-            }
-          },
           "maxSize": {
             "type": "integer",
             "description": "The max log size (bytes). Set to -1 to disable log truncation.",
@@ -525,19 +442,19 @@
         "description": "The SSL settings for the Homebridge UI.",
         "properties": {
           "key": {
-            "title": "Path To Private Key",
+            "title": "Private Key Path",
             "type": "string",
             "description": "The full path to the private key file.",
             "placeholder": "eg. /Users/homebridge/.homebridge/certs/server.key"
           },
           "cert": {
-            "title": "Path To Certificate",
+            "title": "Certificate Path",
             "type": "string",
             "description": "The full path to the certificate file.",
             "placeholder": "eg. /Users/homebridge/.homebridge/certs/server.crt"
           },
           "pfx": {
-            "title": "Path To PKCS#12 Certificate",
+            "title": "PKCS#12 Certificate Path",
             "type": "string",
             "description": "The full path to the PKCS#12 certificate file.",
             "placeholder": "eg. /Users/homebridge/.homebridge/certs/server.pfx"
@@ -556,14 +473,14 @@
         "description": "The accessory control settings for the Homebridge UI.",
         "properties": {
           "debug": {
-            "title": " Enable / disable debug level logging for accessory control via the web UI",
+            "title": "Enable Accessory Control Debug Logging",
             "type": "boolean",
             "description": "If enabled, the Homebridge UI will log debug level messages to the console."
           },
           "instanceBlacklist": {
-            "title": "Blacklisted Instances",
+            "title": "Blacklisted Bridges/Instances",
             "type": "array",
-            "description": "A list of instances that should not be controlled via the web UI.",
+            "description": "A list of instances (or bridge usernames) that should not be controlled via the web UI.",
             "placeholder": "eg. 00:00:00:00:00:00",
             "items": {
               "title": "Instance Username",
@@ -600,8 +517,8 @@
         "description": "When running behind a reverse proxy you may need to enter the hostname you use to access the UI."
       },
       "scheduledBackupPath": {
-        "title": "Scheduled backup destination path",
-        "description": "The full path to where the service should save daily scheduled backups archives",
+        "title": "Scheduled Backup Destination",
+        "description": "The full path to where the service should save daily scheduled backups archives.",
         "type": "string",
         "placeholder": "eg. /home/pi/homebridge-backups",
         "condition": {
@@ -611,54 +528,16 @@
       "scheduledBackupDisable": {
         "title": "Disable Scheduled Backups",
         "type": "boolean",
-        "description": "When enabled, the Homebridge UI will not create daily scheduled backups"
+        "description": "When enabled, the Homebridge UI will not create daily scheduled backups."
       },
       "disableServerMetricsMonitoring": {
         "title": "Disable Server Metrics Monitoring",
         "type": "boolean",
-        "description": "When enabled, the Homebridge UI will not collect or report cpu / memory stats"
+        "description": "When enabled, the Homebridge UI will not collect or report CPU or memory stats."
       }
     }
   },
   "layout": [
-    {
-      "ref": "login",
-      "type": "fieldset",
-      "expandable": true,
-      "title": "Login Settings",
-      "items": [
-        "auth",
-        {
-          "key": "sessionTimeout",
-          "type": "number"
-        }
-      ]
-    },
-    {
-      "ref": "log",
-      "type": "fieldset",
-      "expandable": true,
-      "title": "Log Settings",
-      "items": [
-        "debug",
-        "log.method",
-        "log.path",
-        "log.service",
-        "log.command",
-        "log.tail",
-        "log.systemd"
-      ]
-    },
-    {
-      "ref": "logRetention",
-      "type": "fieldset",
-      "expandable": true,
-      "title": "Log Retention Settings",
-      "items": [
-        "log.maxSize",
-        "log.truncateSize"
-      ]
-    },
     {
       "ref": "accessoryControl",
       "type": "fieldset",
@@ -688,26 +567,12 @@
         "host"
       ]
     },
-    {
-      "ref": "ssl",
-      "type": "fieldset",
-      "expandable": true,
-      "title": "SSL Settings",
-      "items": [
-        "ssl.key",
-        "ssl.cert",
-        "ssl.pfx",
-        "ssl.passphrase"
-      ]
-    },
     {
       "ref": "homebridge",
       "type": "fieldset",
       "expandable": true,
       "title": "Homebridge Settings",
       "items": [
-        "sudo",
-        "restart",
         "homebridgePackagePath"
       ]
     },
@@ -728,28 +593,8 @@
             "linux.restart",
             "temp"
           ]
-        },
-        {
-          "ref": "container",
-          "type": "fieldset",
-          "expandable": true,
-          "title": "Container Settings",
-          "items": [
-            "standalone",
-            "noFork"
-          ]
         }
       ]
-    },
-    {
-      "ref": "scheduledBackup",
-      "type": "fieldset",
-      "expandable": true,
-      "title": "Scheduled Backup Settings",
-      "items": [
-        "scheduledBackupDisable",
-        "scheduledBackupPath"
-      ]
     }
   ]
 }

package/dist/bin/hb-service.d.ts

@@ -1,5 +1,5 @@
 #!/usr/bin/env node
-import type { ExtractOptions } from 'tar';
+import type { TarOptionsWithAliases } from 'tar';
 export declare class HomebridgeServiceHelper {
     action: 'install' | 'uninstall' | 'start' | 'stop' | 'restart' | 'rebuild' | 'run' | 'add' | 'remove' | 'logs' | 'view' | 'update-node' | 'before-start' | 'status';
     selfPath: string;
@@ -65,7 +65,7 @@ export declare class HomebridgeServiceHelper {
     private fixDockerPermissions;
     private checkForNodejsUpdates;
     downloadNodejs(downloadUrl: string): Promise<string>;
-    extractNodejs(targetVersion: string, extractConfig: ExtractOptions): Promise<void>;
+    extractNodejs(targetVersion: string, extractConfig: TarOptionsWithAliases): Promise<void>;
     removeNpmPackage(npmInstallPath: string): Promise<void>;
     private checkStatus;
     private parseNpmPackageString;