Information

  • The PLANTA Web Client is delivered as a container image.
  • The container image can be deployed wherever an OCI-compatible container runtime or platform is available.
    • This includes Windows computers, although the PLANTA Web Client image is based on Linux.
  • For production workloads we recommend that you set up PLANTA secure as a reverse proxy (TLS scheduling, single sign-on with OIDC, etc.).
  • Below you will find a description of the deployment of the PLANTA web client via docker compose:

Download Web Client Container Image

Procedure

  • The image is made available on the PLANTA registry under registry.planta.services (https://registry.planta.services). The login data will be sent to you by PLANTA upon request.

Configure the Web Client Container Image with Docker Compose

Procedure

  • The configuration of the web client can be made via environment variables (docker-compose.yml, "Environment") section.
  • Port mapping (docker-compose.yml, "Ports” section)
  • Artifact version (docker-compose.yml, "Image" section) corresponds to the docker-image namen + day, e.g. registry.planta.services/planta/webclient:latest.


Example 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)"
YML

Make the Web Client Container Available Using Docker-Compose

Procedure

  1. Edit the Configuration.
  2. Log in to the PLANTA registry using your usual login data: docker login registry.planta.services.
  3. Pull the Web Client container image: docker-compose pull.
  4. Log out of the registry: docker logout registry.planta.services.
  5. Create or start container: docker-compose up -d.

Command Line Commands

  • Stop container: docker-compose stop
  • Stop or delete container: docker-compose down
  • View logs: docker-compose logs



See also: Configuration of the Web Client