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

Wichtig

Zwischen Client (Browser) und Frontend-Server findet eine Websocket-Kommunikation statt. Das heißt, dazwischenliegende Systeme (RevProxy u.ä.) müssen Websockets unterstützen.

Tragen Sie als Administrator dafür Sorge, dass eine ungestörte und performante Verbindung via Websockets zwischen Clients und Frontend gegeben ist, um keine signifikanten Performanceeinbußen oder Fehler zu provozieren. Ein Rückfall auf HTTP/s erfolgt zwar, hat aber spürbare Nebeneffekte und wird explizit nicht empfohlen.

System

Für ein neues System empfehlen wir einen Docker-Host mit folgenden Mindestvoraussetzungen:

  • RAM: 8 GB

  • CPU: 4 Kerne

  • mehrere leistungsfähige und gut funktionierende Festplatten (bitte keine einzelnen SATA-Festplatten mit niedrigen Umdrehungen!)

Ausgehend von folgenden Indikatoren:

  • 1.000 neue Tickets pro Monat

  • 20 bis 30 Agenten-Nutzer (davon 10 bis 15 gleichzeitig)

  • bis zu 10.000 Assets

  • 500 Organisationen und 500 Kontakten

Benötigen Sie einen Docker-Host mit:

  • RAM: 16 GB

  • CPU: mindestens 4 Kerne

  • mehrere leistungsfähige und gut funktionierende Festplatten (bitte keine einzelnen SATA-Festplatten mit niedrigen Umdrehungen!)

Weiterführende Informationen s. auch: https://github.com/cape-it/kix-on-premise/blob/master/deploy/linux/README.md

Server

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

  • RHEL

  • Debian

  • Ubuntu

Stellen Sie sicher, dass Docker stabil und sicher auf Ihrem Host-System läuft.

Hinweis: Obwohl neuere Docker-Versionen Compose als Plugin enthalten, verwenden nicht alle Host-Betriebssysteme diese neuen Versionen. Daher ist es erforderlich, Compose als eigenständige Version und nicht als Plugin zu installieren.

Client

Auf Client-Seite benötigen Sie einen standardüblichen Browser wie Firefox, Chrome, MS Edge usw. in der aktuellen Version.

Field Agent App

Die Field Agent App unterstützt die Betriebssysteme iOS und Android in der jeweils aktuellen Version.

Fehlerbehandlung

Problem: KIX startet nicht nach der ersten Installation

Wenn Sie KIX frisch mit einem PostgreSQL DBMS installiert haben und es zum ersten Mal starten, kann es vorkommen, dass die DB nicht richtig initialisiert wird. Möglicherweise finden Sie in Ihren Protokollen einen Eintrag ähnlich diesem:

FATAL:  no pg_hba.conf entry for host "172.20.0.4", user "kixdbuser", database "kixdb", SSL off

Dies wird häufig durch falsche Dateiberechtigungen in Ihrer postgresql.conf verursacht.

  1. Bitte überprüfen Sie Ihre Dateirechte.

  2. Weisen Sie entweder den postgres-Benutzer als Eigentümer der Datei zu oder überprüfen Sie, ob andere Personen Leserechte auf Ihre Datei haben, indem Sie chmod o+r postgresql.conf ausführen.

  3. Nachdem Sie die Dateiberechtigungen überprüft haben, stoppen Sie eventuell noch laufende Container mit stop.sh.

  4. Löschen Sie das entsprechende Docker-Volume des DB-Containers.

    Warnung

    Das Löschen des Docker-Volumes führt zu Datenverlusten!

    Diese Lösung verursacht nur dann keinen Datenverlust, wenn der Fehler beim ersten Start nach der Installation auftritt!

  5. Starten Sie Ihren Stack erneut über start.sh.

Besuchen Sie unser KIX Forum für mehr Informationen: KIX Forum

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 eine aktuelle Docker-Version mit Docker-Compose. 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 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.

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: