Einstieg
Docuvate besteht aus Web-Oberfläche, API und Erkennungsdienst. Diese Seite erklärt Betrieb, Konzepte und Self-Hosting.
Schnellstart mit Docker Compose
- Repository klonen und
.env.examplenach.envkopieren. - Secrets anpassen: BETTER_AUTH_SECRET (mindestens 32 Zeichen), DOCUVATE_CONNECTOR_SECRETS_KEY.
docker compose up --buildim Repository-Root. Web unter Port 5173, API unter 3001.- 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
| Variable | Bedeutung |
|---|---|
DATABASE_URL | PostgreSQL-Verbindung für API und Migrationen. |
VALKEY_URL | Valkey (Redis-kompatibel) für Queues und Cache. |
Object Storage
| Variable | Bedeutung |
|---|---|
MINIO_ENDPOINT | Hostname des S3-kompatiblen Endpunkts. |
MINIO_PORT | Port des Storage-Dienstes. |
MINIO_ACCESS_KEY | Zugangsschlüssel für Buckets. |
MINIO_SECRET_KEY | Geheimer Schlüssel für Buckets. |
MINIO_BUCKET | Bucket-Name für Dokumentdateien (z. B. documents). |
Auth und Web
| Variable | Bedeutung |
|---|---|
BETTER_AUTH_SECRET | Signing-Secret für Sessions (lang und zufällig). |
BETTER_AUTH_URL | Öffentliche API-URL für Auth-Callbacks. |
WEB_ORIGIN | Erlaubter Browser-Origin für CORS und Cookies. |
VITE_API_URL | API-Basis für die Web-App im Dev-Build. |
Erkennung und Chat
| Variable | Bedeutung |
|---|---|
WORKER_URL | Interne URL des Erkennungsdienstes. |
WORKER_SECRET | Gemeinsames Geheimnis zwischen API und Erkennung. |
DOCUMENT_CHAT_PROVIDER | Chat-Backend für Dokumentenfragen. |
OLLAMA_URL | Optional: Endpunkt für lokale Sprachmodelle. |
OLLAMA_MODEL | Optional: Modellname für lokale Antworten. |
Service-API und Verbindungen
| Variable | Bedeutung |
|---|---|
DOCUVATE_SERVICE_API_KEYS | JSON-Array mit keyId, secret, tenantUserId, claims. |
DOCUVATE_CONNECTOR_SECRETS_KEY | AES-Schlüssel für Geheimnisse von Verbindungen. |
DOCUVATE_GMAIL_OAUTH_CLIENT_ID | Optional für die Gmail-Verbindung. |
DOCUVATE_OUTLOOK_OAUTH_CLIENT_ID | Optional für die Outlook-Verbindung. |