Dokumentation

Alles, was du brauchst, um zu liefern

Stöbere in der Dokumentation für Simmetric Chat - vom ersten Prompt bis zum Produktions-Deployment.

Wiki knowledge engine — Archive mit Schema, Wikilinks und Synthese

Die Wiki-Engine gibt jedem Archiv ein dreistufiges Instruktionsmodell: harte Regeln, vom Code erzwungen, ein pro-Archiv-Schema-Prompt (advisorische redaktionelle Leitlinien) und strukturierte Felder (persona, purpose, scope). Mentales Modell: schemaPromp…

Synthese-Pipeline — Dokumente vereinen, Widersprüche aufdecken

Die Multi-Dokument-Synthese-Pipeline nimmt einen Satz Seiten/Dokumente aus einem Archiv und erzeugt vereinte Wiki-Seiten: jede Seite synthetisiert die Quellen, meldet, wo die Quellen nicht übereinstimmen (contradiction detection), respektiert die Budgets…

Quotas und Kosten — Nutzungs- und Ausgaben-Obergrenzen

Die Quota-Engine deckt drei Gattungen ab: die Token-Quota und die Storage-Quota (Phase 207) samt der Kosten-Quota (Phase 216, hold-and-settle über die echte-Geld-Mathematik). Die Quotas sind das Betreiberwerkzeug für Nutzungsobergrenzen in Mehrbenutzer-I…

DLP-Pipline für Dokumente — Betreiber-Anleitung

Wenn die DLP-Untersuchung für einen Workspace aktiviert ist, durchläuft jedes hochgeladene Dokument nach der Ingestion eine asynchrone pg-boss-Untersuchung:

Connectoren — externe Kanäle, verbunden mit der Knowledge Base

Connectoren verbinden die Messaging-Kanäle, auf denen Ihre Kunden und Kollegen ohnehin schon sind — WhatsApp, Telegram, Discord, Slack — mit derselben Knowledge Base, die auch den internen Chat speist. Die Gespräche bleiben auf Ihren Servern: die App fra…

Custom skills — eigene Anweisungen, aufrufbar per `/slug`

Eine Custom-Skill ist ein Prompt-Template, das ein Betreiber oder Benutzer einmal zusammenstellt und aus dem Chat heraus unbegrenzt als Slash-Befehl aufruft (/translate Hallo Welt). Skills sind nur prompt-template-Fähigkeit: der Aufruf kompiliert das ges…

Erste Schritte

Simmetric Chat ist eine lokale, air-gap-fähige KI-Chat-Plattform: sie funktioniert ohne Verbindung zu externen Cloud-Diensten, mit lokalem LLM (Ollama), lokalen Embeddings (Xenova) und lokaler Vektor-DB (LanceDB). Sie kann jedoch Cloud-Anbieter (OpenAI, …

Architektur

Simmetric Chat ist ein modulares TypeScript-Monorepo mit 5 Packages plus einer Tauri-Desktop-App. Das Leitprinzip ist die Trennung der Grenzen: Jedes Package hat eigene Zuständigkeiten und kommuniziert mit den anderen nur über wohldefinierte Schnittstell…

Konfiguration

Simmetric Chat hat zwei Konfigurationsebenen: Umgebungsvariablen, die beim Prozessstart mit Zod validiert werden, und eine Laufzeit-Konfigurationsebene in der Datenbank, die Admins über die Benutzeroberfläche bearbeiten können, ohne einen Dienst neu zu s…

API-Referenz

REST-API des Express-Servers (Port 3000, Präfix /api), mit interaktiver Swagger-UI und einer OpenAPI-Spec, die vom Server selbst ausgeliefert wird, hier nach Domäne dokumentiert mit ihren Authentifizierungsmechanismen, Rate-Limits und Antwortkonventionen.

Funktionsübersicht

Übersicht der Features mit Internals, Datenfluss und file:line-Referenzen. Für jedes Feature: wie es funktioniert, wie man es nutzt, wie man es erweitert.

Widget-Integration

Das einbettbare Widget ist ein separater Service (packages/widget, Port 3211), der einen AI-Chat auf deiner Website bereitstellt. Architektur: Express + Preact IIFE im sandboxed iframe, transparenter SSE-Proxy zum Server, anonyme Sessions, Lead Capture, …

MCP Marketplace

Der MCP Marketplace ermöglicht die Installation, Aktivierung und das Scoping externer MCP-Server aus einem kuratierten Katalog. MCP-Server stellen Tools bereit, die der ReAct-Agent während der Chats aufrufen kann, wodurch die Fähigkeiten ohne Code erweit…

Administration

Betriebshandbuch für Administratoren: Benutzer, Rollen (RBAC), Workspaces, Audit, Lizenzen und administrative Backups. Alle Operationen erfordern authMiddleware plus spezifische Berechtigungen - siehe die API Reference für das vollständige Endpoint-Inven…

Deployment

Simmetric Chat ist air-gap capable und local-first. Fünf Deployment-Ziele: Docker Compose multi-container (empfohlen für Produktion), Single-Container all-in-one (Air-Gap-Umgebungen), verwalteter Coolify-Stack, Dev-Override (Hot-Reload auf Docker) und De…

Entwicklung

Leitfaden für Beiträge zum Codebase: Setup, Monorepo-Struktur, Skripte, Konventionen, i18n.

Testing

Simmetric Chat nutzt Jest 30 mit @swc/jest-Transformation (Unit + Integration) und Playwright (E2E), orchestriert von Turborepo. Die Root-Konfiguration jest.config.cjs aggregiert die 5 Projekte (shared, server, frontend, collector, widget).

Troubleshooting

Häufige Symptome, Ursache, Lösung. file:line-Referenzen und Cross-Links zu den Docs.

Interaktive API-Dokumentation

Swagger / OpenAPI 3.0 werden bereitgestellt unter /api-docs wenn der Server läuft.