Installation des Web-Clients

Informationen

• Der PLANTA-Web-Client wird als ein Container-Image geliefert.
• Das Container-Image kann überall dort bereitgestellt werden, wo eine OCI kompatible Container Runtime bzw. Plattform vorhanden ist.
  • Dies schließt Windows-Rechner ein, wobei das PLANTA-Web-Client-Image auf Linux basiert.
• Für Produktions-Workloads empfehlen wir, PLANTA secure als Reverse-Proxy aufzusetzen (TLS-Terminierung, Single Sign-On mit OIDC usw.).
• Im Folgenden wird die Bereitstellung des PLANTA-Web-Clients mit docker-compose beschrieben.

Web-Client-Container-Image herunterladen

Vorgehensweise

• Das Image ist auf der PLANTA Registry unter registry.planta.services verfügbar (https://registry.planta.services). Die Anmeldedaten erhalten Sie von PLANTA.

Web-Client-Container-Image mit docker-compose konfigurieren

Vorgehensweise

• Die Konfiguration des Web-Clients kann über Umgebungsvariablen vorgenommen werden (docker-compose.yml, Abschnitt "Environment").
  • Liste aller Parameter
• Port-Mapping (docker-compose.yml, Abschnitt "Ports")
• Artefaktversion (docker-compose.yml, Abschnitt "Image") entspricht dem Docker-Image-Namen + Tag, z.B. registry.planta.services/planta/webclient:latest.

Beispiel docker-compose.yml

version: "3.3"

services:
  webclient:
    image: registry.planta.services/planta/webclient:latest # Artifact Version
    environment:
      - "ConnectionSettings__Servers__0__Host=production.planta.de"  # PLANTA Server Host
      - "ConnectionSettings__Servers__0__Port=20001" # PLANTA Server Port
    ports:
      - "8080:5000" # "[free port]:5000 (default port of the webclient)"

Web-Client-Container mit docker-compose bereitstellen

Vorgehensweise

1. Die Konfiguration bearbeiten.
2. In die PLANTA Registry mit den üblichen Anmeldedaten einloggen: docker login registry.planta.services.
3. Das Web-Client-Container-Image ziehen: docker-compose pull.
4. Aus der Registry ausloggen: docker logout registry.planta.services.
5. Container erstellen bzw. starten: docker-compose up -d.

Kommandozeilen-Befehle

• Container stoppen: docker-compose stop
• Container stoppen und löschen: docker-compose down
• Logs ansehen: docker-compose logs

Siehe auch: Konfiguration des Web-Clients