Erste Schritte

Nach der Installation der PureLife Cloud sind einige grundlegende Schritte und Anpassungen erforderlich, damit das System korrekt funktioniert. In diesem Abschnitt werden die ersten Schritte beschrieben.

Systemidentifizierung#

Um die Cloud auf die eigene Umgebung zu spezifizieren, kann der Service-Name der Instanz angepasst werden. Dazu in der zentralen Konfigurationsdatei config.toml in der Sektion [Service] den Parameter ServiceName anpassen.

Beispiel-Konfiguration:

[Service]

  # Name of this service. Sometimes used in mails and sent messages.
  # Useful to change if multiple PureLife Cloud instances are used.
  ServiceName = "PureLife Cloud Production"

Konfiguration des HTTP-Servers#

Während des Betriebs erstellt die PureLife Cloud für die Sensoren Links, über welche die Sensoren Dateien mit der PureLife Cloud austauschen können. Damit die erstellten Links gültig sind und verwendeten werden können, muss die URL der PureLife Cloud hinterlegt werden.

[HTTP]

  # HTTP/s URL under which the PureLife Cloud instance can be reached.
  SiteURL = "https://purelife-cloud.mein-domain.de"

Sensoren mit einer Firmware-Version < 0.36 unterstützen keine Übertragung von Dateien über eine verschlüsselte HTTPS-Verbindung. Sollte der Zugriff auf die PureLife Cloud über eine verschlüsselte Verbindung erfolgen (dringend empfohlen), muss ebenfalls eine unverschlüsselte Verbindung möglich sein und die URL für die unverschlüsselte Verbindung in der Konfiguration hinterlegt werden.

[HTTP]

  # URL that sensors with a firmware version < 0.36 should use for file exchange.
  # Must also point to PureLife Cloud, but must use HTTP.
  LegacyFirmwareURL = "http://purelife-cloud.mein-domain.de"

System Mail Server#

Um den Administrator der Cloud über Systemereignisse zu benachrichtigen, muss den Sektion [System_SMTP] in der zentralen Konfigurationsdatei config.toml mit den entsprechenden Parametern des Mailserver ausgefüllt werden.

Beispiel-Konfiguration:

[System_SMTP]

  # Activates or deactivates the SMTP service
  Enabled = true

  # Name of the sender (For example 'John Doe')
  FromName = "PureLife Cloud"

  # Sender email address
  FromAddress = "purelife-cloud@domain.de"

  # Optional. Mail address to which the reply should be sent.
  ReplyToAddress = "it@domain.de"

  # Host of the SMTP server.
  Host = "mail.domain.de"

  # Port of the SMTP server.
  Port = 587
  ServerTimeout = 45

  # Whether to log in to the SMTP server using the 'LOGIN' mechanism or not.
  EnableSMTPAuth = true

  # Username with which to log on to the SMTP server.
  Username = "purelife-cloud@domain.de"

  # Password with which to log on to the SMTP server.
  Password = "sicheres-Passwort"

  # How to encrypt communication with the mail server.
  # Possible values are: "PLAIN", "TLS", "STARTTLS" and ""
  ConnectionSecurity = "STARTTLS"

  # If true, crypto/tls accepts any certificate presented by the server and any host name in that certificate
  SkipServerCertificateVerification = false

Die Konfiguration kann mit folgendem Befehl über die Konsole geprüft und eine Testmail gesendet werden:

./purelife-cloud config test-mail --to your@mail-address.com

System Admin Mail#

Nachdem die entsprechenden Parameter für den System Mailserver hinterlegt sind, muss die Mailadresse des Administrators konfiguriert werden. Diese ist in der Sektion [Service] der zentralen Konfigurationsdatei config.toml zu finden.

Beispiel-Konfiguration:

[Service]

# .....

  # E-mail address of an administrator.
  # Used to send system mails concerning general things.
  # Attention: System SMTP must be configured before.
  AdminMail = "admin@domain.de"
  MessageRetryIntervall = 5
  MessageRetryMaxAge = 60

Publisher#

Ein Publisher ist eine Verknüpfung zu einem Dienst, Service oder Protokoll, um Benutzer über bestimmte Situationen zu informieren. Die PureLife Cloud unterstützt verschiedene Publisher, welche in der zentralen Konfigurationsdatei config.toml in der Sektion [Publisher] definiert werden müssen. Anschließend können die Publisher in den Regeln angewendet werden.

Telegram#

Damit die PureLife Cloud Instanz über Telegram kommunizieren kann, muss ein Telegram Bot erstellt und dessen Token in der zentralen Konfigurationsdatei config.toml hinterlegt werden.

Schaue dir dazu den Guide Telegram Bot an, um zu erfahren, wie du den Bot anlegen und in der Konfigurationsdatei eintragen musst.

Mail#

Um Mail als Publisher nutzen zu können, müssen die Mailserver spezifischen Parameter in der zentralen Konfigurationsdatei config.toml in der Sektion [Publisher.SMTP] hinterlegt werden.

Diese können sich von dem System Mail Server [System_SMTP] unterscheiden, müssen es aber nicht. Die Konfiguration der Parameter für den [Publisher.SMTP] ist erforderlich, wenn man E-Mail als Publisher nutzen möchte.

Beispiel-Konfiguration:

[Publisher.SMTP]

  # Activates or deactivates the SMTP service
  Enabled = true

  # Name of the sender (For example 'John Doe')
  FromName = "PureLife Cloud"

  # Sender email address
  FromAddress = "purelife-cloud@domain.de"

  # Optional. Mail address to which the reply should be sent.
  ReplyToAddress = "it@domain.de"

  # Host of the SMTP server.
  Host = "mail.domain.de"

  # Port of the SMTP server.
  Port = 587
  ServerTimeout = 45

  # Whether to log in to the SMTP server using the 'LOGIN' mechanism or not.
  EnableSMTPAuth = true

  # Username with which to log on to the SMTP server.
  Username = "purelife-cloud@domain.de"

  # Password with which to log on to the SMTP server.
  Password = "sicheres-passwort"

  # How to encrypt communication with the mail server.
  # Possible values are: "PLAIN", "TLS", "STARTTLS" and ""
  ConnectionSecurity = "STARTTLS"

  # If true, crypto/tls accepts any certificate presented by the server and any host name in that certificate
  SkipServerCertificateVerification = false

Die Konfiguration kann mit folgendem Befehl über die Konsole geprüft und eine Testmail gesendet werden:

./purelife-cloud config test-mail --use-publisher --to your@mail-address.com

MessageBird#

Um Benachrichtigungen über definierte Situationen per SMS oder Anruf zu versenden, kann der Dienst von MessageBird verwendete werden. Dazu muss zunächst ein Account erstellt, dieser mit Guthaben aufgeladen und ein Access Key generiert werden. Anschließend muss der Access Key in der zentralen Konfigurationsdatei config.toml in der Sektion [Publisher.Message_Bird] hinterlegt werden.

Beispiel-Konfiguration:

# Configuration for the MessageBird publisher.
# Used for sending SMS.
[Publisher.Message_Bird]

  # Activates SMS delivery via MessageBird.
  SMSEnabled = false

  # Enables the publisher for voice messaging via MessageBird.
  VoiceMessageEnabled = true

  # Sets the gender of the voice that will call.
  # Possible values are: "male" and "female"
  VoiceGender = "female"

  # The number of times the voice message needs to be repeated. Maximum is 10 times.
  VoiceRepeats = 1

  # Access key which is used for communication with the MessageBird API.
  # To get a access key, see the MessageBird documentation.
  AccessKey = "ab12cd34ef56gh78ij90kl"

GRPC#

gRPC (gRPC Remote Procedure Calls) ist ein Protokoll zum Aufruf von Funktionen in verteilten Computersystemen. Es basiert auf dem Standard HTTP/2 und Protocol Buffers. Dieses Protokoll kann von der Cloud verwendet werden, um Benachrichtigungen über definierte Situationen zu versenden. In diesem Fall ist ein entsprechendes Empfängersystem erforderlich.

ESPA#

ESPA 4.4.4 bezeichnet ein Protokoll für eine serielle Schnittstelle, das von der European Selective Paging Manufacturers Association (ESPA) definiert wurde. Dieses Protokoll ermöglicht den Datenaustausch zwischen Personenruf-Funkanlagen, Paging-Systemen, Lichtrufanlagen, Personen-Notsignal-Anlagen oder Alarm-Servern. Die PureLife Cloud ist in der Lage über dieses Protokoll Benachrichtigungen über definierte Situationen zu verwenden. In diesem Fall ist ein entsprechendes Empfängersystem erforderlich.

Passwort ändern#

Bei einer Serverinstallation wird der erste Cloud-Administrator inkl. Passwort im Rahmen der Installationsroutine individuell erstellt.

Bei einer Docker Installation wird der erste Cloud-Administrator inkl. Passwort durch die Installationsroutine vorgegeben. Die Zugangsdaten lauten standardmäßig:

Benutzer: admin
Passwort: admin

Diese Zugangsdaten sollten vor der weiteren Verwendung, insbesondere bei Zugriffen aus dem Internet, geändert werden. Dazu gibt es zwei Möglichkeiten:

1. Änderung über das PureLife Cloud Frontend
2. Änderung über die Konsole

Die Änderung über das Cloud-Frontend wird im Kapitel Benutzer bearbeiten beschrieben.

Für die Änderung über die Konsole ist folgender Befehl zu verwenden:

{installationsort}/purelife-cloud user password admin new-password

Kunde anlegen#

Damit die mit dieser Instanz verbundenen Sensoren genutzt werden können, muss mindestens ein Kunde angelegt werden. Diesem Kunden müssen die Sensoren dann zugeordnet werden, damit die Konfiguration der Sensoren möglich ist. Die Erstellung wird im Kapitel Kunden beschrieben.