Drupal-Chatbot-Modul

Verwenden Sie das offizielle ChattyBox-Drupal-Modul, wenn Sie eine Composer-verwaltete Installation für eine Drupal-10- oder Drupal-11-Site wünschen. Es lädt das gehostete Widget auf öffentlichen HTML-Routen und konfiguriert den Produktions-API-Endpunkt automatisch. Diese Anleitung behandelt die operative Einrichtung. Die Seite zum Drupal-KI-Chatbot-Modul stellt das Produkt und den Evaluierungsworkflow vor.

Vor der Installation

Schließen Sie zuerst den Ablauf Erste Schritte ab: Verbinden Sie Ihre öffentliche Drupal-URL, überprüfen Sie indexierte Seiten und verifizieren Sie repräsentative Antworten in Test Chat. Erstellen Sie anschließend unter Public Keys einen browsersicheren öffentlichen Schlüssel und kopieren Sie ihn aus dem Projekt-Tab Embed.

Composer-Installation

Das Modul wird derzeit als getaggtes Paket im öffentlichen GitHub-Repository verteilt. Es ist noch nicht auf Drupal.org oder Packagist gelistet. Daher benötigt Composer vor composer require den folgenden VCS-Repository-Eintrag.

Fügen Sie das öffentliche GitHub-Repository zur composer.json-Datei im Stammverzeichnis des verwendenden Drupal-Projekts hinzu:

{
  "repositories": {
    "chattybox-drupal": {
      "type": "vcs",
      "url": "https://github.com/OpenStaticFish/chattybox-drupal.git"
    }
  }
}

Wenn das Projekt bereits einen Abschnitt repositories besitzt, führen Sie den Eintrag chattybox-drupal dort zusammen. Installieren Sie anschließend das markierte Modul:

composer require openstaticfish/chattybox-drupal:^0.1

Das Paket ist als drupal-module deklariert und benötigt Drupal ^10 || ^11. Die standardmäßigen Drupal-Composer-Installationspfade legen es unter web/modules/contrib/ ab.

Prüfen Sie vor einem Upgrade den öffentlichen Quellcode des Drupal-Moduls und die getaggten Änderungen. Von Drupal.org verwaltete Updates aus dem Verzeichnis sind noch nicht verfügbar.

Um stattdessen den aktuellen Entwicklungs-Branch zu testen:

composer require openstaticfish/chattybox-drupal:dev-main

Aktivieren und konfigurieren

1. Aktivieren Sie ChattyBox unter Extend oder führen Sie drush en chattybox aus.
2. Öffnen Sie Configuration > Web services > ChattyBox.
3. Fügen Sie nur den öffentlichen Widget-API-Schlüssel aus dem Projekt-Tab Embed ein.
4. Belassen Sie die URL des gehosteten Widget-Skripts, sofern ChattyBox Ihnen keine Vorschau- oder selbst gehostete Loader-URL bereitgestellt hat.
5. Lassen Sie den Override leer, damit die Projekt-Policy gilt, oder verwenden Sie einen unterstützten Kleinbuchstabencode. Im Auto-Modus geht Seitensprache vor Browsersprache, im Fixed-Modus gilt die Default-Locale; ein Override wirkt nur, wenn das Projekt ihn erlaubt.
6. Aktivieren Sie den Chatbot und speichern Sie die Konfiguration.

Das Modul wird auf Verwaltungsrouten oder bei Nicht-HTML-Antworten nicht geladen. Es fügt öffentlichen Schlüssel, verwalteten Produktionsendpunkt, optionale Sprache und Widget-Loader über Drupals deklarierte Bibliothek und drupalSettings hinzu. Diese Guards sind keine Datenschutzprüfung für jeden Frontend-Inhalt: Schließen Sie Checkout-, Konto- und Mitglieder-Routen ausdrücklich aus. Das Modul crawlt oder synchronisiert keine Drupal-Inhalte.

Weitere Routen ausschließen

Das Modul überspringt Verwaltungsrouten automatisch. Ein benutzerdefiniertes Modul kann das Widget auf weiteren öffentlichen Routen mit hook_chattybox_load_widget_alter() deaktivieren:

Eine serverseitige Routenausnahme entfernt kein Widget, das bei einer clientseitigen Navigation bereits geladen wurde.

/**
 * Implements hook_chattybox_load_widget_alter().
 */
function mymodule_chattybox_load_widget_alter(&$should_load, $config, $route_match) {
  if ('commerce_checkout.form' === $route_match->getRouteName()) {
    $should_load = FALSE;
  }
}

Manueller Fallback

Composer ist der empfohlene Installationsweg. Wenn Ihr Drupal-Deployment Composer nicht verwenden kann, kopieren Sie das Modul nach web/modules/custom/chattybox oder in ein anderes Verzeichnis für benutzerdefinierte Module, aktivieren Sie es und konfigurieren Sie es unter Configuration > Web services > ChattyBox.

Fügen Sie keine Verwaltungseinstellung in das Modul ein. Der öffentliche Widget-API-Schlüssel ist für Frontend-Markup vorgesehen.

Überprüfung

Nach der Konfiguration des Moduls:

• Öffnen Sie eine öffentliche Drupal-Seite in einem Inkognito-Fenster.
• Bestätigen Sie, dass der Widget-Launcher einmal erscheint.
• Stellen Sie eine echte Besucherfrage.
• Prüfen Sie, dass eine unterstützte Antwort indexierte Drupal-Seiten zitiert und eine nicht unterstützte Frage den Fallback zeigt, der keine Quellen haben kann.
• Prüfen Sie die Browserkonsole auf fehlendes data-api-key, data-api-url oder Schlüssel-Fehler. Testen Sie ausgeschlossene und eingeschlossene Routen mit warmen und kalten Caches; bauen Sie nach Hook-/Einstellungsänderungen relevante Caches neu auf.

Arbeiten Sie die Launch-Checkliste ab, bevor Sie den Chatbot ankündigen.