Konfigurationsreferenz

EntityFlow wird vollständig über Umgebungsvariablen konfiguriert. Boolesche Variablen akzeptieren 1, true, yes oder on (ohne Beachtung der Groß-/Kleinschreibung); alles andere wird als falsch behandelt.

Bereitstellung und Lizenz

Variable	Standardwert	Zweck
EF_DEPLOYMENT	self-host	Bereitstellungsmodus: saas oder self-host.
EF_LICENSE_KEY	—	Signierter Offline-Lizenz-Schlüssel, der Add-ons für selbst gehostete Instanzen freischaltet. SYILAB stellt ihn aus; kopieren Sie ihn unter Lizenzen in Ihrem EntityFlow Hub.
EF_LICENSE_CHECKIN_ENABLED	false	Aktiviert die optionale Online-Lizenzregistrierung.

EntityFlow Hub

Variable	Standardwert	Zweck
EF_HUB_URL	https://hub.entityflow.dev	Wohin das Kontomenü (Konto verwalten) und die Upgrade-Hinweise die Personen weiterleiten — Ihr EntityFlow Hub.
EF_OFFICE_KEY	—	Optional, mindestens 24 Zeichen. Aktiviert die Plattform-API, über die EntityFlow Office und EntityFlow Hub diese Instanz verwalten. Ist die Variable nicht gesetzt, existiert diese API nicht (sie antwortet mit 404).

Datenbank

Variable	Standardwert	Zweck
EF_DIAGRAM_DB_URL	— (erforderlich)	Verbindungszeichenfolge für die Diagrammebene.
DATABASE_URL	—	Alias für EF_DIAGRAM_DB_URL.
EF_CONTROL_DB_URL	—	PostgreSQL-Steuerungsebene; erforderlich, wenn die Diagrammdatenbank nicht Postgres ist.
EF_DB_POOL_MAX	10	Maximale Anzahl an Verbindungen im Datenbankpool.
EF_DB_MIGRATE_ON_BOOT	true	Führt Migrationen beim Start automatisch aus.

Netzwerk

Variable	Standardwert	Zweck
EF_PORT	8787	HTTP-Port (tRPC + REST).
EF_WS_PORT	8788	Hocuspocus-WebSocket-Port.
EF_AUTH_BASE_URL	http://localhost:8787	Öffentliche Basis-URL, die für Auth-Callbacks verwendet wird.
EF_WEB_ORIGIN	http://localhost:5173	Zulässiger Web-Origin (CORS).

Authentifizierung und Mandantenfähigkeit

Variable	Standardwert	Zweck
EF_AUTH_SECRET	—	In der Produktion erforderlich; Sitzungsgeheimnis mit mindestens 32 Zeichen.
EF_AUTH_RP_ID	localhost	Relying-Party-ID für Passkeys/WebAuthn.
EF_PG_RLS	false	Aktiviert die Sicherheit auf Zeilenebene von PostgreSQL.

E-Mail

Die Anmeldung ist passwortlos: EntityFlow sendet jedem, der sich anmeldet, einen Einmalcode per E-Mail. Eine selbst gehostete Instanz benötigt daher einen E-Mail-Transport, bevor sich Personen anmelden können.

Variable	Standardwert	Zweck
EF_MAIL_PROVIDER	—	smtp, resend, mailjet oder log. Ist die Variable nicht gesetzt, wird der erste konfigurierte Transport verwendet.
EF_MAIL_FROM	—	Absenderadresse.
EF_MAIL_FROM_NAME	—	Anzeigename des Absenders.
EF_SMTP_HOST	—	Host des SMTP-Servers.
EF_SMTP_PORT	587	Port des SMTP-Servers.
EF_SMTP_USER	—	SMTP-Benutzername.
EF_SMTP_PASSWORD	—	SMTP-Passwort.
EF_SMTP_SECURE	false	true für implizites TLS (Port 465); andernfalls wird STARTTLS verwendet.
EF_RESEND_API_KEY	—	API-Schlüssel für Resend.
EF_MAILJET_API_KEY	—	API-Schlüssel für Mailjet.
EF_MAILJET_SECRET_KEY	—	Geheimer Schlüssel für Mailjet.

export EF_MAIL_PROVIDER=smtp
export EF_MAIL_FROM="entityflow@acme.com"
export EF_MAIL_FROM_NAME="EntityFlow"
export EF_SMTP_HOST="smtp.acme.com"
export EF_SMTP_PORT=587
export EF_SMTP_USER="entityflow"
export EF_SMTP_PASSWORD="<smtp-password>"

:::info Eine gespeicherte Konfiguration hat Vorrang Eine in der Datenbank gespeicherte E-Mail-Konfiguration (durch EntityFlow Office) hat Vorrang vor diesen Variablen. :::

:::warning log ist nur für die Entwicklung gedacht Mit EF_MAIL_PROVIDER=log wird nichts versendet: E-Mails — einschließlich der Anmeldecodes — werden in das Serverprotokoll geschrieben. Verwenden Sie diese Option nur auf einem Entwicklungsrechner. :::

Echtzeit

Variable	Standardwert	Zweck
EF_COLLAB_DEBOUNCE_MS	2000	Debounce-Fenster für das Persistieren von CRDT-Aktualisierungen.
EF_COLLAB_MAX_DEBOUNCE_MS	10000	Maximales Debounce vor einem erzwungenen Flush.
EF_COLLAB_ALLOW_ANONYMOUS	false	Erlaubt nicht authentifizierte Zusammenarbeit (nur Demo).
EF_REALTIME_REDIS_ENABLED	false	Aktiviert die Redis-Verteilung für mehrere Knoten.
EF_REALTIME_REDIS_URL	—	Redis-Verbindungszeichenfolge.
EF_REALTIME_REDIS_PREFIX	ef	Schlüsselpräfix für Redis-Kanäle.

Beobachtbarkeit

Variable	Standardwert	Zweck
EF_OTEL_ENABLED	false	Aktiviert das OpenTelemetry-Tracing.
EF_OTEL_EXPORTER_OTLP_ENDPOINT	—	Endpunkt des OTLP-Collectors.
EF_OTEL_SERVICE_NAME	ef-server	In Traces gemeldeter Dienstname.
EF_SENTRY_DSN	—	Sentry-DSN für die Fehlermeldung.
EF_LOG_LEVEL	info	Protokollebene (fatal–trace, oder silent).

Lebenszyklus und Webhooks

Variable	Standardwert	Zweck
EF_TRIAL_DAYS	14	Testdauer in Tagen.
EF_RETENTION_DAYS	30	Aufbewahrungsfenster für vorläufig gelöschte Daten.
EF_SUSPENDED_READONLY	true	Gesperrte Mandanten werden schreibgeschützt, anstatt blockiert zu werden.
EF_WEBHOOK_ALLOW_HTTP	false	Erlaubt Webhook-Ziele über unverschlüsseltes HTTP.

Importer

Variable	Standardwert	Zweck
EF_DB_CONNECT_BLOCK_PRIVATE	false	Blockiert die Verbindung des Importers zu privaten/Loopback-Hosts.
EF_CONNECTION_ENC_KEY	—	Base64-AES-256-Schlüssel, der den Tresor für gespeicherte Verbindungen aktiviert.

warnung

In der Produktion muss EF_AUTH_SECRET gesetzt sein, und es muss ein E-Mail-Transport konfiguriert sein, damit sich Personen anmelden können.

Siehe Eigene Datenbank verwenden und Eigenen Identitätsanbieter verwenden für die Engine- und Auth-spezifische Einrichtung.