ESPHome: random autogenerated password

Also adds a generic mechanism for a service to have autogenerated variables
without needing any build.py.

TODO: automatically generate submenu to allow for default or custom passwords.

Author: ukkopahis

.templates/esphome/service.yml

@@ -3,6 +3,9 @@ esphome:
   image: esphome/esphome:latest
   restart: unless-stopped
   user: 0:1000
+  environment:
+    - USERNAME=admin
+    - PASSWORD=%randomPassword%
   volumes:
     - ./volumes/esphome:/config
     - /etc/localtime:/etc/localtime:ro

docs/BuildStack-RandomPassword.md

@@ -2,6 +2,11 @@
 
 This page explains how to have a service generate a random password during build time. This will require that your service have a working options menu.
 
+Alternatively, a service may just use `%randomPassword%` in a value without any
+options menu. This will generate a new random password the first time this
+service is added. The generated password may be found in the
+`docker-compose.yml`.
+
 Keep in mind that updating strings in a service's yaml config isn't limited to passwords.
 
 ## A word of caution

docs/Containers/ESPHome.md

@@ -0,0 +1,23 @@
+# ESPHome
+
+[ESPHome](https://esphome.io/) is a system to control your ESP8266/ESP32 by
+simple yet powerful configuration files and control them remotely through Home
+Automation systems.
+
+Web UI is at: `http://raspberrypi.local:6052/`
+Login username is `admin` and the password is automatically generated and can be
+found and changed in your `docker-compose.yml`.
+
+## USB serial programming from a docker-container
+
+To support flashing an ESP device directly from your RPi, `/dev/ttyUSB0` is made
+available to the container. This file usually auto-created when an
+USB-to-serial-converter is plugged in. Docker needs the file to exist when the
+container is started. This is usually handled by install.sh and menu.sh. But
+just in case this somehow fails (e.g. RPi already connected when said scripts
+are executed), just run:
+
+```
+sudo mknod -m660 /dev/ttyUSB0 c 188 0
+sudo chgrp dialout /dev/ttyUSB0
+```

docs/Default-Configs.md

@@ -16,6 +16,7 @@ Do note that the ports listed are not all of the ports containers use. They are
 | deconz         | *none*           | IOtSt4ckDec0nZ | 8090 | No |
 | diyhue         | *none*           | *none*     | 8070   | No |
 | dozzle         | *none*           | *none*     | 8080   | No |
+| esphome        | admin            | *random*   | 6052 | No |
 | espruinohub    | *none*           | *none*     | *none* | No |
 | gitea          | *none*           | *none*     | 7920   | No |
 | grafana        | *none*           | *none*     | 3000   | No |
@@ -42,3 +43,8 @@ Do note that the ports listed are not all of the ports containers use. They are
 | webthingsio_gateway | *none*      | *none*     | 4060   | No |
 | zigbee2mqtt    | *none*           | *none*     | *none* | No |
 | zigbee2mqtt_assistant | *none*    | *none* | *none* | No |
+
+Note:
+
+*random* - a random password is autogenerated. Check docker-compose.yml for what
+it actually is.

scripts/buildstack_menu.py

@@ -11,9 +11,11 @@ def main():
   import math
   import sys
   import subprocess
+  import re
   from deps.chars import specialChars, commonTopBorder, commonBottomBorder, commonEmptyLine, padText
   from deps.consts import servicesDirectory, templatesDirectory, volumesDirectory, buildCache, envFile, dockerPathOutput, servicesFileName, composeOverrideFile
   from deps.yaml_merge import mergeYaml
+  from deps.common_functions import generateRandomString
   from blessed import Terminal
   global signal
   global renderMode
@@ -52,6 +54,7 @@ def buildServices(): # TODO: Move this into a dependency so that it can be execu
     global dockerComposeServicesYaml
     try:
       runPrebuildHook()
+      replaceVariables()
       dockerFileYaml = {}
       menuStateFileYaml = {}
       dockerFileYaml["version"] = "3.6"
@@ -473,6 +476,30 @@ def runPrebuildHook():
             except:
               pass
 
+  def replaceVariables():
+    global dockerComposeServicesYaml
+
+    def replace(stringValue):
+      if "%randomPassword%" in stringValue:
+        pw = generateRandomString()
+        return re.sub(re.escape("%randomPassword%"), pw, stringValue)
+      return stringValue
+
+    def iterate(root):
+      if isinstance(root, list):
+        for key, value in enumerate(root):
+          if isinstance(value, str):
+            root[key] = replace(value)
+          else:
+            iterate(value)
+      if isinstance(root, dict):
+        for key, value in root.items():
+          if isinstance(value, str):
+            root[key] = replace(value)
+          else:
+            iterate(value)
+    iterate(dockerComposeServicesYaml)
+
   def runPostBuildHook():
     for (index, checkedMenuItem) in enumerate(checkedMenuItems):
       buildScriptPath = templatesDirectory + '/' + checkedMenuItem + '/' + buildScriptFile