Zum Inhalt
flowplanDokumentationCommunityMarketplaceZur Startseite

Konfiguration

Konfiguration

Alle Umgebungsvariablen auf einen Blick. Viele Werte lassen sich zusätzlich in der Oberfläche der Administration setzen (siehe In der Oberfläche); dort gesetzte Werte haben Vorrang.

9 Min. Lesezeit

Auf dieser Seite
  1. Pflicht
  2. Anmeldung
  3. Betrieb
  4. Nicht setzen
  5. In der Oberfläche

Mehr zum Thema: Konfiguration: Speicher, Datenbank und Sicherheit · Konfiguration: E-Mail, Integrationen und Workflows · Konfiguration: KI, Sprachnotizen und Push

Pflicht

VariableBeispielBedeutung
APP_URLhttps://flowplan.example.comÖffentliche Adresse genau so, wie sie im Browser steht – Schema, Host, ggf. Port, ohne Schrägstrich am Ende. Grundlage für Login-Weiterleitung, Cookies, Passkeys, Links in E-Mails und Push-Nachrichten und die Origin-Prüfung.

Anmeldung

VariableStandardBedeutung
FLOWPLAN_LOCAL_LOGINanfalse schaltet E-Mail, Passwort und Passkeys ab; dann bleibt nur Single Sign-on.
FLOWPLAN_SETUP_TOKENleer (Helm: zufällig erzeugt)Empfohlen für Instanzen, die aus dem Internet erreichbar sind: Das erste Konto und das Wiederherstellen beim Einrichten gehen nur über /register?setup=<token>. Danach ohne Wirkung. Fehlt er und ist APP_URL keine lokale Adresse, warnt Flowplan beim Start im Log und auf dem Einrichtungsbildschirm. Siehe Anmeldung.
OIDC_ISSUERleerLogin-Anbieter für Single Sign-on. Ohne ihn gibt es nur E-Mail, Passwort und Passkeys.
OIDC_CLIENT_ID–Client-ID.
OIDC_CLIENT_SECRET–Client-Secret. Nie ins Image oder ins Git. Leer: öffentlicher Client, nur mit PKCE.
OIDC_LINKED_SSO_ONLYaustrue: Konten, die mit SSO verbunden sind, melden sich nur noch über SSO an. Anmelden mit Passwort oder Passkey wird mit einem Hinweis abgelehnt; Passkeys und die Authenticator-App bleiben zum Bestätigen wichtiger Schritte. Siehe Bestehendes Konto mit SSO verbinden.
OIDC_NEW_ACCOUNTSanfalse: Die SSO-Anmeldung legt keine neuen Konten an – nur bestehende, verbundene oder per SCIM bereitgestellte Konten melden sich an. Bei der ersten SSO-Anmeldung mit bekannter Adresse fehlt dann „Stattdessen ein eigenes Konto anlegen“.
SESSION_HOURS8Browser-Sitzung ohne „Angemeldet bleiben“: endet so viele Stunden nach der Anmeldung (1–24). Auch unter Administration → Anmeldung & SSO → Sitzungen; ein dort gespeicherter Wert hat Vorrang (gilt für alle SESSION_* außer SESSION_MAX_DAYS und SESSION_GROUPS_HOURS).
SESSION_REMEMBERaustrue bietet im Browser beim Anmelden Angemeldet bleiben an – siehe Anmeldung. Die Apps bleiben unabhängig davon angemeldet.
SESSION_IDLE_HOURS168Mit „angemeldet bleiben“ im Browser: Sitzung endet so viele Stunden nach der letzten Nutzung (1–8760).
SESSION_APP_REMEMBERanDesktop- und Handy-Apps bleiben angemeldet, solange sie (oder ihre Widgets) genutzt werden – bei Anmeldungen, die die App belegt (Übergabe über den Browser oder Passwort mit dem Geräteschlüssel der App; siehe Anmeldung). false: Ihre Sitzungen enden wie eine Browser-Sitzung ohne „Angemeldet bleiben“.
SESSION_APP_DAYS90App-Sitzung endet nach so vielen Tagen ohne Nutzung (1–365).
SESSION_MAX_DAYS30 / 365Sitzungen, die angemeldet bleiben, enden spätestens so viele Tage nach der Anmeldung (1–365; Standard 30 im Browser, 365 in den Apps; nie kürzer als die Zeit ohne Nutzung) – mit SSO genauso wie mit Passwort und Passkey.
SESSION_GROUPS_HOURSleerNur wenn gesetzt: SSO-Sitzungen mit „angemeldet bleiben“ enden schon nach so vielen Stunden, damit Gruppenänderungen beim Anbieter mit der neuen Anmeldung wirken. Ohne die Variable wirken sie über SCIM, den LDAP-Abgleich oder die nächste Anmeldung.
LDAP_URLleerAnmeldung mit einem LDAP-Verzeichnis (ldap:// oder ldaps://) – siehe Anmeldung mit LDAP.
LDAP_BIND_DN / LDAP_BIND_PASSWORDleerSuchkonto für LDAP; ohne es anonyme Suche.
LDAP_BASE_DN–Wo LDAP-Konten gesucht werden.
LDAP_USER_FILTER(|(uid={user})(mail={user}))Suchfilter; {user} ist der maskierte Anmeldename.
LDAP_GROUP_ATTRIBUTEmemberOfGruppen für SSO-Zuordnungen und Admin-Gruppe, stündlich abgeglichen.
LDAP_TLS_CAleerCA für ldaps:///StartTLS (Pfad oder PEM).
LDAP_STARTTLSfalseldap:// mit StartTLS.
LDAP_TIMEOUT_MS8000Zeitlimit je LDAP-Operation.
LDAP_CONTACTS_BASE_DNLDAP_BASE_DNBasis für Kontakte aus LDAP; der OU-Baum beginnt hier.
LDAP_CONTACTS_FILTERPersonen ohne ComputerWelche Einträge als Kontakte gelten.
LDAP_CONTACTS_SYNC_MINUTES60Abgleich der Kontakte aus dem Verzeichnis (15–1440 Minuten).
LDAP_CONTACTS_ATTRIBUTES–Weitere LDAP-Attribute, die Kontakte-Datenbanken zuordnen dürfen (durch Komma oder Leerzeichen getrennt), zusätzlich zu denen der Standardzuordnung.
LDAP_CONTACTSanoff schaltet Kontakte aus LDAP ab.

Die übrigen OIDC-Variablen und alles zu Passwörtern und Passkeys stehen unter Anmeldung.

Betrieb

VariableStandardBedeutung
FLOWPLAN_DATA_DIR/app/data im Image, sonst ./dataDatenverzeichnis für SQLite, Uploads, Push-Schlüssel und Texterkennungsdaten.
PUID / PGID1000 / wie PUIDNur im Image, ohne user: (wie bei linuxserver.io): Flowplan gibt den Datenordner beim Start diesem Benutzer und dieser Gruppe und läuft als sie, nie als root; 0 wird abgelehnt. Mit user: "UID:GID" läuft Flowplan stattdessen gleich als dieser Benutzer – siehe Volume-Rechte.
FLOWPLAN_WORKSPACE_QUOTA_MBunbegrenztStandard-Speicherkontingent je Arbeitsbereich in MB (0 = unbegrenzt).
FLOWPLAN_IMPORT_MAX_MBleerGrößte Datei für Importe aus AFFiNE und anderen Werkzeugen in MB, für alle Personen. Ohne die Variable gilt die größte Datei beim Hochladen (Administration → Grenzen & Aufbewahrung bzw. die Grenze der Person), mindestens 100 MB. Größer als 100 MB darf nur die AFFiNE-Arbeitsbereichsdatei (.affine) sein; ZIP-Exporte bleiben bei 100 MB. Ein Proxy davor muss so große Anfragen durchlassen.
FLOWPLAN_MAX_DOCUMENT_MB16Größe eines gemeinsam bearbeiteten Dokuments (Seite oder Datensatz-Dokument) in MB. Änderungen, die ein Dokument darüber hinaus wachsen lassen, werden abgelehnt („Das Dokument ist zu groß …“); größere Inhalte auf mehrere Seiten verteilen. Schützt den Server davor, dass jede Bearbeitung eines riesigen Dokuments ihn ausbremst.
FLOWPLAN_IMPORT_MAX_DOCS10000Höchstzahl der Seiten je Import aus AFFiNE, Confluence, Evernote, Google Docs, Obsidian und Notion/Markdown: Dokumente, Ordner, Datenbanken, Whiteboards und Sammlungen; beim Import als neue Datenbank die Zahl der Einträge. Darüber zeigt die Vorschau die Anzahl und der Import wird abgelehnt (die Meldung nennt die Variable). Dokumente werden einzeln umgewandelt; ein höherer Wert kostet Zeit, kaum Speicher.
FLOWPLAN_IMPORT_MAX_FILES20000Höchstzahl der Dateien (Bilder, Anhänge) je Import aus einem AFFiNE-Arbeitsbereich oder -Snapshot; weitere werden ausgelassen, die Vorschau nennt ihre Zahl und die Variable. ZIP-Exporte dürfen so viele Einträge haben wie Seiten und Dateien zusammen (mindestens 12.000).
FLOWPLAN_IMPORT_ALLOW_PRIVATEaustrue erlaubt dem Import aus BookStack interne Adressen (lokales Netz, VPN, etwa http://192.168.1.20) und http:// – für ein BookStack im eigenen Netz. Ohne die Variable nimmt der Import nur öffentliche HTTPS-Adressen. Seit 0.10.0
FLOWPLAN_SNAPSHOT_RETENTION_DAYS180Aufbewahrung automatischer Versionen in Tagen (0 = unbegrenzt).
FLOWPLAN_OCRan0 schaltet die Texterkennung für gescannte PDFs und Bilder ab.
FLOWPLAN_OCR_LANGSdeu,engSprachen der Texterkennung, z. B. fra,eng; die erste ist die Hauptsprache. Mitgeliefert sind deu, eng, fra und chi_sim (Chinesisch, Kurzzeichen, z. B. chi_sim,eng). Jede weitere Sprache kostet Speicher und Zeit pro Seite; Chinesisch am meisten (rund 100 MB mehr Arbeitsspeicher, etwa anderthalbmal so lange pro Seite).
FLOWPLAN_WORKERSKerne − 1, mindestens 1Worker-Threads für lange Rechenarbeit: Exporte (Markdown/ZIP, PDF, Word, EPUB, Jira, Confluence) und das Einlesen von Importen laufen dort, damit der Server währenddessen alle anderen Anfragen weiter beantwortet. Standard: so viele Threads, wie der Container Kerne nutzen darf, weniger einen (mindestens einer). Ein Thread startet erst, wenn er gebraucht wird, endet nach einer Minute ohne Arbeit und braucht, solange er läuft, rund 200–400 MB Arbeitsspeicher, mit PostgreSQL bis zu zwei Datenbankverbindungen. Warten mehr als 16 Aufträge je Thread, antwortet der Server mit 503 („gerade ausgelastet“). 0 schaltet die Threads ab: Alles läuft wie früher im Hauptprozess. Seit 0.11.0
FLOWPLAN_PROCESSES1Neu in 0.11.1, im :beta-Image Mehrere Server-Prozesse hinter demselben Port, damit ein Container mehr als einen Kern für Anfragen nutzt: eine Zahl von 2 bis 16 oder auto (so viele Kerne, wie der Container nutzen darf, höchstens 8). Prozess 1 übernimmt die Hintergrundaufgaben; FLOWPLAN_WORKERS gilt dann für den ganzen Container. Jeder weitere Prozess braucht etwa 300–450 MB Arbeitsspeicher. Siehe Mehrere Prozesse.
FLOWPLAN_PROCESS_BALANCEleerNeu in 0.11.1, im :beta-Image Wie Anfragen auf die Prozesse verteilt werden: leer reihum, os überlässt es dem Betriebssystem. Beide waren in der Messung etwa gleich schnell.
FLOWPLAN_METRICSanoff schaltet die Nutzungsstatistik der Überwachung aus: Anfragen, Fehler und Antwortzeiten je Minute, aktive Personen je Stunde, Speicherverlauf und KI-Tokens. Erfasst werden nur Zahlen – keine IP-Adressen, Pfade oder Namen; Minuten bleiben 48 Stunden, Stunden 35 Tage, Tage 400 Tage. Mit off wird nichts erfasst, und der Schalter Nutzungsstatistik erfassen unter Administration → Überwachung → Statistik ist gesperrt. /api/metrics hängt davon nicht ab.
FLOWPLAN_LOG_FILEanoff: kein Server-Log in /app/data/logs/ (Flowplans und Litestreams Ausgabe, geschwärzt, je etwa 2.000 Zeilen). Die Neustarts stehen dann ohne Log-Zeilen da; wann und warum bleibt. Seit 0.10.0
FLOWPLAN_METRICS_TOKENleerMindestens 16 Zeichen; aktiviert /api/metrics im Prometheus-Format. Als Authorization: Bearer … mitgeschickt, liefert /api/health damit auch die Details (siehe Healthcheck).
FLOWPLAN_PUBLIC_API_DOCSfalsetrue macht /api/openapi.json und /api/docs ohne Anmeldung lesbar; Besucher sehen darin nur die Hauptversion (0.x). Sonst nur für Angemeldete und API-Tokens.
FLOWPLAN_UPDATE_CHECKanfalse schaltet die Suche nach neuen Versionen ab (für Instanzen ohne Internet). Sonst fragt der Server höchstens alle 12 Stunden bei GitHub nach dem neuesten Release und zeigt Admins in der Administration einen Hinweis.
FLOWPLAN_MARKETPLACE_URLhttps://marketplace.flowplan.orgAdresse des Flowplan Marketplace (Standard https://marketplace.flowplan.org); off schaltet ihn ab. Die Instanz verbindet sich nie selbst damit – die Adresse legt nur fest, mit welchem Fenster der Browser Vorlagen austauscht. Siehe Marketplace.
FLOWPLAN_UPDATE_URLGitHub-APIAndere Adresse für das neueste Release (gleiches Format wie api.github.com/repos/yannicschuller/flowplan/releases/latest), etwa ein interner Spiegel. Nicht zu verwechseln mit der gleichnamigen Variable der Desktop-App, die auf dem Rechner der App deren Update-Quelle nennt.
FLOWPLAN_TRUSTED_PROXIES1Anzahl der Proxys vor Flowplan (Traefik allein: 1, Pangolin vor Traefik: 2, 0 = keinem Header vertrauen). Bestimmt, welcher Eintrag in X-Forwarded-For die echte Adresse ist – für die Begrenzung von Anmeldeversuchen, Demo-Starts und anonymen Formularantworten. Frei erfundene Einträge des Browsers werden so ignoriert. Kommt gar keine Adresse an (der Proxy setzt den Header nicht), gelten nur die Limits je Konto und je Link, und das Protokoll zeigt einmalig einen Hinweis.
FLOWPLAN_SECURITY_LOGonSicherheitsereignisse als JSON-Zeile auf stdout: on (mit Adresse, für fail2ban/CrowdSec), anonymous, off (Sicherheit).
FLOWPLAN_SECURITY_RETENTION_DAYS90Wie lange Sicherheitsereignisse in der Datenbank bleiben (mindestens 7).
FLOWPLAN_COUNTRY_HEADERleerHeader des Proxys mit dem Land der Anfrage (z. B. CF-IPCountry); schaltet die Regel „zwei Länder kurz nacheinander“ ein.
OTEL_EXPORTER_OTLP_ENDPOINTleerOTLP-Collector (HTTP); Sicherheitsereignisse gehen als OpenTelemetry-Logs dorthin. Dazu OTEL_EXPORTER_OTLP_HEADERS und OTEL_SERVICE_NAME.
FLOWPLAN_ANONYMOUS_UPLOAD_MB1024Wie viele MB Besucher ohne Konto pro Tag auf der ganzen Instanz hochladen dürfen – über anonyme Formulare und Bearbeiten-Links (0 = unbegrenzt). Je Formular bzw. Link gelten zusätzlich 200 MB pro Tag, unabhängig vom Speicherkontingent des Arbeitsbereichs.

Die Typst-Vorschau lädt Compiler und Schriften (WebAssembly, etwa 11 MB komprimiert) beim ersten Gebrauch von /typst/… des eigenen Servers; es gibt keine Verbindung zu einem CDN.

Nicht setzen

NODE_ENV, PORT, HOSTNAME und NEXT_TELEMETRY_DISABLED setzt das Image selbst, ebenso FLOWPLAN_DROP_ROOT=1 (Flowplans Werkzeuge im Container geben root ab und laufen als PUID:PGID). FLOWPLAN_LITESTREAM_SSE_C setzt der Start des Containers, wenn LITESTREAM_SSE_C_KEY gesetzt ist; die Administration zeigt daran, ob die Litestream-Kopie verschlüsselt ist. FLOWPLAN_DIST_DIR ist nur für parallele Entwicklungsserver gedacht, OIDC_ALLOW_LOCAL_HTTP nur für Tests mit einem Anbieter auf http://localhost, FLOWPLAN_GIT_ALLOW_HTTP nur für Tests des Git-Exports mit einem http://-Server (in Produktion wirkungslos). FLOWPLAN_E2E_BUILD und FLOWPLAN_E2E_DEMO gelten nur für den eigenen Build der Browser-Tests (Demo-Anmeldung in einem Produktions-Build); ein veröffentlichtes Image enthält diesen Schalter nicht, und die Variablen wirken dort nicht. Seit 0.10.0 Version und Commit (FLOWPLAN_VERSION, GIT_COMMIT, SOURCE_COMMIT) kommen aus dem Build; FLOWPLAN_VERSION in der .env wählt nur das Image-Tag in compose.yaml.

In der Oberfläche

In der Administration stellen Admins ein (siehe Administration der Instanz):

  • Instanz: Name der Instanz und ob die Instanz eine öffentliche Demo anbietet (laufende und insgesamt gestartete Demos zeigt Administration → Überwachung → Instanz in Zahlen),
  • Anmeldung & SSO: ob sich jede Person mit E-Mail und Passwort registrieren darf, ob alle Personen eigene Arbeitsbereiche anlegen dürfen, nach wie vielen Tagen ohne Anmeldung Konten gesperrt werden, Zwei-Faktor-Pflicht,
  • Grenzen & Aufbewahrung: Standard-Speicherkontingent, Speicher und eigene Arbeitsbereiche je Person, maximale Uploadgröße, Aufbewahrung von Versionen,
  • Speicher & Sicherung: tägliche oder stündliche Datenbanksicherung und wie viele Kopien bleiben,
  • Wartung & Hinweise: ein Hinweisbanner für alle und der Wartungshinweis,
  • Erweiterungen & Domains: Eigene Domains für Veröffentlichungen (aus) und Block-Erweiterungen von jeder HTTPS-Adresse (aus) – siehe Coolify und Reverse Proxy und Block-Erweiterungen,
  • Überwachung → Statistik: ob die Nutzungsstatistik erfasst wird (gesperrt mit FLOWPLAN_METRICS=off).

Leere Felder fallen auf die Umgebungsvariablen zurück.

War das hilfreich?
JaDanke!
Nein – sag uns, was fehlt

Fehler gefunden oder etwas fehlt?Auf GitHub bearbeiten