yunkong2.admin/_old.md at master

Files

zhongjin 9e2009bbf4 Initial commit

2018-09-14 19:26:46 +08:00

40 KiB

Raw Permalink Blame History

ausführliche Beschreibung

Der Adapter admin dient der Bedienung der gesamten yunkong2-Installation. Er stellt ein Webinterface zur Verfügung. Dieses wird unter der <IP-Adresse des Servers>:8081 aufgerufen. Dieser Adapter wird direkt bei der Installation von yunkong2 angelegt. Über das vom Adapter zur Verfügung gestellte GUI können u.a. folgenden Funktionen abgerufen werden:

Installation weiterer Adapter
Zugriff auf Objektübersicht
Zugriff auf die Zustandsübersicht der Objekte
Zugriff auf Benutzer und Gruppen Administration
Zugriff auf das Logfile
Verwaltung der Hosts

Installation

Dieser Adapter wird direkt bei der Installation von yunkong2 angelegt eine manuelle Installation ist nicht notwendig

Konfiguration

IP

Hier wird die IP-Adresse unter der der Adapter erreichbar ist eingegeben. Verschiedene Ipv4 und Ipv6 Möglichkeiten stehen zur Auswahl. Default ist 0.0.0.0. Dies darf nicht verändert werden!

Port

Hier wird der Port, unter der der Administrator aufgerufen werden kann eingestellt. Falls auf dem Server mehrere Webserver laufen muss dieser Port angepasst werden, damit es nicht zu Problemen wegen doppelter Portvergabe kommt.

Verschlüsselung

Soll das sichere Protokoll https verwendet werden ist hier ein Haken zu setzen.

Authentifikation

Soll eine Authentifizierung erfolgen ist hier ein Haken zu setzen.

Bedienung

Über den Webbrowser die folgende Seite aufrufen: <IP-Adresse des Servers>:8081

Reiter

Die Hauptseite des Administrators besteht aus mehreren Reitern. In der Grundinstallation werden die Reiter wie in der Abbildung angezeigt. Über das Bleistift-Icon rechts oben (1) können nach der Installation zusätzlicher Adapter weitere Reiter hinzugefügt werden. Dort können auch Reiter deaktiviert werden um eine besser Übersicht zu erhalten.

Adapter

Hier werden die verfügbaren und installierten Adapter angezeigt und verwaltet.

Die Titelzeile

in der Titelzeile befinden sich Icons für die wichtigsten Vorgänge. Zu jedem Icon gibt es eine Kontexthilfe. Dazu einfach mit der Maus eine Weile auf dem Icon bleiben.

Die Icons im einzelnen:

1.) nur installierte Adapter anzeigen Bei Anwahl dieses Icons werden nur noch die bereits installierten Adapter angezeigt (Toggle-Funktion) 2.) Adapter mit Updates anzeigen Bei Anwahl dieses Icons werden nur noch Adapter angezeigt, zu denen ein Update vorliegt (Toggle-Funktion) Hinter den updatefähigen Adaptern findet sich in der Spalte installiert ein Update-Icon. Durch Klick auf diesen Button wird der entsprechende Adapter auf die neueste Version gebracht. Außerdem erscheint ein weiteres Icon in der Titelzeile: Durch Anklicken dieses Icons werden alle verfügbaren Adapter aktualisiert. 3.) Adapter aus eigener URL installieren Über das Octocat-Icon können Adapter aus eigenen Pfaden (URL oder Dateipfade) oder Vorabversionen von GitHub installiert werden. Nach Anklicken dieses Icons öffnet sich ein entsprechendes Auswahlfenster: Unter dem Reiter Von github wird einfach im Pulldownmenü der gewünschte Adapter ausgewählt und die neueste Vorabversion wird installiert. Bei Anwahl des Reiters Beliebig kann ein bliebeiger Dateiupfad oder ein beliebiger URL (z.B. ein URL zu einem externen Adapterentwickler) in das Feld eingegeben werden und der entsprechende Adapter installiert werden. 4.) Nach Updates suchen Bei jedem Neustart wird automatisch nach Updates gesucht. Über diesen Button kann man aber die Suche manuell anstoßen. Wenn Updates in dem unter Systemeinstellungen eingestellten Repository zur Verfügung stehen, wird die Schrift des Reiters Adapter in grüner Farbe dargestellt. 5.) Sortierung ändern Mit diesem Button wird die Sortierung der Adapter auf dieser Seite geändert. Bei aktivem Button sind alle Adapter alphabetisch sortiert, wobei zuerst ein Block mit den installierten Adaptern, danach einer mit noch nicht installierten Adaptern angezeigt wird. Jeder dieser beiden Blöcke ist in sich alphabetisch sortiert. Ist dieser Button nicht aktiv, werden die Adapter nach Themen sortiert. Dann sind auch die nächsten beiden Icons sichtbar. 6.) Alle Themengebiete zuklappen 7.) Alle Themengebiete aufklappen Auf der rechten Seite befinden sich auch noch zwei Buttons 8.) Reiter editieren Mit diesem Button kann man nicht benötigte Reiter ausblenden und nicht sichtbare einblenden. 9.) Systemeinstellungen Hier werden grundlegende Parameter für yunkong2 eingestellt. Systemsprache - damit kann man zwischen Systemsprachen wählen: Deutsch, Englisch, Russisch Einheit Temperatur - dieses Wert wird von manchen Adaptern verwendet. Möglich ist °C oder °F. Währung - Momentan benutzt das noch kein Adapter Datumsformat - wählen Sie wie das Datum im admin und vis angezeigt sein sollte. Trennzeichen - Komma oder Punkt für Float-Werte Default Historyinstanz - Diese SQL/History/InfluxDB Adapter Instanz wird benutzt defaultmäßig für flot und rickshaw (Charts).

Verwahrungsorte oder Repositories

yunkong2 kann die Adaptersliste von unterschiedlichen Quellen beziehen. Bei der Installation sind folgende Quellen eingetragen:

default - http://download.yunkong2.net/sources-dist.json - Wird täglich um 01:00 am Server zusammen gebaut. Sehr schnell aber konnte bis 24 Stunden ältere Info haben.
online - https://raw.githubusercontent.com/yunkong2/yunkong2.js-controller/master/conf/sources-dist.json - Repository wird von online Quelle zusammengebaut. Kann sehr lange dauern, aber ist aktuellste Quelle
sources - conf/sources-dist.json - Wird auch zusammengebaut und dauert auch sehr lange aber die Links können veraltet sein (es können manche Adapter fehlen)

Zertifikate

Hier ist die zentrale Stelle für die Zertifikate, die für die SSL/HTTPS Kommunikation benutzt werden. Die Zertifikate werden von admin, web, simple-api, socketio benutzt. Defaultmäßig sind Standardzertifikate installiert. Damit kann man nichts verifizieren. Nur SSL Kommunikation laufen lassen. Weil die Zertifikate offen liegen sollte man eigene (self-signed) Zertifikate benutzen, die richtige Zertifikate kaufen oder auf Let's Encrypt umsteigen. Die Kommunikation mit default Zertifikaten ist nicht sicher und falls jemand das Ziel hat den Trafik mitzulesen, dass konnte gemacht werden. Unbedingt eigene Zertifikate installieren. Z.b. unter linux.

Let's Encrypt

Let’s Encrypt is a free, automated, and open certificate authority brought to you by the non-profit Internet Security Research Group (ISRG). You can read about Let’s Encrypt here. Some installations use Dynamic DNS and Co to get the domain name and to reach under this domain name own web sites. yunkong2 supports automatic request and renew of certificates from Let’s Encrypt Organisation. There is an option to activate free certificates from Let’s Encrypt almost in every adapter, that can start some web server and supports HTTPS. If you just enable the using of certificates and will not activate an automatic update the instance will try to use stored certificates. If the automatic update is activated the instance will try to request certificates from Let’s Encrypt and will automatically update it. The certificates will be first requested when the given domain address will be accessed. E.g you have "sub.domain.com" as address, when you try to access https://sub.domain.com the certificates will be first requested and it can last a little before first answer will come. The issuing of certificates is rather complex procedure, but if you will follow the explanation you will easy get free certificates. Description:

The new account will be created with given email address (you must set it up in system settings)
Some random key will be created as password for the account.
After the account is created the system starts on port 80 the small web site to confirm the domain.
Let's encrypt use always port 80 to check the domain.
If port 80 is occupied by other service see point 4.
After the small web server is up the request to get certificates for given domains (system settings) will be sent to the Let's encrypt server.
Let's encrypt server sends back some challenge phrase as answer on the request and after a while tries to read this challenge phrase on "http://yourdomain:80/.well-known/acme-challenge/"
If challenge phrase from our side comes back the Let's encrypt server send us the certificates. They will be stored in the given directory (system settings).

Sounds complex, but everything what you must do is to activate checkboxes and specify your email and domain in system settings. The received certificates are valid ca. 90 days. After the certificates are received the special task will be started to automatically renew the certificates. The topic is rather complex and 1000 things can go wrong. If you cannot get certificates please use cloud service to reach your installation from internet. Let's encrypt works only from node.js version>=4.5

Statistics

yunkong2 admin sendet an download.yunkong2.net folgende Information:

{
  "uuid": "56cf0d20-XXXX-YYYY-BBBB-66eec47ZZZZZ",
  "language": "de",
  "hosts": [
    {
      "version": "0.15.1",
      "platform": "Javascript/Node.js",
      "type": "win32"
    }
  ],
  "adapters": {
    "admin": {
      "version": "1.0.2",
      "platform": "Javascript/Node.js"
    },
    "hm-rpc": {
      "version": "1.1.2",
      "platform": "Javascript/Node.js"
    }
  }
}

Das konnte unterstellt werden in dem man Statistics auf "nichts" einstellt. Trotzdem die Entwickler bitten um Nachgeben:

Wir haben hart gearbeitet um dieses Projekt auf die Beine zu stellen. Als Gegenleistung bitten wir Sie uns die Statistik über die Benutzung an uns zu schicken. Keine private Information wird zu yunkong2.org gesendet. Jedes Mal wenn Adapterliste upgedated wird, wird die anonymisierte Statistik gesendet.

Der Seiteninhalt

Auf der Seite werden die Adapter tabellarisch dargestellt. Die Tabelle besteht aus folgenden Spalten:

1.) Name

In dieser Spalte werden die Namen der Adapter mit den dazugehörigen Icons aufgeführt. Ist über das Icon (5) in der Titelzeile das Gruppieren von Adaptern angewählt erscheinen hier auch die Gruppennamen.

2.) Beschreibung

Hier befindet sich eine kurze Beschreibung der Funktion des Adapters

3.) Schlüsselworte

Hier sind einige Suchbegriffe aufgeführt, die mit dem Adapter assoziiert werden.

4.) Version

Die verfügbare Version wird hier angezeigt. Zur Übersicht wird der Entwicklungsstand eines Adapters farblich hinterlegt. (rot = in Planung; gelb = Beta; orange = Alpha; grün = Final).

5.) installiert

Diese Spalte gibt verschiedene Informationen über den Installationsstatus dieses Adapters. Zum einen steht dort die Versionsnummer des installierten Adapters. Ist diese fettgedruckt liegt ein Update vor. Dahinter steht in eckigen Klammern die Anzahl der von diesem Adapter installierten Instanzen, wie viele davon aktiviert sind und wie deren Status ist. So bedeutet [2/1], dass von diesem Adapter zwei Instanzen existieren, wovon eine aktiviert ist und ohne Probleme läuft (letzteres ist an der grünen Farbe der zweiten Zahl zu erkennen). Weiter rechts befindet sich ein Update-Icon wenn zu diesem Adapter ein Update vorliegt Adapter. Durch Anklicken dieses Icons wird der Updatevorgang gestartet.

6.) Plattform

Hier wird angegeben auf welcher Softwareplattform dieser Adapter beruht. Üblicherweise ist dies javascript unter nodejs.

7.) Lizenz

Dies ist die Lizenz unter der der Adapter zur Verfügung gestellt wird. Die Lizenzbedingungen finden sich üblicherweise im readme. Verlangt die Lizenz, dass sie vom Enduser akzepiert werden muss, wird ein entsprechendes Fenster mit den Lizenzbedingungen beim Erstellen einer Instanz angezeigt.

8.) Installieren

In dieser Spalte befinden sich verschiedene Buttons für die Installation und für Hilfe.

(+) Hiermit wird eine Instanz des Adapters hinzugefügt. Diese muss im Reiter Instanzen noch konfiguriert und aktiviert werden. Nur wenn von einem Adapter mindestens eine Instanz angelegt wurde, kann der Adapter auch bei yunkong2 verwendet werden. Bei den meisten Adaptern können beliebig viele Instanzen installiert werden, z.B. um unterschiedliche Hardware anzusprechen. Sollte dies nicht möglich sein, öffnet sich ein Fenster mit einer entsprechenden Fehlermeldung.
(?) Wenn dieser Button aktiv ist, verlinkt er zu der Hilfeseite zu dem Adapter. Diese befindet sich üblicherweise auf GitHub, wo auch der Adapter gepflegt wird.
(Mülleimer) Dieser Button löscht den Adapter und alle bereits installierten Instanzen

Ist das Fragezeichen-Icon in der letzten Spalte aktiv, gelangt man von dort aus mit einem Klick auf eine weiterführende Github-Seite mit Informationen zu dem Adapter.