Skip to content

Commit

Permalink
Dokumentation updates
Browse files Browse the repository at this point in the history
  • Loading branch information
@msinn
msinn committed Jan 9, 2024
1 parent 87acd50 commit 6b9d3cf
Show file tree
Hide file tree
Showing 4 changed files with 110 additions and 62 deletions.
59 changes: 40 additions & 19 deletions doc/user/source/konfiguration/module/module_admin.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,17 @@ Datei *../etc/module.yaml*
# etc/module.yaml
admin:
module_name: admin
# login_expiration: 168
# pypi_timeout: 5
# itemtree_fullpath: True
# itemtree_searchstart: 3
# login_expiration: 168
# login_autorenew: True
# pypi_timeout: 5
# itemtree_fullpath: True
# itemtree_searchstart: 3
# websocket_host: smarthomeng.local
# websocket_port: 2424
# log_chunksize: 1000
# developer_mode: False
# rest_dispatch_force_exception: False
# click_dropdown_header: False
.. note::
Expand All @@ -41,19 +48,33 @@ Datei *../etc/module.yaml*
Administrations-Interface geändert werden.


+-------------------------+------------------------------------------------------------------------------------------------------+
| Parameter | Bemerkung |
+=========================+======================================================================================================+
| login_expiration | **Optional**: Gültigkeitsdauer des Tokens nach einem Login in Stunden (Nachkommastellen können |
| | angegeben werden). Standard ist 168 -> eine Woche |
+-------------------------+------------------------------------------------------------------------------------------------------+
| pypi_timeout | **Optional**: Anzahl Sekunden die auf eine Antwort von pypi.org gewartet wird. |
+-------------------------+------------------------------------------------------------------------------------------------------+
| itemtree_fullpath | **Optional**: Falls dieser Parameter auf **True** gesetzt wird, werden auf der Item Seite im Tree |
| | Items mit vollem Pfad angezeigt, fallse der Wert auf **False** gesetzt wird, wird die Kurzform |
| | verwendet. |
+-------------------------+------------------------------------------------------------------------------------------------------+
| itemtree_searchstart | **Optional**: Anzahl Zeichen die eingegeben sein muss, damit die Suche im Itemtree startet. |
| | Standardmäßig wird nach der Eingabe des dritten Zeichens mit der Suche begonnen. |
+-------------------------+------------------------------------------------------------------------------------------------------+
+-------------------------------+------------------------------------------------------------------------------------------------+
| Parameter | Bemerkung |
+===============================+================================================================================================+
| login_expiration | **Optional**: Gültigkeitsdauer des Tokens nach einem Login in Stunden (Nachkommastellen |
| | können angegeben werden). Standard ist 168 -> eine Woche |
+-------------------------------+------------------------------------------------------------------------------------------------+
| login_autorenew | **Optional**: Bestehendes Login-Token automatisch verlängern. |
+-------------------------------+------------------------------------------------------------------------------------------------+
| pypi_timeout | **Optional**: Anzahl Sekunden die auf eine Antwort von pypi.org gewartet wird. |
+-------------------------------+------------------------------------------------------------------------------------------------+
| itemtree_fullpath | **Optional**: Falls dieser Parameter auf **True** gesetzt wird, werden auf der Item Seite im |
| | Tree Items mit vollem Pfad angezeigt, fallse der Wert auf **False** gesetzt wird, wird die |
| | Kurzform verwendet. |
+-------------------------------+------------------------------------------------------------------------------------------------+
| itemtree_searchstart | **Optional**: Anzahl Zeichen die eingegeben sein muss, damit die Suche im Itemtree startet. |
| | Standardmäßig wird nach der Eingabe des dritten Zeichens mit der Suche begonnen. |
+-------------------------------+------------------------------------------------------------------------------------------------+
| websocket_host | **Optional**: IP Adresse für den websocket Zugriff. |
+-------------------------------+------------------------------------------------------------------------------------------------+
| websocket_port | **Optional**: Port der für den Websocket Zugriff verwendet wird. |
+-------------------------------+------------------------------------------------------------------------------------------------+
| log_chunksize | **Optional**: Größe der gelesenen Blöcke bei der Anzeige großer Logdateien. |
+-------------------------------+------------------------------------------------------------------------------------------------+
| developer_mode | **Optional**: Entwickler Modus aktivieren (Ist für das Core Entwickler Team gedacht). |
+-------------------------------+------------------------------------------------------------------------------------------------+
| rest_dispatch_force_exception | **Optional**: Sollen WARNINGs aus REST_dispatch_execute als EXECPTION geloggt werden? |
+-------------------------------+------------------------------------------------------------------------------------------------+
| click_dropdown_header | **Optional**: Click auf Kopfeintrag von Dropdown Menüs erlauben. |
+-------------------------------+------------------------------------------------------------------------------------------------+

103 changes: 64 additions & 39 deletions doc/user/source/konfiguration/module/module_http.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -40,21 +40,26 @@ Datei *../etc/module.yaml*
# etc/module.yaml
http:
module_name: http
# starturl: backend
# threads: 8
# showtraceback: False
# showpluginlist: True
# webif_pagelength: 0
# port: 8383
# user: admin
# password: geheim
# hashed_password: 1245a9633edf47b7091f37c4d294b5be5a9936c81c5359b16d1c4833729965663f1943ef240959c53803fedef7ac19bd59c66ad7e7092d7dbf155ce45884607d
# servicesport: 8384
# service_user: serviceuser
# service_password: geheim
# service_hashed_password: 1245a9633edf47b7091f37c4d294b5be5a9936c81c5359b16d1c4833729965663f1943ef240959c53803fedef7ac19bd59c66ad7e7092d7dbf155ce45884607d
# connectionretries: 5
# user: admin
# password: geheim
# hashed_password: 1245a9633edf47b7091f37c4d294b5be5a9936c81c5359b16d1c4833729965663f1943ef240959c53803fedef7ac19bd59c66ad7e7092d7dbf155ce45884607d
# service_user: serviceuser
# service_password: geheim
# service_hashed_password: 1245a9633edf47b7091f37c4d294b5be5a9936c81c5359b16d1c4833729965663f1943ef240959c53803fedef7ac19bd59c66ad7e7092d7dbf155ce45884607d
# ip: ''
# port: 8383
# tls_port: 8385
# use_tls: False
# tls_cert: shng.cer
# tls_key: shng.key
# port: 8384
# showpluginlist: True
# showservicelist: False
# starturl: backend
# threads: 8
# showtraceback: False
# webif_pagelength: 0
.. note::
Expand All @@ -67,26 +72,7 @@ Datei *../etc/module.yaml*
+-------------------------+------------------------------------------------------------------------------------------------------+
| Parameter | Bemerkung |
+=========================+======================================================================================================+
| starturl | **Optional**: Wenn **starturl** auf den Namen eines geladenen Plugins gesetzt ist, wird beim Aufruf |
| | von http://smarthomeNG.local:8383/ auf dieses Plugin weitergeleitet, statt auf die Übersichtsseite. |
| | Wenn z.B. standardmäßig das Backend Plugin aufgerufen werden soll, muss ``starturl: backend`` |
| | gesetzt werden. Die Übersichtsseite ist weiterhin unter http://smarthomeNG.local:8383/plugins/ |
| | erreichbar. |
+-------------------------+------------------------------------------------------------------------------------------------------+
| threads | **Optional**: Die Anzahl der Threads, die CherryPy für jeden Port startet, auf dem es lauscht. |
| | Default ist 8, was für leistungsschwächere CPUs zu viel sein kann |
+-------------------------+------------------------------------------------------------------------------------------------------+
| showtraceback | **Optional**: Falls dieser Parameter auf **True** gesetzt wird, zeigen Fehlerseiten (außer Fehler |
| | bei 404) einen Python Fehler-Trace an. Normalerweise wird dieser Trace nur im **smarthome.log** |
| | aufgezeichnet. |
+-------------------------+------------------------------------------------------------------------------------------------------+
| showpluginlist | **Optional**: Falls der Parameter auf **False** gesetzt wird, wird unter |
| | **http://smarthomeNG.local:8383/plugins** keine Liste der geladenen Plugins mit Web Interface |
| | gezeigt. Dann ist der Zugriff auf die Webinterfaces nur direkt über die jeweilige Url oder über die |
| | Seite **Plugins** im Backend möglich. **showpluginlist** ist standardmäßig **True**. |
+-------------------------+------------------------------------------------------------------------------------------------------+
| port | **Optional**: Der Port auf welchem das html Interface lauscht. Dieser Port wird für Webinterfaces |
| | wie z.B. das Backend Plugin genutzt- Standard Port ist **8383** . |
| connectionretries | Maximale Anzahl an Verbindungsversuchen zum Start von smarthomeNG, um die lokale IP zu eruieren. |
+-------------------------+------------------------------------------------------------------------------------------------------+
| user | **Optional**: Der Benutzername mit dem man sich zur Nutzung der Webinterfaces authentifizieren muss. |
| | Der Standardwert ist **admin** |
Expand All @@ -102,10 +88,6 @@ Datei *../etc/module.yaml*
| | SHA-512-Hash-Wert des Passworts. Um den Hash für das Passwort zu erstellen, kann die Funktion |
| | **Passwort-Hash erzeugen** auf der Seite **Dienste** im Backend verwendet werden. |
+-------------------------+------------------------------------------------------------------------------------------------------+
| serviceport | **Optional**: Der Port auf welchem das html Interface lauscht. Dieser Port wird für den Zugriff |
| | auf Webservices genutzt, wie ihn z.B. das Plugin Webservices zur Verfügung stellt. Standard Port |
| | ist **8384** . |
+-------------------------+------------------------------------------------------------------------------------------------------+
| service_user | **Optional**: Der Benutzername mit dem man sich zur Nutzung der Webservices authentifizieren muss. |
| | Der Standardwert ist **serviceuser** |
+-------------------------+------------------------------------------------------------------------------------------------------+
Expand All @@ -121,6 +103,49 @@ Datei *../etc/module.yaml*
| | das Passwort zu erstellen, kann die Funktion **Passwort-Hash erzeugen** auf der Seite |
| | **Dienste** im Backend verwendet werden. |
+-------------------------+------------------------------------------------------------------------------------------------------+
| ip | Optional: IP Adresse auf der das http Modul aktiv sein soll - muss normalerweise nicht angegeben |
| | werden. |
+-------------------------+------------------------------------------------------------------------------------------------------+
| port | **Optional**: Der Port auf welchem das html Interface lauscht. Dieser Port wird für Webinterfaces |
| | wie z.B. das Backend Plugin genutzt- Standard Port ist **8383** . |
+-------------------------+------------------------------------------------------------------------------------------------------+
| tls_port | **Optional**: Portnummer für die Webinterfaces bei Nutzung von https - Standard Port ist **8385* |
+-------------------------+------------------------------------------------------------------------------------------------------+
| use_tls | **Optional**: Auf True setzen, um Zugriffe über https:// zu ermöglichen (Zertifikat muss |
| | installiert sein) |
+-------------------------+------------------------------------------------------------------------------------------------------+
| tls_cert | **Optional**: Name der Zertifikatsdatei mit der Endung '.cer' oder '.pem'. Die Datei muss |
| | im Verzeichnis ../etc liegen |
+-------------------------+------------------------------------------------------------------------------------------------------+
| tls_key | **Optional**: Name der Datei mit dem privaten Schlüssel und der Endung '.key'. Die Datei muss |
| | im Verzeichnis ../etc liegen |
+-------------------------+------------------------------------------------------------------------------------------------------+
| serviceport | **Optional**: Der Port auf welchem das html Interface lauscht. Dieser Port wird für den Zugriff |
| | auf Webservices genutzt, wie ihn z.B. das Plugin Webservices zur Verfügung stellt. Standard Port |
| | ist **8384** . |
+-------------------------+------------------------------------------------------------------------------------------------------+
| showpluginlist | **Optional**: Falls der Parameter auf **False** gesetzt wird, wird unter |
| | **http://smarthomeNG.local:8383/plugins** keine Liste der geladenen Plugins mit Web Interface |
| | gezeigt. Dann ist der Zugriff auf die Webinterfaces nur direkt über die jeweilige Url oder über die |
| | Seite **Plugins** im Backend möglich. **showpluginlist** ist standardmäßig **True**. |
+-------------------------+------------------------------------------------------------------------------------------------------+
| showservicelist | **Optional**: Falls der Parameter auf **False** gesetzt wird, wird unter |
| | **http://smarthomeNG.local:8383/services** keine Liste der Services mit Web Interface gezeigt. |
| | **showservicelist** ist standardmäßig **False**. |
+-------------------------+------------------------------------------------------------------------------------------------------+
| starturl | **Optional**: Wenn **starturl** auf den Namen eines geladenen Plugins gesetzt ist, wird beim Aufruf |
| | von http://smarthomeNG.local:8383/ auf dieses Plugin weitergeleitet, statt auf die Übersichtsseite. |
| | Wenn z.B. standardmäßig das Backend Plugin aufgerufen werden soll, muss ``starturl: backend`` |
| | gesetzt werden. Die Übersichtsseite ist weiterhin unter http://smarthomeNG.local:8383/plugins/ |
| | erreichbar. |
+-------------------------+------------------------------------------------------------------------------------------------------+
| threads | **Optional**: Die Anzahl der Threads, die CherryPy für jeden Port startet, auf dem es lauscht. |
| | Default ist 8, was für leistungsschwächere CPUs zu viel sein kann |
+-------------------------+------------------------------------------------------------------------------------------------------+
| showtraceback | **Optional**: Falls dieser Parameter auf **True** gesetzt wird, zeigen Fehlerseiten (außer Fehler |
| | bei 404) einen Python Fehler-Trace an. Normalerweise wird dieser Trace nur im **smarthome.log** |
| | aufgezeichnet. |
+-------------------------+------------------------------------------------------------------------------------------------------+
| webif_pagelength | **Optional**: Anzahl an Tabellenreihen, die in den Plugin Webinterfaces standardmäßig pro Seite |
| | angezeigt werden sollen. Bei **-1** werden alle Einträge auf einer Seite gezeigt, bei **0** (default)|
| | so viele, dass sie genau auf die Seite ohne Scrolling passen. Weitere mögliche Werte sind 25, 50, 100|
Expand Down
8 changes: 5 additions & 3 deletions doc/user/source/konfiguration/module/module_websocket.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,11 +44,13 @@ Datei *../etc/module.yaml*
# etc/module.yaml
websocket:
module_name: websocket
# tls_key: myprivate.key
# use_tls: true
# tls_cert: myprivate.pem
# enabled: True
# ip: ''
# port: 2424
# tls_port: 2425
# use_tls: False
# tls_cert: myprivate.pem
# tls_key: myprivate.key
.. note::
Das Zertifikat muss ohne Passphrase erstellt werden (bei der Frage nach der Passphrase einfach Enter drücken). Zudem muss der "Common Name"
Expand Down
Loading

0 comments on commit 6b9d3cf

Please sign in to comment.