Zum Hauptinhalt springen
Version: iSign 8

Setup-Konfigurationsdateien

server-setup.json​

Die server-setup.json wird verwendet um einen iSign Server zu konfigurieren. Das Format ist JSON oder JSONC (JSON mit Kommentaren). Der Dateiname ist je nach System und Anwendungsfall unterschiedlich; der Pfad ist in der Installationsanleitung zu finden.

Die wichtigsten Parameter werden im Folgenden augelistet.

  • http.ServerUrl (string): Unter dieser URL sollen die Webdienste von iSign laufen. Es sollte ein Hostname verwendet werden, der auf den Server verweist. Es wird sowohl http als auch https unterstützt.
  • http.WebPort (number): Port unter welchem die Webdienste des Server laufen sollen. Dies muss mit http.ServerUrl übereinstimmen.
  • http.RedirectFromPort80 (true|false): Kann verwendet werden um eine Weiterleitung von Port 80 (http) auf den verwendeten Port (z.B. 443 / https) anzulegen
  • http.SslMode (“Disabled”|”ACME”|”SelfSigned”|”ManualFilePath”): Hiermit wird festgelegt, wie ein SSL-Zertifikat aufgefunden wird. Siehe auch Zertifikate. Die Optionen im einzelnen:
    • “Disabled”: Es wird kein SSL verwendet
    • “ACME”: Bezieht ein Zertifikat über Let’s Encrypt. Dazu ist es erforderlich, dass die URL des Servers öffentlich erreichbar ist. (Siehe auch EMail und AcceptLetsEncryptTOS)
    • ”SelfSigned”: Verwendet ein selbst-signiertes Zertifikat. Nur zu Testzwecken empfhohlen.
    • “ManualThumbprint”: Sucht das Zertifikat mit dem unter CertificateFindValue angegebenen Fingerabdruck im Zertifikatspeicher. (nur Windows)
    • ”ManualFilePath”: Verwendet das Zertifikat aus $certdir/HOSTNAME/fullchain.pem bzw. $certdir/HOSTNAME/privkey.pem die Umgebungsvariable $certdir kann über die iSign.Server.conf festgelegt werden. Der Standardwert für $certdir ist /usr/share/designo/isign-server/instance/default/nginx/ssl. (nur Linux)
  • http.CertificateFindValue (string): Wert nach welchem das Zertifikat gesucht wird. Siehe SslMode.
  • http.AcceptLetsEncryptTOS (true|false): Bestätigt, dass die Let’s Encrypt Terms of Service akzeptiert werden. Erforderlich, falls “ACME” verwendet wird.
  • http.EMail (string): E-Mail Adresse welche für den Bezug eines Zertifikates von Let’s Encrypt verwendet wird. Erforderlich, falls “ACME” verwendet wird.
  • user.CreateAdmin (true|false): Wenn aktiviert erstellt den user “admin” bei jedem Konfigurationslauf. In der Regel nur bei der ersten Konfiguration empfholen. Kann auch verwendet werden, wenn die Zugangsdaten verloren gingen.
  • user.AdminUserName(string): Zu erstellender oder zu ändernder Benutzername für die Verwendung mit user.CreateAdmin
  • user.AdminPassword(string): Passwort welches für den Admin in user.CreateAdmin gesetzt wird.

player-setup.json​

Die player-setup.json wird verwendet um einen iSign Player zu konfigurieren. Das Format ist JSON oder JSONC (JSON mit Kommentaren). Der Dateiname ist je nach System und Anwendungsfall unterschiedlich; der Pfad ist in der Installationsanleitung zu finden.

Die wichtigsten Parameter werden im Folgenden augelistet.

  • display-server.serverUrl (string): Url zum Content-Dienst Ihres Severs dies entspricht in der Regel dem Muster "https://HOSTNAME/ContentApi"
  • display-server.issuerUrl (string): Url zum Idenditäts-Dienst Ihres Severs dies entspricht in der Regel dem Muster "https://HOSTNAME/ID"
  • display-server.enablePlayerApiAuthentication (true|false): Authentifizierung am Server verwenden. Sollte immer true sein, es sei denn der Server ist iSign 7 oder älter.

Falls die MQTT Erweiterung für EPDs verwendet wird (MQTT-Player) sind auch folgende Paramter relevant.

  • mqtt.broker (string): MQTT-Url welche zur Bereitstellung des MQTT-Brokers verwendet wird. Zum Beispiel: "mqtts://HOSTNAME:8883/" (mit SSL) oder "mqtt://HOSTNAME:1883/" (ohne SSL)
  • mqtt.certificateFindType (string): Gibt an wie das Zertifikat gefunden werden soll. Mögliche Werte:
    • FindByThumbprint: Sucht im Zertifikatspeicher nach dem Fingerandruck, welcher in certificateFindValue angegeben wird. (nur Windows)
    • FindBySubjectName: Sucht im Zertifikatspeicher nach dem “Subject Name”, welcher in certificateFindValue angegeben wird. (nur Windows)
    • FindInPath: Das Zertifikat wird dann unter den Dateien $acmedir/live/VALUE/cert.pem, $acmedir/live/VALUE/fullchain.pem und $acmedir/live/VALUE/privkey.pem gesucht. Die Umgebungsvariable $acmedir kann über die iSign.Player.conf festgelegt werden. VALUE bezeichnet den unter certificateFindValue angegebenen Wert. Der Standardwert für $acme ist /usr/share/designo/isign-server/instance/default/acme. Die Struktur ist so gestaltet, dass der MQTT-Broker ein über die ACME-Funktion des Servers bezogenens Zertifikat mitbenutzen kann.
      Die Zertifikate benötigen Leseberechtigungen für die Gruppe 8101 (ssl-cert). (nur Linux)
  • mqtt.certificateFindValue (string): Mit diesem Wert wird das Zertifikat welches vom MQTT-Broker verwendet wird gekennzeichnet. Vergleiche certificateFindType
  • mqtt.userName (string): Benutzername mit welchem ein Zugriff auf den MQTT-Broker möglich sein soll.
  • mqtt.password (string): Passwort mit welchem der Zugriff auf den MQTT-Broker möglich sein soll.

Beispiel für player.json

/ isign player configuration file
{
  "display-server": {
    // enter the server urls here
    "serverUrl": "https://designo.isigncloud.de/ContentApi",
    "issuerUrl": "https://designo.isigncloud.de/ID",
    "enablePlayerApiAuthentication": true,
  },
  "mqtt": {
    // configure the mqtt broker here:
    // for encrypted mode use
    //"broker": "mqtts://MY_HOST:8883/",
    "certificateFindValue": "designo.isigncloud.de",
    // this defaults to unencryped
    "broker": "mqtts://designo.isigncloud.de:8883/",

// configure authentication
"userName": "iSign",
"password": "iStMMb4a",

  },
}