Konfiguration¶

mandari wird über Umgebungsvariablen konfiguriert, in der Docker-Installation über die Datei .env. Diese Seite ist die Referenz. Werte in der Spalte Standard gelten, wenn die Variable nicht gesetzt ist.

Pflichtwerte¶

Unter Docker Compose setzt docker-compose.yml ALLOWED_HOSTS, SITE_URL und CSRF_TRUSTED_ORIGINS selbst aus DOMAIN und DATABASE_URL aus den POSTGRES_*-Werten, außerdem DEBUG=false. Eigene Werte dieser Variablen in der .env wirken dort nicht.

Eigene Variablen unter Docker Compose¶

Unter Docker Compose erhält ein Dienst nur die Variablen, die docker-compose.yml ihm nennt; die .env dient dort nur zum Einsetzen von Werten in die Compose-Datei. Viele Variablen dieser Seite reicht docker-compose.yml nicht durch, das steht bei jeder Gruppe.

Ändern Sie dafür nicht die versionierte docker-compose.yml. update.sh holt bei jedem Update den neuen Stand aus Git; mit einer geänderten Datei kann das scheitern, und die Installation läuft dann mit der alten Compose-Datei weiter. Legen Sie stattdessen eine docker-compose.override.yml daneben; das Repository ignoriert sie, und Docker Compose liest sie ohne weitere Angabe mit. Anwendung und Worker teilen sich in docker-compose.yml einen gemeinsamen Block (x-app-environment), auf den der Dienst mandari und die Worker nur verweisen. In der Override-Datei steht eine Variable deshalb bei jedem Dienst, der sie braucht, also für Anwendung und Worker bei mandari, worker, worker-heavy und worker-live:

# docker-compose.override.yml
x-eigene-umgebung: &eigene-umgebung
  EMAIL_HOST: smtp.example.org
  EMAIL_HOST_USER: mandari@example.org
  EMAIL_HOST_PASSWORD: ${EMAIL_HOST_PASSWORD}   # Wert aus der .env

services:
  mandari:
    environment: *eigene-umgebung
  worker:
    environment: *eigene-umgebung
  worker-heavy:
    environment: *eigene-umgebung
  worker-live:
    environment: *eigene-umgebung

Compose ergänzt die Umgebung dieser Dienste um die Einträge; danach docker compose up -d. Ist COMPOSE_FILE gesetzt (Betrieb auf mehreren Servern), liest Compose die Override-Datei nicht von selbst; dann gehört sie mit in diese Liste. Im Helm-Chart gehören solche Variablen in app.extraEnv (Anwendung und Worker) bzw. ingestor.extraEnv.

Allgemein¶

Unter Docker Compose wirken aus dieser Tabelle TZ und ENCRYPTION_MASTER_KEY_PREVIOUS, die docker-compose.yml an die Dienste weiterreicht, sowie IMAGE_TAG und COMPOSE_PROJECT_NAME, die die Compose-Datei selbst liest; DEBUG steht dort fest auf false. Die übrigen tragen Sie unter Docker Compose in einer docker-compose.override.yml (siehe Eigene Variablen unter Docker Compose) ein, im Helm-Chart in app.extraEnv; ein Eintrag nur in der .env wirkt nicht.

Anmeldung und Zugriffsschutz¶

Keine dieser Variablen reicht docker-compose.yml durch. Im Standard gilt also die Pflicht zum zweiten Faktor; abweichende Werte gehören unter Docker Compose in einer docker-compose.override.yml (siehe Eigene Variablen unter Docker Compose), im Helm-Chart in app.extraEnv. Für die Bedienung siehe Konto und Sicherheit.

E-Mail¶

Den SMTP-Zugang pflegen Sie am einfachsten im Admin in den Systemeinstellungen; die Variablen EMAIL_* gelten nur, wenn dort nichts hinterlegt ist. Organisationen in Work können zusätzlich einen eigenen SMTP-Zugang hinterlegen.

docker-compose.yml reicht von diesen nur DEFAULT_FROM_EMAIL, EMAIL_MESSAGE_ID_DOMAIN, MAIL_QUEUE, MAIL_QUEUE_MAX_BYTES und INSIGHT_ALERT_EMAILS durch. Für den SMTP-Zugang unter Docker Compose deshalb die Systemeinstellungen nutzen oder die EMAIL_*-Variablen in einer docker-compose.override.yml (siehe Eigene Variablen unter Docker Compose) eintragen.

Datenbank, Cache, Suche¶

PostgreSQL im Compose-Stack. Diese Werte liest docker-compose.yml selbst aus der .env. Die Einstellungen von PostgreSQL wirken erst, wenn der Datenbankdienst neu startet (docker compose up -d postgres):

Die DB_POOL*- und DB_CONN_MAX_AGE-Werte und ELASTICSEARCH_AUTO_INDEX reicht docker-compose.yml nicht an die Anwendung weiter; abweichende Werte gehören unter Docker Compose in einer docker-compose.override.yml (siehe Eigene Variablen unter Docker Compose), im Helm-Chart in app.extraEnv.

Volltextsuche¶

docker-compose.yml reicht alle außer SEARCH_NAME_PART_MAX_DOCS durch.

Worker, Aufträge und Ereignisse¶

Die Dienste worker, worker-heavy und worker-live führen Aufträge, die Ereignistechnik der Datendrehscheibe und die Zeitpläne aus.

docker-compose.yml reicht alle durch außer EVENTS_IDEMPOTENCY_RETENTION_DAYS und WORKER_PUSH_INTERVAL; WORKER_HEAVY_* liest die Compose-Datei selbst, WORKER_SERVICES das Skript update.sh. Im Helm-Chart heißen die wichtigsten events.producers, events.changesFeed, events.journalPurge und worker.*, siehe Betrieb in Kubernetes.

Datendrehscheibe: schrittweise Umstellungen¶

Diese Schalter stellen einzelne Aufgaben schrittweise auf Ereignisse und Abonnements um. Standard ist überall aus; schatten bzw. probe arbeitet neben dem bisherigen Weg und vergleicht nur. Alle brauchen den Worker; Voraussetzungen und Reihenfolge beim Umschalten beschreibt DEPLOYMENT.md im Repository.

docker-compose.yml reicht alle durch.

Texterkennung¶

Die Erkennung liest zuerst die Textebene des PDFs, dann, falls eingerichtet, den externen Dienst, sonst und als Rückfall die lokale Texterkennung mit Tesseract. docker-compose.yml reicht TEXT_EXTRACTION_RUNNER, TEXT_EXTRACTION_QUEUE_DEPTH, OCR_MEMORY_LIMIT_MB, MISTRAL_API_KEY und MISTRAL_BASE_URL durch, die übrigen nicht. Umstellen auf worker: Ablauf „Dokumentkette einschalten“ in DEPLOYMENT.md im Repository.

KI¶

docker-compose.yml reicht alle durch.

OParl-Aggregations-API¶

docker-compose.yml reicht nur OPARL_CHANGES_ENABLED, OPARL_CHANGES_RETENTION_DAYS und OPARL_SNAPSHOT_PARALLEL durch. Fehler des Änderungsfeeds beschreibt Fehlertypen der Schnittstellen.

Offene Daten und Suchmaschinen¶

docker-compose.yml reicht nur INDEXNOW_KEY durch, an Anwendung, Worker und Website.

Dokument-Cache und Quellen-Schonung¶

FILE_CACHE_MAX_MB, FILE_PROXY_TIMEOUT_SECONDS, RIS_REQUEST_INTERVAL und INSIGHT_SOURCE_BACKOFF_FAILURES reicht docker-compose.yml nicht durch. Tragen Sie sie unter Docker Compose in x-app-environment ein, im Helm-Chart in app.extraEnv; ein Eintrag nur in der .env wirkt nicht.

Details unter Dokument-Cache.

Dokumentablage und Objektspeicher¶

docker-compose.yml reicht FILE_STORE_LAYOUT, INGESTOR_STORES_FILES, FILE_CACHE_MAX_TOTAL_GB, FILE_CACHE_EVICT_TARGET_PERCENT, FILE_ACCEL_REDIRECT, INSIGHT_FETCH_ALLOW_PRIVATE_NETWORKS sowie OBJ_ENABLED, OBJ_ENDPOINT, OBJ_BUCKET, OBJ_KEY, OBJ_SECRET, OBJ_REGION, OBJ_CACHE_MAX_GB und OBJ_CHECKSUMS durch, die übrigen nicht. Die Zugangsdaten des Objektspeichers können auch in einer eigenen Umgebungsdatei liegen: docker compose --env-file .env --env-file <datei> up -d.

Quellenüberwachung¶

Details unter Betriebsmonitor.

Betriebsprüfungen und Metriken¶

Die Alarme gehen an INSIGHT_ALERT_EMAILS. docker-compose.yml reicht nur METRICS_URL und GATUS_URL durch.

Bürgerportal¶

docker-compose.yml reicht nur INSIGHT_SUBSCRIPTIONS_ENABLED und INSIGHT_QUESTIONS_ENABLED durch.

Session, Work und Protokollierung¶

docker-compose.yml reicht keine davon durch.

Live-Übertragungen¶

docker-compose.yml reicht LIVE_UEBERTRAGUNG_AKTIV und LIVE_PROTOKOLL_TAGE durch, im Helm-Chart heißt der Schalter liveStreams.enabled.

Ingestor¶

INGESTOR_INTERVAL, INGESTOR_FULL_SYNC_HOUR, INGESTOR_CONCURRENT, INGESTOR_SYNC_POOL_SIZE und INGESTOR_MEM_LIMIT liest docker-compose.yml aus der .env; im Helm-Chart heißen die ersten drei ingestor.syncInterval, ingestor.fullSyncHour und ingestor.concurrent, INGESTOR_SYNC_POOL_SIZE gehört dort in ingestor.extraEnv. Die übrigen Variablen der Tabelle reicht es nicht durch: Tragen Sie sie unter Docker Compose im Abschnitt environment des Dienstes ingestor ein, im Helm-Chart in ingestor.extraEnv; ein Eintrag nur in der .env wirkt nicht. Die Sync-Aktionen an einer Quelle im Admin gehen an den Ingestor, solange er läuft; ohne ihn und für abgeschaltete Quellen laufen sie im Worker der Anwendung. Setzen Sie INGESTOR_USER_AGENT, INGESTOR_REQUEST_INTERVAL und INGESTOR_HOST_MAX_CONCURRENT deshalb auch dort, unter Docker Compose in x-app-environment, im Helm-Chart in app.extraEnv; sonst ruft der Worker mit der Standardkennung samt support@mandari.de ab.

Details unter Quellen anbinden, Regeln für den Abruf unter Ingestor und Opt-out.