Added documentation link to build option menus.

jstudioo · Nov 13, 2020 · 0898c74 · 0898c74
1 parent fd37cb8
commit 0898c74
Show file tree

Hide file tree

Showing 20 changed files with 223 additions and 51 deletions.
diff --git a/.templates/adminer/build.py b/.templates/adminer/build.py
@@ -13,7 +13,7 @@ def main():
   import sys
   from blessed import Terminal
 
-  from deps.chars import specialChars, commonTopBorder, commonBottomBorder, commonEmptyLine
+  from deps.chars import specialChars, commonTopBorder, commonBottomBorder, commonEmptyLine, padText
   from deps.consts import servicesDirectory, templatesDirectory
   from deps.common_functions import getExternalPorts, getInternalPorts, checkPortConflicts, enterPortNumberWithWhiptail
 
@@ -33,6 +33,8 @@ def main():
   except:
     hideHelpText = False
 
+  documentationHint = 'https://sensorsiot.github.io/IOTstack/Containers/Adminer'
+
   # runtime vars
   portConflicts = []
 
@@ -213,6 +215,15 @@ def mainRender(needsRender, menu, selection):
         print(term.center("{bv}      [Enter] to run command or save input                                      {bv}".format(bv=specialChars[renderMode]["borderVertical"])))
         print(term.center("{bv}      [Escape] to go back to build stack menu                                   {bv}".format(bv=specialChars[renderMode]["borderVertical"])))
         print(term.center(commonEmptyLine(renderMode)))
+        if len(documentationHint) > 1:
+          if len(documentationHint) > 56:
+            documentationAndPadding = padText(documentationHint, 71)
+            print(term.center("{bv}      Documentation:                                                            {bv}".format(bv=specialChars[renderMode]["borderVertical"])))
+            print(term.center("{bv}        {dap} {bv}".format(bv=specialChars[renderMode]["borderVertical"], dap=documentationAndPadding)))
+          else:
+            documentationAndPadding = padText(documentationHint, 56)
+            print(term.center("{bv}        Documentation: {dap} {bv}".format(bv=specialChars[renderMode]["borderVertical"], dap=documentationAndPadding)))
+          print(term.center(commonEmptyLine(renderMode)))
       print(term.center(commonEmptyLine(renderMode)))
       print(term.center(commonBottomBorder(renderMode)))
 

diff --git a/.templates/blynk_server/build.py b/.templates/blynk_server/build.py
@@ -14,7 +14,7 @@ def main():
   import sys
   from blessed import Terminal
 
-  from deps.chars import specialChars, commonTopBorder, commonBottomBorder, commonEmptyLine
+  from deps.chars import specialChars, commonTopBorder, commonBottomBorder, commonEmptyLine, padText
   from deps.consts import servicesDirectory, templatesDirectory
   from deps.common_functions import getExternalPorts, getInternalPorts, checkPortConflicts, enterPortNumberWithWhiptail
 
@@ -38,6 +38,8 @@ def main():
   except:
     hideHelpText = False
 
+  documentationHint = 'https://sensorsiot.github.io/IOTstack/Containers/Blynk_server'
+
   # runtime vars
   portConflicts = []
 
@@ -225,6 +227,15 @@ def mainRender(needsRender, menu, selection):
         print(term.center("{bv}      [Enter] to run command or save input                                      {bv}".format(bv=specialChars[renderMode]["borderVertical"])))
         print(term.center("{bv}      [Escape] to go back to build stack menu                                   {bv}".format(bv=specialChars[renderMode]["borderVertical"])))
         print(term.center(commonEmptyLine(renderMode)))
+        if len(documentationHint) > 1:
+          if len(documentationHint) > 56:
+            documentationAndPadding = padText(documentationHint, 71)
+            print(term.center("{bv}      Documentation:                                                            {bv}".format(bv=specialChars[renderMode]["borderVertical"])))
+            print(term.center("{bv}        {dap} {bv}".format(bv=specialChars[renderMode]["borderVertical"], dap=documentationAndPadding)))
+          else:
+            documentationAndPadding = padText(documentationHint, 56)
+            print(term.center("{bv}        Documentation: {dap} {bv}".format(bv=specialChars[renderMode]["borderVertical"], dap=documentationAndPadding)))
+          print(term.center(commonEmptyLine(renderMode)))
       print(term.center(commonEmptyLine(renderMode)))
       print(term.center(commonBottomBorder(renderMode)))
 

diff --git a/.templates/grafana/build.py b/.templates/grafana/build.py
@@ -9,7 +9,7 @@ def main():
   import os
   import time
   from blessed import Terminal
-  from deps.chars import specialChars, commonTopBorder, commonBottomBorder, commonEmptyLine
+  from deps.chars import specialChars, commonTopBorder, commonBottomBorder, commonEmptyLine, padText
   from deps.consts import servicesDirectory, templatesDirectory, volumesDirectory
   from deps.common_functions import getExternalPorts, getInternalPorts, checkPortConflicts, enterPortNumberWithWhiptail
 
@@ -31,6 +31,8 @@ def main():
   except:
     hideHelpText = False
 
+  documentationHint = 'https://sensorsiot.github.io/IOTstack/Containers/Adminer'
+
   # This lets the menu know whether to put " >> Options " or not
   # This function is REQUIRED.
   def checkForOptionsHook():
@@ -204,6 +206,15 @@ def mainRender(needsRender, menu, selection):
         print(term.center("{bv}      [Enter] to run command or save input                                      {bv}".format(bv=specialChars[renderMode]["borderVertical"])))
         print(term.center("{bv}      [Escape] to go back to build stack menu                                   {bv}".format(bv=specialChars[renderMode]["borderVertical"])))
         print(term.center(commonEmptyLine(renderMode)))
+        if len(documentationHint) > 1:
+          if len(documentationHint) > 56:
+            documentationAndPadding = padText(documentationHint, 71)
+            print(term.center("{bv}      Documentation:                                                            {bv}".format(bv=specialChars[renderMode]["borderVertical"])))
+            print(term.center("{bv}        {dap} {bv}".format(bv=specialChars[renderMode]["borderVertical"], dap=documentationAndPadding)))
+          else:
+            documentationAndPadding = padText(documentationHint, 56)
+            print(term.center("{bv}        Documentation: {dap} {bv}".format(bv=specialChars[renderMode]["borderVertical"], dap=documentationAndPadding)))
+          print(term.center(commonEmptyLine(renderMode)))
       print(term.center(commonEmptyLine(renderMode)))
       print(term.center(commonBottomBorder(renderMode)))
 

diff --git a/.templates/home_assistant/build.py b/.templates/home_assistant/build.py
@@ -13,7 +13,7 @@ def main():
   import sys
   from blessed import Terminal
 
-  from deps.chars import specialChars, commonTopBorder, commonBottomBorder, commonEmptyLine
+  from deps.chars import specialChars, commonTopBorder, commonBottomBorder, commonEmptyLine, padText
   from deps.consts import servicesDirectory, templatesDirectory
   from deps.common_functions import getExternalPorts, getInternalPorts, checkPortConflicts, enterPortNumberWithWhiptail
 
@@ -36,6 +36,8 @@ def main():
   except:
     hideHelpText = False
 
+  documentationHint = 'https://sensorsiot.github.io/IOTstack/Containers/Home-Assistant'
+
   # runtime vars
   portConflicts = []
 
@@ -216,6 +218,15 @@ def mainRender(needsRender, menu, selection):
         print(term.center("{bv}      [Enter] to run command or save input                                      {bv}".format(bv=specialChars[renderMode]["borderVertical"])))
         print(term.center("{bv}      [Escape] to go back to build stack menu                                   {bv}".format(bv=specialChars[renderMode]["borderVertical"])))
         print(term.center(commonEmptyLine(renderMode)))
+        if len(documentationHint) > 1:
+          if len(documentationHint) > 56:
+            documentationAndPadding = padText(documentationHint, 71)
+            print(term.center("{bv}      Documentation:                                                            {bv}".format(bv=specialChars[renderMode]["borderVertical"])))
+            print(term.center("{bv}        {dap} {bv}".format(bv=specialChars[renderMode]["borderVertical"], dap=documentationAndPadding)))
+          else:
+            documentationAndPadding = padText(documentationHint, 56)
+            print(term.center("{bv}        Documentation: {dap} {bv}".format(bv=specialChars[renderMode]["borderVertical"], dap=documentationAndPadding)))
+          print(term.center(commonEmptyLine(renderMode)))
       print(term.center(commonEmptyLine(renderMode)))
       print(term.center(commonBottomBorder(renderMode)))
 

diff --git a/.templates/influxdb/build.py b/.templates/influxdb/build.py
@@ -14,7 +14,7 @@ def main():
   import subprocess
   from blessed import Terminal
 
-  from deps.chars import specialChars, commonTopBorder, commonBottomBorder, commonEmptyLine
+  from deps.chars import specialChars, commonTopBorder, commonBottomBorder, commonEmptyLine, padText
   from deps.consts import servicesDirectory, templatesDirectory, servicesFileName, buildSettingsFileName
   from deps.common_functions import getExternalPorts, checkPortConflicts, generateRandomString
 
@@ -39,6 +39,8 @@ def main():
   except:
     hideHelpText = False
 
+  documentationHint = 'https://sensorsiot.github.io/IOTstack/Containers/InfluxDB'
+
   # runtime vars
   portConflicts = []
 
@@ -290,6 +292,15 @@ def mainRender(needsRender, menu, selection):
         print(term.center("{bv}      [Enter] to run command or save input                                      {bv}".format(bv=specialChars[renderMode]["borderVertical"])))
         print(term.center("{bv}      [Escape] to go back to build stack menu                                   {bv}".format(bv=specialChars[renderMode]["borderVertical"])))
         print(term.center(commonEmptyLine(renderMode)))
+        if len(documentationHint) > 1:
+          if len(documentationHint) > 56:
+            documentationAndPadding = padText(documentationHint, 71)
+            print(term.center("{bv}      Documentation:                                                            {bv}".format(bv=specialChars[renderMode]["borderVertical"])))
+            print(term.center("{bv}        {dap} {bv}".format(bv=specialChars[renderMode]["borderVertical"], dap=documentationAndPadding)))
+          else:
+            documentationAndPadding = padText(documentationHint, 56)
+            print(term.center("{bv}        Documentation: {dap} {bv}".format(bv=specialChars[renderMode]["borderVertical"], dap=documentationAndPadding)))
+          print(term.center(commonEmptyLine(renderMode)))
       print(term.center(commonEmptyLine(renderMode)))
       print(term.center(commonBottomBorder(renderMode)))
 

diff --git a/.templates/influxdb/service.yml b/.templates/influxdb/service.yml
@@ -9,8 +9,8 @@
     environment:
       - INFLUXDB_REPORTING_DISABLED=false
       - INFLUXDB_HTTP_AUTH_ENABLED=false
-      - INFLUX_USERNAME=influxadminuser
-      - INFLUX_PASSWORD=%randomPassword%
+    #  - INFLUX_USERNAME=influxadminuser
+    #  - INFLUX_PASSWORD=%randomPassword%
     #  - INFLUXDB_UDP_ENABLED=false
     #  - INFLUXDB_UDP_BIND_ADDRESS=0.0.0.0:8086
     #  - INFLUXDB_UDP_DATABASE=udp

diff --git a/.templates/mariadb/build.py b/.templates/mariadb/build.py
@@ -14,7 +14,7 @@ def main():
   import subprocess
   from blessed import Terminal
 
-  from deps.chars import specialChars, commonTopBorder, commonBottomBorder, commonEmptyLine
+  from deps.chars import specialChars, commonTopBorder, commonBottomBorder, commonEmptyLine, padText
   from deps.consts import servicesDirectory, templatesDirectory, servicesFileName, buildSettingsFileName
   from deps.common_functions import getExternalPorts, checkPortConflicts, generateRandomString
 
@@ -39,6 +39,8 @@ def main():
   except:
     hideHelpText = False
 
+  documentationHint = 'https://sensorsiot.github.io/IOTstack/Containers/MariaDB'
+
   # runtime vars
   portConflicts = []
 
@@ -295,6 +297,15 @@ def mainRender(needsRender, menu, selection):
         print(term.center("{bv}      [Enter] to run command or save input                                      {bv}".format(bv=specialChars[renderMode]["borderVertical"])))
         print(term.center("{bv}      [Escape] to go back to build stack menu                                   {bv}".format(bv=specialChars[renderMode]["borderVertical"])))
         print(term.center(commonEmptyLine(renderMode)))
+        if len(documentationHint) > 1:
+          if len(documentationHint) > 56:
+            documentationAndPadding = padText(documentationHint, 71)
+            print(term.center("{bv}      Documentation:                                                            {bv}".format(bv=specialChars[renderMode]["borderVertical"])))
+            print(term.center("{bv}        {dap} {bv}".format(bv=specialChars[renderMode]["borderVertical"], dap=documentationAndPadding)))
+          else:
+            documentationAndPadding = padText(documentationHint, 56)
+            print(term.center("{bv}        Documentation: {dap} {bv}".format(bv=specialChars[renderMode]["borderVertical"], dap=documentationAndPadding)))
+          print(term.center(commonEmptyLine(renderMode)))
       print(term.center(commonEmptyLine(renderMode)))
       print(term.center(commonBottomBorder(renderMode)))
 

diff --git a/.templates/mosquitto/build.py b/.templates/mosquitto/build.py
@@ -33,6 +33,8 @@ def main():
   except:
     hideHelpText = False
 
+  # documentationHint = 'https://sensorsiot.github.io/IOTstack/Containers/Mosquitto'
+
   # runtime vars
   portConflicts = []
 

diff --git a/.templates/motioneye/build.py b/.templates/motioneye/build.py
@@ -13,7 +13,7 @@ def main():
   import sys
   from blessed import Terminal
 
-  from deps.chars import specialChars, commonTopBorder, commonBottomBorder, commonEmptyLine
+  from deps.chars import specialChars, commonTopBorder, commonBottomBorder, commonEmptyLine, padText
   from deps.consts import servicesDirectory, templatesDirectory
   from deps.common_functions import getExternalPorts, getInternalPorts, checkPortConflicts, enterPortNumberWithWhiptail
 
@@ -37,6 +37,8 @@ def main():
   except:
     hideHelpText = False
 
+  documentationHint = 'https://sensorsiot.github.io/IOTstack/Containers/MotionEye'
+
   # runtime vars
   portConflicts = []
 
@@ -229,6 +231,15 @@ def mainRender(needsRender, menu, selection):
         print(term.center("{bv}      [Enter] to run command or save input                                      {bv}".format(bv=specialChars[renderMode]["borderVertical"])))
         print(term.center("{bv}      [Escape] to go back to build stack menu                                   {bv}".format(bv=specialChars[renderMode]["borderVertical"])))
         print(term.center(commonEmptyLine(renderMode)))
+        if len(documentationHint) > 1:
+          if len(documentationHint) > 56:
+            documentationAndPadding = padText(documentationHint, 71)
+            print(term.center("{bv}      Documentation:                                                            {bv}".format(bv=specialChars[renderMode]["borderVertical"])))
+            print(term.center("{bv}        {dap} {bv}".format(bv=specialChars[renderMode]["borderVertical"], dap=documentationAndPadding)))
+          else:
+            documentationAndPadding = padText(documentationHint, 56)
+            print(term.center("{bv}        Documentation: {dap} {bv}".format(bv=specialChars[renderMode]["borderVertical"], dap=documentationAndPadding)))
+          print(term.center(commonEmptyLine(renderMode)))
       print(term.center(commonEmptyLine(renderMode)))
       print(term.center(commonBottomBorder(renderMode)))
 

diff --git a/.templates/nextcloud/build.py b/.templates/nextcloud/build.py
@@ -14,7 +14,7 @@ def main():
   import subprocess
 
   from blessed import Terminal
-  from deps.chars import specialChars, commonTopBorder, commonBottomBorder, commonEmptyLine
+  from deps.chars import specialChars, commonTopBorder, commonBottomBorder, commonEmptyLine, padText
   from deps.consts import servicesDirectory, templatesDirectory, volumesDirectory, buildSettingsFileName, buildCache, servicesFileName
   from deps.common_functions import getExternalPorts, getInternalPorts, checkPortConflicts, enterPortNumberWithWhiptail, generateRandomString
 
@@ -40,6 +40,8 @@ def main():
   except:
     hideHelpText = False
 
+  documentationHint = 'https://sensorsiot.github.io/IOTstack/Containers/NextCloud'
+
   # runtime vars
   portConflicts = []
 
@@ -328,6 +330,15 @@ def mainRender(needsRender, menu, selection):
         print(term.center("{bv}      [Enter] to run command or save input                                      {bv}".format(bv=specialChars[renderMode]["borderVertical"])))
         print(term.center("{bv}      [Escape] to go back to build stack menu                                   {bv}".format(bv=specialChars[renderMode]["borderVertical"])))
         print(term.center(commonEmptyLine(renderMode)))
+        if len(documentationHint) > 1:
+          if len(documentationHint) > 56:
+            documentationAndPadding = padText(documentationHint, 71)
+            print(term.center("{bv}      Documentation:                                                            {bv}".format(bv=specialChars[renderMode]["borderVertical"])))
+            print(term.center("{bv}        {dap} {bv}".format(bv=specialChars[renderMode]["borderVertical"], dap=documentationAndPadding)))
+          else:
+            documentationAndPadding = padText(documentationHint, 56)
+            print(term.center("{bv}        Documentation: {dap} {bv}".format(bv=specialChars[renderMode]["borderVertical"], dap=documentationAndPadding)))
+          print(term.center(commonEmptyLine(renderMode)))
       print(term.center(commonEmptyLine(renderMode)))
       print(term.center(commonBottomBorder(renderMode)))
 

diff --git a/.templates/nodered/build.py b/.templates/nodered/build.py
@@ -12,7 +12,7 @@ def main():
   import signal
   import sys
   from blessed import Terminal
-  from deps.chars import specialChars, commonTopBorder, commonBottomBorder, commonEmptyLine
+  from deps.chars import specialChars, commonTopBorder, commonBottomBorder, commonEmptyLine, padText
   from deps.consts import servicesDirectory, templatesDirectory
   from deps.common_functions import getExternalPorts, getInternalPorts, checkPortConflicts, enterPortNumberWithWhiptail
 
@@ -34,6 +34,8 @@ def main():
   except:
     hideHelpText = False
 
+  documentationHint = 'https://sensorsiot.github.io/IOTstack/Containers/Node-RED'
+
   yaml = ruamel.yaml.YAML()
   yaml.preserve_quotes = True
 
@@ -296,6 +298,15 @@ def mainRender(needsRender, menu, selection):
         print(term.center("{bv}      [Enter] to run command or save input                                      {bv}".format(bv=specialChars[renderMode]["borderVertical"])))
         print(term.center("{bv}      [Escape] to go back to build stack menu                                   {bv}".format(bv=specialChars[renderMode]["borderVertical"])))
         print(term.center(commonEmptyLine(renderMode)))
+        if len(documentationHint) > 1:
+          if len(documentationHint) > 56:
+            documentationAndPadding = padText(documentationHint, 71)
+            print(term.center("{bv}      Documentation:                                                            {bv}".format(bv=specialChars[renderMode]["borderVertical"])))
+            print(term.center("{bv}        {dap} {bv}".format(bv=specialChars[renderMode]["borderVertical"], dap=documentationAndPadding)))
+          else:
+            documentationAndPadding = padText(documentationHint, 56)
+            print(term.center("{bv}        Documentation: {dap} {bv}".format(bv=specialChars[renderMode]["borderVertical"], dap=documentationAndPadding)))
+          print(term.center(commonEmptyLine(renderMode)))
       print(term.center(commonEmptyLine(renderMode)))
       print(term.center(commonBottomBorder(renderMode)))