Einstieg

Docuvate besteht aus Web-Oberfläche, API und Erkennungsdienst. Diese Seite erklärt Betrieb, Konzepte und Self-Hosting.

Schnellstart mit Docker Compose

  1. Repository klonen und .env.example nach .env kopieren.
  2. Secrets anpassen: BETTER_AUTH_SECRET (mindestens 32 Zeichen), DOCUVATE_CONNECTOR_SECRETS_KEY.
  3. docker compose up --build im Repository-Root. Web unter Port 5173, API unter 3001.
  4. Ersten Benutzer in der Web-Oberfläche registrieren und ein Testdokument hochladen.

Konzepte

Dokumente

Jede Datei hat Status, Vorschau, extrahierten Text und Metadaten. Inhalte liegen in MinIO, Metadaten in PostgreSQL.

Labels

Freie Schlagworte mit Farben. Empfehlungen schlagen Zuordnungen vor; Sie entscheiden über Annahme.

Ordner

Hierarchische Ablage (Dateisystem). Dokumente können mehreren Ordnern zugeordnet sein.

Erkannte Felder

In den Einstellungen legen Sie fest, welche Felder gesucht werden. Vorschläge erscheinen mit Hinweis zur Sicherheit.

Chat

Pro Dokument eigene Unterhaltungen. Den Dienst für Antworten wählen Sie in den Einstellungen.

Verbindungen

Verbindungen binden Quellen wie S3 oder E-Mail an. Zugangsdaten werden verschlüsselt gespeichert.

Self-Hosting-Konfiguration

Relevante Variablen aus `.env.example`. Werte sind Beispiele für lokale Entwicklung.

Datenbank und Cache

VariableBedeutung
DATABASE_URLPostgreSQL-Verbindung für API und Migrationen.
VALKEY_URLValkey (Redis-kompatibel) für Queues und Cache.

Object Storage

VariableBedeutung
MINIO_ENDPOINTHostname des S3-kompatiblen Endpunkts.
MINIO_PORTPort des Storage-Dienstes.
MINIO_ACCESS_KEYZugangsschlüssel für Buckets.
MINIO_SECRET_KEYGeheimer Schlüssel für Buckets.
MINIO_BUCKETBucket-Name für Dokumentdateien (z. B. documents).

Auth und Web

VariableBedeutung
BETTER_AUTH_SECRETSigning-Secret für Sessions (lang und zufällig).
BETTER_AUTH_URLÖffentliche API-URL für Auth-Callbacks.
WEB_ORIGINErlaubter Browser-Origin für CORS und Cookies.
VITE_API_URLAPI-Basis für die Web-App im Dev-Build.

Erkennung und Chat

VariableBedeutung
WORKER_URLInterne URL des Erkennungsdienstes.
WORKER_SECRETGemeinsames Geheimnis zwischen API und Erkennung.
DOCUMENT_CHAT_PROVIDERChat-Backend für Dokumentenfragen.
OLLAMA_URLOptional: Endpunkt für lokale Sprachmodelle.
OLLAMA_MODELOptional: Modellname für lokale Antworten.

Service-API und Verbindungen

VariableBedeutung
DOCUVATE_SERVICE_API_KEYSJSON-Array mit keyId, secret, tenantUserId, claims.
DOCUVATE_CONNECTOR_SECRETS_KEYAES-Schlüssel für Geheimnisse von Verbindungen.
DOCUVATE_GMAIL_OAUTH_CLIENT_IDOptional für die Gmail-Verbindung.
DOCUVATE_OUTLOOK_OAUTH_CLIENT_IDOptional für die Outlook-Verbindung.