Skip to main content

Installation

Sie können zwischen verschiedenen Arten der Nutzung von KIX 18 wählen:

  • KIX 18 On-Premises: Lokale Installation auf dem eigenen Server

  • KIX 18 Cloud: Anwendung in der KIX Cloud - ohne Installation

Erreichbarkeit der Portale

Systemvoraussetzungen für einen Client

Unterstützte Betriebssysteme

Für die Hostumgebungen von KIX 18 empfehlen wir folgende Betriebssysteme / Umgebungen:

  • CentOS/RHEL

  • Debian

  • Ubuntu

  • MacOS

Empfohlene Bildschirmgrößen

Bildschirm

Mindestanforderung

Auflösungf

Desktop: 1280px x 720px

Format

Desktop: 16:9

Tablezt: 10"

Unterstützte Browser

Agentenportal und Self Service Portal

Unterstützte Browser (JavaScript aktiviert)

Versionen

Mozilla Firefox

103+

Chrome/Chromium

103+

MS Edge (Chromium basiert)

101+

Field Agent App

Unterstützte Betriebssysteme (Smartphone)

Versionen

iOS

15+

Android

10+

KIX On-Premises Installation

KIX wird über bereits vorkonfigurierte Docker-Container installiert und bringt seine eigene Betriebsumgebung und Datenbank mit. Dies erleichtert den Einsatz der Software auf den verschiedenen Betriebssystemen.

Auf der Hostumgebung muss lediglich eine kompatible Docker-Version (korrekt und vollständig installiert) vorhanden und lauffähig sein. Daher empfehlen wir, vor der Installation von KIX 18 zu prüfen, ob die geplante Hostumgebung die Nutzung von Docker unterstützt.

Der Einsatz von KIX 18 erfordert Docker in Version 20.x und Docker-Compose 2.1. Weiterführende Informationen unter: docker.com oder https://docs.docker.com/engine/install/linux-postinstall/.

Für die Installation von KIX 18 auf dem eigenen Server verwenden Sie die in KIX GitHubhinterlegten Dateien. Für den produktiven Einsatz empfehlen wir eine Installation unter Linux.

Nachfolgend finden Sie eine sehr kompakte Kurzanleitung für die On Premises Installation. Eine detaillierte Installationsanleitung finden Sie unterhttps://github.com/cape-it/kix-on-premise/blob/master/deploy/linux/README.md

Die Bedienung von Docker erfolgt über die Konsole (Terminal). Verwenden Sie die nachfolgenden Konsolen-Kommandos.

Hinweis

Der Nutzer auf der Kommandozeile muss Ausführungsrechte auf den Docker-Service haben.

So installieren Sie KIX (Kurzfassung)

  1. Installieren Sie Docker und Docker-Compose auf dem Host-System (i.d.R. "localhost" / nachfolgend: "your.docker.host"):

    Hinweis

    Die Skripte erfordern Docker-Compose als Stand-Alone-Installation, auch wenn neuere Docker-Versionen Compose bereits als Plugin beinhalten.

  2. Abruf der initialen Docker-Umgebung

    • cd/opt

    • git clone https://github.com/kix-service-software/kix-on-premise.git

  3. Wechseln Sie in das entpackte Linux- bzw. Windows-Verzeichnis:

    • cd kix-on-premise/deploy/linux

    • cd kix-on-premise/deploy/windows

  4. Empfehlung: Erstellen Sie eine Sicherheitskopie folgender Dateien:

    • environment

    • proxy/non-ssl.conf

    • proxy/ssl.conf

  5. SSL Setup

    Fügen Sie Ihre SSL-Zertifikate in die Docker-Umgebung in folgende Dateien ein:

    • Zertifikat: proxy/ssl/certs/server.crt

    • Schlüssel: proxy/ssl/certs/server.key

    1. Für den Fall, dass Sie ein ca-Bündel benötigen:

      • Erstellen Sie das Verzeichnis proxy/ssl/certs/ca-bundle

      • Kopieren Sie Ihre ca-bundle-Dateien in dieses Verzeichnis.

      • Kommentieren Sie die Zeile mit ssl_trusted_certificate in der Konfiguration proxy/ssl/ssl.confaus.

    2. Verwendung von SSL anstatt Nicht-SSL

      • Alle Servereinträge deaktivieren: in Datei proxy/non-ssl.conf (per Kommentar # )

      • Alle Servereinträge aktivieren: in Datei proxy/ssl.conf (durch Entfernen von # )

    Hinweis

    Bei Auswahl dieses Setups werden in BACKEND_PORT , FRONTEND_PORT, SSP_PORT definierte Anwendungs-Ports als Drop-In-Ersatz verwendet.

  6. KIX starten oder stoppen

    • Wechseln Sie in das entpackte Linux- bzw. Windows-Verzeichnis:

      • cd /kix-on-premise/linux

      • cd /kix-on-premise/windows

    • Start-Skript ausführen:

      • Windows: start.ps1

      • Linux: ./ start.sh

    • Stop-Skript ausführen:

      • Windows: stop.ps1

      • Linux: ./stop.sh

  7. Anmeldung an KIX

    Melden Sie sich nach dem Start von KIX 18 am System an. Bei unveränderter Konfiguration der Datei environment mit folgenden Daten:

    • Portalzugänge

      • Agentenportal: http://your.docker.host:20001

      • Self Service Portal (nur KIX Pro): http://your.docker.host:20002

    • Anmeldedaten für Erstanmeldung

      • User: admin

      • Passwort. Passw0rd

  8. Nutzen Sie dann den Setup Assistent, um ein neues Admin-Passwort sowie einen Super User festzulegen und die Grundkonfiguration von KIX vorzunehmen.

KIX Pro On-Premises verwenden

Um KIX Pro lokal zu verwenden, müssen Sie lediglich in der Datei environment die öffentliche Docker- Registry durch Ihre individuelle Repository-ID ersetzen. Die Repository-ID senden wir Ihnen per E-Mail zu, nachdem Sie KIX Pro abonniert haben.

Wichtig

Die Ihnen zugesendete Repository-ID ist ausschließlich für die Nutzung durch Sie bzw. Ihre Organisation bestimmt.

Geben Sie daher die Repository-ID nicht weiter und bewahren Sie sie sorgfältig und vor unbefugten Zugriff gesichert auf.

Gelangen Unbefugte in Besitz Ihrer Repository- ID, könnten sie Zugang zu Ihrem System und zu Ihren Daten erhalten.

  1. Installieren Sie zunächst KIX Start - sofern noch nicht vorhanden (s. auch: KIX On-Premises Installation

  2. Öffnen Sie die Datei environment.

  3. Setzen Sie eine Raute (#) An den Anfang der Zeile: REGISTRY=docker- registry.kixdesk.com/public

    Damit kommentieren Sie den Verweis auf die öffentliche Registry aus, sodass diese Angaben beim Programmstart unberücksichtigt bleiben.

  4. Ersetzen Sie in der übernächsten Zeile <YOURREPOSITORYHERE> durch Ihre individuelle Repository- ID und entfernen Sie die Raute (#) am Anfang der Zeile.

    Durch das Entfernen der Raute findet diese Zeile beim Programmstart Berücksichtigung.

  5. Das Ergebnis sieht wie folgt aus:

    # --------------------------------------------------
# basic configuration
# --------------------------------------------------
 
# the docker registry to use
#REGISTRY=docker-registry.kixdesk.com/public
 
# the following applies for KIX Pro customers
REGISTRY=docker-registry.kixdesk.com/customers/4d11xo22xxxxxxxxxxxxxxxxxxxxxxxff29
 
# the image tag to use for all application images
IMAGE_TAG=stable
...

  6. Führen Sie ein Update aus (s. auch KIX On-Premises Update)

Beim nächsten Start von KIX können Sie KIX Pro verwenden.

Nutzen Sie dann den Setup Assistent, um ein neues Admin-Passwort sowie einen "Super User" festzulegen und die Grundkonfiguration von KIX vorzunehmen.

Alternativ können Sie KIX Pro über die Konsole initialisieren. Rufen Sie dazu folgenden Befehl auf:

root@dockerhost:/opt/kix-on-premise/deploy/linux/# sed -i.orig 's/REGISTRY=docker- registry.kixdesk.com\/public/REGISTRY=docker-registry.kixdesk.com\/ public\nREGISTRY=docker-registry.kixdesk.com\/customers\/<YOUR_REPOSITORY_ID_HERE>/g' environment

Weiterführende Informationen zur Installation von KIX Pro finden Sie auch im GitHub unter:

KIX On-Premises Update

Für ein Update einer bestehenden KIX-Umgebung aktualisieren Sie bitte die KIX-Docker-Konfiguration. Die Anleitung dazu finden Sie unter https://github.com/cape-it/kix-on-premise/blob/master/deploy/linux/README.md

So aktualisieren Sie KIX (Kurzfassung)

  1. Docker-Konfiguration aktualisieren

    • user@DockerHost: /opt/kix-on-premise/# git pull

  2. KIX aktualisieren

    • user@DockerHost:/opt/kix-on-premise/deploy/linux# ./stop.sh

    • user@DockerHost:/opt/kix-on-premise/deploy/linux# ./update.sh

Achtung

Aktualisieren Sie KIX mit jedem Update! Die Releases greifen ineinander und bauen aufeinander auf. Das Überspringen von Versionen kann zu Funktionslücken und Fehlverhalten führen.

Anmerkung

Beachten Sie, dass Docker einen konservativen Ansatz beim Bereinigen nicht verwendeter Objekte verfolgt. Die Objekte werden im Allgemeinen nicht entfernt, was zu einer Überfüllung des Speichers führen kann. Eine Bereinigung kann mittels prune Befehl erfolgen. Weiterführende Infos finden Sie auf der englischsprachigen Seite: https://docs.docker.com/config/pruning/.

KIX.Cloud Umgebung verwenden

Für die Verwendung einer KIX.Cloud-Umgebung ist keine Installation erforderlich. KIX.Cloud eignet sich daher auch als Testumgebung.

Beantragen Sie unter www.kixdesk.com die Bereitstellung von KIX.Cloud. Wir senden Ihnen per E-Mail den Link zu Ihrem KIX Portal sowie die Zugangsdaten für den Initialbenutzer (admin). Öffnen Sie den Link und loggen Sie sich mit den von uns erhaltenen Zugangsdaten ein.

Nutzen Sie dann den Setup Assistent, um ein neues Admin-Passwort sowie einen "Super User" festzulegen und die Grundkonfiguration von KIX vorzunehmen.

Installation von Erweiterungen

KIX GitHub

Im KIX GitHub stellen wir Ihnen eine Reihe von Informationen und Skripte für KIX 18 und auch für KIX 17 bereit.

In diesem Abschnitt: