Repository navigation
plugins
Customer Service Portal · Startseite · Installation · Konfiguration · Betrieb
| Paket | ID | Funktionen | Produktionskonfiguration |
|---|---|---|---|
@kieksme/csp-plugin-contact |
contact |
Notfall-Hotline und Kontakt-Wissensquelle | CSP_CONTACT_PHONE |
@kieksme/csp-plugin-signl4 |
signl4 |
Teamprofile, Bilder, vCards, Schichten und Alerts | API-Key und Team-ID |
@kieksme/csp-plugin-kuma |
kuma |
Monitorstatus und Vorfall der veröffentlichten Statusseite | URL und Statusseiten-Slug |
@kieksme/csp-plugin-content |
content |
Prozesse, Ticketlinks/-vorlagen, FAQ und Chat-Quellen | CSP_CONTENT_PATH |
@kieksme/csp-plugin-chat |
chat |
Gestreamte Antworten aus statischen und Live-Quellen | Provider, Modell und gegebenenfalls API-Key |
Die Plugins contact, signl4, kuma, content und chat stellen zusätzlich WebMCP-Tools für Browser-Agenten bereit: signl4_* (Dienst, Schichtplan, Team, vCard, Alerts), kuma_get_status, contact_get_hotline, content_* (FAQ, Prozesse, Ticketvorlagen) und chat_ask; die Teams-, Slack- und Telegram-Plugins stellen keine Tools bereit. Die Liste mit Parametern steht unter WebMCP. Mit dem Hinzufügen oder Entfernen eines Plugins ändern sich die Tools automatisch; public.webmcp: false schaltet sie ab.
apps/demo registriert alle fünf Plugins. apps/northstar und templates/customer registrieren Kontakt, Inhalte und Chat. Teams, Slack und Telegram benötigen chat; die übrigen mitgelieferten Plugins haben keine verpflichtenden Plugin-Abhängigkeiten; der Chat verwendet die Wissensquellen der tatsächlich installierten Plugins.
Im eigenständigen Kundenrepo:
pnpm dlx @kieksme/csp-cli plugin list
pnpm dlx @kieksme/csp-cli plugin add @kieksme/csp-plugin-signl4
pnpm dlx @kieksme/csp-cli plugin add @kieksme/csp-plugin-kuma
pnpm dlx @kieksme/csp-cli plugin remove @kieksme/csp-plugin-kumaadd akzeptiert auch eine Paketversion, beispielsweise @kieksme/csp-plugin-kuma@<version>; <version> durch die verwendete Release-Version ersetzen. Für remove den Paketnamen ohne Versionsangabe verwenden. Alle Pakete der Produktfamilie sollten auf demselben Release-Stand bleiben.
Die CLI führt pnpm add --save-exact beziehungsweise pnpm remove aus, überprüft Plugin-Metadaten und erzeugt portal.plugins.json, portal.browser.ts und portal.server.ts. Paketdatei, Lockfile und Registrierungen bleiben synchron. Fehlgeschlagene Änderungen stellen gesicherte Dateien wieder her und versuchen, den vorherigen Dependency-Baum zu installieren.
Vor dem Hinzufügen muss das Paket cspPlugin-Metadaten und Browser-/Server-Exporte bereitstellen. IDs, SDK-Kompatibilität und requires werden geprüft. Entfernen wird abgelehnt, wenn ein verbleibendes Plugin von der entfernten ID abhängt.
Provider-Variablen am API-Host ergänzen oder entfernen, Frontend und API neu bauen und deployen. Ein bloßes Installieren des Pakets aktiviert weder seine Oberfläche noch seine Routen; die Registrierung muss mit aktualisiert werden. Generierte TypeScript-Registrierungen deshalb über die CLI pflegen.
Plugin-Mutationen sind in einem übergeordneten pnpm-Workspace nicht erlaubt. Eine pnpm-workspace.yaml mit reinen pnpm-Einstellungen ist in einem eigenständigen Kundenrepo zulässig; eine eigene Workspace-Paketliste wird abgelehnt.
Weiter: Plugin-SDK, Konfiguration, API.
@kieksme/csp-plugin-teams benötigt chat, registriert Gesprächs- und Bot-Routen bei Aktivierung und hat keine eigene Browser-Sektion. Die Chat-UI nutzt chatSupport im Profil. Einrichtung und Demo.
@kieksme/csp-plugin-slack benötigt chat, hat keine eigene Browser-Sektion und nutzt dieselben authentifizierten Gesprächsrouten wie Teams. Zusätzlich registriert es signierte Slack-Events und Button-Aktionen. chatSupport.mode: "slack" aktiviert die gemeinsame Support-UI; pro Instanz ist genau ein Supporttransport zulässig. Installation, Manifest, Berechtigungen und Demo.
@kieksme/csp-plugin-telegram benötigt chat und nutzt die gemeinsame Support-UI ohne zusätzliche Browser-Sektion. chatSupport.mode: "telegram" wählt diesen Transport; anonyme Besuchersitzungen und Entra sind verfügbar. Ein Thema je Gespräch in einer Forum-Supergruppe, Secret-geschützte Webhooks, dauerhafte Inbox und aktuelle Mitgliedschaftsprüfung. Einrichtung und Architektur.
@kieksme/csp-plugin-datadog zeigt Cases, Monitorstatus, SLOs und On-Call-Schichten. Es hat keine verpflichtenden Plugin-Abhängigkeiten und liefert eigene Wissensquellen sowie synthetische Browser-Daten. Einrichtung und API.
@kieksme/csp-plugin-swetrix adds anonymous browser analytics with no visible portal section. Configure the public project ID, HTTPS ingestion endpoint and variant through analytics.swetrix. See Swetrix analytics for events, funnels and privacy defaults. Browser plugins can provide an optional integration component for invisible integrations; Core mounts it with BrowserContext and React runs its cleanup when unmounted.
Customer Service Portal · Quellcode · Releases · Fehler melden · MIT-Lizenz
Diese Dokumentation stammt aus docs/ des im Wiki-Abgleich verwendeten Release-Tags. Änderungen bitte im Produktrepo vornehmen; verwaltete Wiki-Seiten werden beim nächsten Abgleich überschrieben.
Customer Service Portal