Installation¶
Es gibt zwei Möglichkeiten ein Plugin zu installieren. In der globalen Variante verlinken Sie ein fertig entwickeltes Plugin für alle Nutzer Ihrer LiveChat Umgebung. Im Entwicklermodus können Sie einen lokalen Ordner einbinden um Ihr Plugin weiterzuentwickeln.
Globale Konfiguration¶
Gültig für: | Agentenclient, Multimedia Business Card, Portal, Widget |
---|
In Ihrer Konfigurationsdatei (config.json
) können Sie beliebige Plugins verlinken. Diese Plugins
stehen daraufhin allen Agenten zur Verfügung.
Die Plugins müssen als ZIP Archive verlinkt werden. Hier ein Beispiel für eine Konfiguration:
{
"app": {
"plugins": [
"https://<yourserver>/plugins/plugin1.zip",
"https://<yourserver>/plugins/plugin2.zip"
]
}
}
Warning
Achten Sie darauf, dass der Webserver von dem die Plugins geladen werden, ein gültiges SSL Zertifikat besitzt und CORS unterstützt.
Anleitungen wie Sie CORS bei Ihrem Webserver aktivieren, finden Sie hier.
Entwicklermodus¶
Um ein Plugin neu- oder weiterzuentwickeln können Sie lokale Plugins installieren.
Für die Clients Multimedia Business Card, Portal, Widget können Sie den Entwicklermodus
mit dem GET Parameter ?lc-developer-mode=true
aktivieren.
Manuelle Installation¶
Sie können im Agentenclient unter Einstellungen -> Plugins über einen Ordner auf Ihrer Festplatte auswählen. Dieser Ordner muss das entpackte Plugin enthalten.
Für die Clients Multimedia Business Card, Portal, Widget müssen Sie den Entwicklermodus
mit dem GET Parameter ?lc-developer-mode=true
. Unter Einstellungen -> Plugins können Sie dann ebenfalls Plugins
manuell hinzufügen.
Nach einer Änderung an Ihrem Code können Sie das Plugin auf dem selben Weg aktualisieren.
Warning
Die Installation ist nur temporär. Nach einem Browser Refresh müssen Sie das Plugin erneut hinzufügen.
Automatische Installation¶
Neben der manuellen Installation können Sie auch das livechat-development
Tool verwenden. Dieses Tool sorgt dafür,
dass das Plugin automatisch in Ihrem LiveChat Client aktualisiert wird sobald Sie Codeänderungen vornehmen.
Voraussetzung für das Tool ist node.js (wir empfehlen die aktuelle LTS Version).
Installieren Sie das Tool mit:
npm install -g @estos/livechat-development
Und starten Sie es anschließend in Ihrem lokalen Plugin Verzeichnis:
cd <your plugin folder>
livechat-development
Anschließend aktivieren Sie im Agentenclient unter Einstellungen -> Plugins den Entwicklermodus.
Für die Clients Multimedia Business Card, Portal, Widget können Sie den Entwicklermodus
über den GET Parameter ?lc-developer-mode=true
aktivieren. Ihr Plugin wird daraufhin automatisch installiert und bei
jeder Codeänderung automatisch aktualisiert.
Für weitere Informationen, lesen Sie auch die Dokumentation des livechat-development Tools.