🌍 Konfiguration von Umgebungsvariablen

Übersicht

Open WebUI bietet eine große Auswahl an Umgebungsvariablen, mit denen Sie verschiedene Aspekte der Anwendung anpassen und konfigurieren können. Diese Seite dient als umfassende Referenz für alle verfügbaren Umgebungsvariablen und enthält deren Typen, Standardwerte und Beschreibungen. Neue Variablen werden auf dieser Seite nach ihrer Einführung aufgeführt, um die wachsenden Konfigurationsmöglichkeiten widerzuspiegeln.

Info

Diese Seite ist aktuell mit der Open WebUI Release-Version v0.6.9, befindet sich aber noch im Aufbau, um später genauere Beschreibungen, eine Auflistung der verfügbaren Optionen für Umgebungsvariablen, Standardwerte und verbesserte Beschreibungen aufzunehmen.

Wichtiger Hinweis zu Umgebungsvariablen vom Typ PersistentConfig

Hinweis

Beim ersten Start von Open WebUI werden alle Umgebungsvariablen gleich behandelt und zur Konfiguration der Anwendung verwendet. Umgebungsvariablen, die als PersistentConfig gekennzeichnet sind, werden jedoch persistent gespeichert und intern abgelegt.

Nach dem ersten Start und einem anschließenden Neustart des Containers verwenden PersistentConfig-Umgebungsvariablen nicht mehr die externen Umgebungsvariablenwerte. Stattdessen werden die intern gespeicherten Werte verwendet.

Reguläre Umgebungsvariablen hingegen werden bei jedem folgenden Neustart weiterhin aktualisiert und angewendet.

Sie können die Werte von PersistentConfig-Umgebungsvariablen direkt aus Open WebUI heraus aktualisieren, und diese Änderungen werden intern gespeichert. Dies ermöglicht es Ihnen, diese Konfigurationseinstellungen unabhängig von den externen Umgebungsvariablen zu verwalten.

Bitte beachten Sie, dass PersistentConfig-Umgebungsvariablen in der folgenden Dokumentation deutlich gekennzeichnet sind, sodass Sie sich über ihr Verhalten im Klaren sind.

Um PersistentConfig zu deaktivieren und Open WebUI alle Variablen gleich behandeln zu lassen, können Sie ENABLE_PERSISTENT_CONFIG auf False setzen.

App/Backend

Die folgenden Umgebungsvariablen werden von backend/open_webui/config.py für die Startkonfiguration von Open WebUI verwendet. Bitte beachten Sie, dass einige Variablen je nachdem, ob Sie Open WebUI direkt oder über Docker ausführen, unterschiedliche Standardwerte haben können. Weitere Informationen zu Protokollierungs-Umgebungsvariablen finden Sie in unserer Protokollierungsdokumentation.

Allgemein

WEBUI_URL

• Typ: str
• Standard: https://:3000
• Beschreibung: Gibt die URL an, unter der Ihre Open WebUI-Installation erreichbar ist. Erforderlich für Suchmaschinenunterstützung und OAuth/SSO.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

Warnung

Diese Variable muss gesetzt werden, bevor Sie OAuth/SSO zur Authentifizierung verwenden. Da es sich um eine persistente Konfigurations-Umgebungsvariable handelt, können Sie sie nur über eine der folgenden Optionen ändern:

• Vorübergehendes Deaktivieren der persistenten Konfiguration mittels ENABLE_PERSISTENT_CONFIG
• Ändern von WEBUI_URL im Admin-Panel > Einstellungen und Ändern von "WebUI URL".

Wenn Sie WEBUI_URL nicht vor der Verwendung von OAuth/SSO setzen, schlägt die Anmeldung fehl.

ENABLE_SIGNUP

• Typ: bool
• Standard: True
• Beschreibung: Schaltet die Erstellung von Benutzerkonten ein/aus.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

ENABLE_LOGIN_FORM

• Typ: bool
• Standard: True
• Beschreibung: Schaltet E-Mail-, Passwort-, Anmelde- und "oder"-Elemente (nur wenn ENABLE_OAUTH_SIGNUP auf True gesetzt ist) ein/aus.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

Gefahr

Dies sollte **nur** dann auf False gesetzt werden, wenn auch ENABLE_OAUTH_SIGNUP verwendet und auf True gesetzt ist. Wenn Sie dies nicht tun, können Sie sich nicht anmelden.

DEFAULT_LOCALE

• Typ: str
• Standard: en
• Beschreibung: Legt die Standard-Locale für die Anwendung fest.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

DEFAULT_MODELS

• Typ: str
• Standard: Leere Zeichenkette (' '), da None.
• Beschreibung: Legt ein Standard-Sprachmodell fest.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

DEFAULT_USER_ROLE

• Typ: str
• Optionen
  • pending - Neue Benutzer sind ausstehend, bis ihre Konten manuell von einem Administrator aktiviert werden.
  • user - Neue Benutzer werden automatisch mit regulären Benutzerrechten aktiviert.
  • admin - Neue Benutzer werden automatisch mit Administratorrechten aktiviert.
• Standard: pending
• Beschreibung: Legt die Standardrolle fest, die neuen Benutzern zugewiesen wird.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

PENDING_USER_OVERLAY_TITLE

• Typ: str
• Standard: Leere Zeichenkette (' ')
• Beschreibung: Legt einen benutzerdefinierten Titel für das Overlay für ausstehende Benutzer fest.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

PENDING_USER_OVERLAY_CONTENT

• Typ: str
• Standard: Leere Zeichenkette (' ')
• Beschreibung: Legt einen benutzerdefinierten Textinhalt für das Overlay für ausstehende Benutzer fest.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

ENABLE_CHANNELS

• Typ: bool
• Standard: False
• Beschreibung: Aktiviert oder deaktiviert die Kanalunterstützung.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

WEBHOOK_URL

• Typ: str
• Beschreibung: Legt einen Webhook für die Integration mit Discord/Slack/Microsoft Teams fest.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

ENABLE_ADMIN_EXPORT

• Typ: bool
• Standard: True
• Beschreibung: Steuert, ob Administratorbenutzer Daten exportieren können.

ENABLE_ADMIN_CHAT_ACCESS

• Typ: bool
• Standard: True
• Beschreibung: Ermöglicht Administratorbenutzern den Zugriff auf alle Chats.

ENABLE_USER_WEBHOOKS

• Typ: bool
• Standard: True
• Beschreibung: Aktiviert oder deaktiviert Benutzer-Webhooks.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

RESPONSE_WATERMARK

• Typ: str
• Standard: Leere Zeichenkette (' ')
• Beschreibung: Legt einen benutzerdefinierten Text fest, der beim Kopieren einer Nachricht im Chat enthalten ist. Beispiel: "Dieser Text ist KI-generiert" -> fügt "Dieser Text ist KI-generiert" zu jeder Nachricht hinzu, wenn sie kopiert wird.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

THREAD_POOL_SIZE

• Typ: int
• Standard: 0
• Beschreibung: Legt die Thread-Pool-Größe für blockierende Aufrufe von FastAPI/AnyIO fest. Standardmäßig (wenn auf 0 gesetzt) verwendet FastAPI/AnyIO 40 Threads. Bei großen Instanzen und vielen gleichzeitigen Benutzern muss möglicherweise THREAD_POOL_SIZE erhöht werden, um Blockierungen zu verhindern.

SHOW_ADMIN_DETAILS

• Typ: bool
• Standard: True
• Beschreibung: Schaltet ein, ob Administrator-Benutzerdetails in der Benutzeroberfläche angezeigt werden.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

ADMIN_EMAIL

• Typ: str
• Beschreibung: Legt die von SHOW_ADMIN_DETAILS angezeigte Administrator-E-Mail-Adresse fest.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

ENV

• Typ: str
• Optionen
  • dev - Aktiviert die FastAPI-API-Dokumentation unter /docs
  • prod - Konfiguriert automatisch mehrere Umgebungsvariablen
• Standard
  • Backend Standard: dev
  • Docker Standard: prod
• Beschreibung: Umgebungseinstellung.

ENABLE_PERSISTENT_CONFIG

• Typ: bool
• Standard: True
• Beschreibung: Wenn auf False gesetzt, werden alle PersistentConfig-Variablen wie reguläre Variablen behandelt.

CUSTOM_NAME

• Typ: str
• Beschreibung: Setzt WEBUI_NAME, ruft aber api.openwebui.com auf, um Metadaten abzurufen.

WEBUI_NAME

• Typ: str
• Standard: Open WebUI
• Beschreibung: Legt den Hauptnamen der WebUI fest. Hängt (Open WebUI) an, wenn überschrieben.

PORT

• Typ: int
• Standard: 8080
• Beschreibung: Legt den Port fest, von dem aus Open WebUI ausgeführt werden soll.

Info

Wenn Sie die Anwendung über Python ausführen und den Befehl open-webui serve verwenden, können Sie den Port nicht über die PORT-Konfiguration festlegen. Stattdessen müssen Sie ihn direkt als Befehlszeilenargument mit dem Flag --port angeben. Beispiel:

open-webui serve --port 9999

Dadurch wird Open WebUI auf Port 9999 ausgeführt. Die Umgebungsvariable PORT wird in diesem Modus ignoriert.

ENABLE_REALTIME_CHAT_SAVE

• Typ: bool
• Standard: False
• Beschreibung: Wenn aktiviert, speichert das System jeden Teil der gestreamten Chat-Daten in Echtzeit in der Datenbank, um maximale Datenpersistenz zu gewährleisten. Diese Funktion bietet robuste Datenwiederherstellung und ermöglicht eine genaue Sitzungsverfolgung. Der Nachteil ist jedoch eine erhöhte Latenz, da das Speichern in der Datenbank eine Verzögerung verursacht. Das Deaktivieren dieser Funktion kann die Leistung verbessern und Verzögerungen reduzieren, birgt aber das Risiko eines Datenverlusts im Falle eines Systemausfalls oder Absturzes. Die Nutzung sollte auf den Anforderungen Ihrer Anwendung und den akzeptablen Kompromissen basieren.

BYPASS_MODEL_ACCESS_CONTROL

• Typ: bool
• Standard: False
• Beschreibung: Umgeht die Zugriffssteuerung für Modelle.

WEBUI_BUILD_HASH

• Typ: str
• Standard: dev-build
• Beschreibung: Wird zur Identifizierung des Git-SHA des Builds für Releases verwendet.

WEBUI_BANNERS

• Typ: list von dict
• Standard: []
• Beschreibung: Liste der Banner, die den Benutzern angezeigt werden. Das Format für Banner ist

[{"id": "string", "type": "string [info, success, warning, error]", "title": "string", "content": "string", "dismissible": false, "timestamp": 1000}]

• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

Info

Wenn Sie diese Umgebungsvariable in einer .env-Datei festlegen, stellen Sie sicher, dass Sie die Anführungszeichen maskieren, indem Sie den gesamten Wert in doppelte Anführungszeichen einschließen und maskierte Anführungszeichen (\") für die inneren Anführungszeichen verwenden. Beispiel:

WEBUI_BANNERS="[{\"id\": \"1\", \"type\": \"warning\", \"title\": \"Your messages are stored.\", \"content\": \"Your messages are stored and may be reviewed by human people. LLM's are prone to hallucinations, check sources.\", \"dismissible\": true, \"timestamp\": 1000}]"

USE_CUDA_DOCKER

• Typ: bool
• Standard: False
• Beschreibung: Erstellt das Docker-Image mit NVIDIA CUDA-Unterstützung. Ermöglicht GPU-Beschleunigung für lokale Whisper- und Embedding-Modelle.

EXTERNAL_PWA_MANIFEST_URL

• Typ: str
• Standard: Leere Zeichenkette (' '), da None als Standardwert festgelegt ist.
• Beschreibung: Wenn als vollständig qualifizierte URL definiert (z. B. https://path/to/manifest.webmanifest), verwenden Anfragen an /manifest.json die externe Manifestdatei. Wenn nicht definiert, wird die Standard-Manifestdatei verwendet.

ENABLE_TITLE_GENERATION

• Typ: bool
• Standard: True
• Beschreibung: Aktiviert oder deaktiviert die Chat-Titelgenerierung.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

LICENSE_KEY

• Typ: str
• Standard: None
• Beschreibung: Gibt den zu verwendenden Lizenzschlüssel an (nur für Enterprise-Benutzer).
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

SSL_ASSERT_FINGERPRINT

• Typ: str
• Standard: Leere Zeichenkette (' '), da None als Standardwert festgelegt ist.
• Beschreibung: Gibt den zu verwendenden SSL-Zertifikat-Fingerabdruck an.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

DEFAULT_PROMPT_SUGGESTIONS

• Typ: list von dict
• Standard: [] (was bedeutet, dass die integrierten Standard-Prompt-Vorschläge verwendet werden)
• Beschreibung: Liste der Prompt-Vorschläge. Das Format für Prompt-Vorschläge ist

[{"title": ["Title part 1", "Title part 2"], "content": "prompt"}]

AIOHTTP Client

AIOHTTP_CLIENT_TIMEOUT

• Typ: int
• Standard: 300
• Beschreibung: Gibt die Timeout-Dauer in Sekunden für den AIOHTTP-Client an. Dies wirkt sich auf Dinge wie Verbindungen zu Ollama und OpenAI-Endpunkten aus.

Info

Dies ist die maximale Zeit, die der Client auf eine Antwort wartet, bevor er ein Timeout auslöst. Wenn auf eine leere Zeichenkette (' ') gesetzt, wird das Timeout auf None gesetzt, wodurch das Timeout effektiv deaktiviert wird und der Client unbegrenzt warten kann.

AIOHTTP_CLIENT_TIMEOUT_MODEL_LIST

• Typ: int
• Standard: 10
• Beschreibung: Legt das Timeout in Sekunden für das Abrufen der Modellliste fest. Dies kann nützlich sein, wenn die Netzwerklatenz eine längere Timeout-Dauer erfordert, um die Modellliste erfolgreich abzurufen.

Hinweis

Der AIOHTTP_CLIENT_TIMEOUT_MODEL_LIST ist standardmäßig auf 10 Sekunden eingestellt, um sicherzustellen, dass alle notwendigen Verbindungen beim Öffnen der WebUI verfügbar sind. Diese Dauer ermöglicht genügend Zeit, um die Modellliste auch bei höherer Netzwerklatenz abzurufen. Sie können diesen Wert verringern, wenn schnellere Timeouts bevorzugt werden, aber bedenken Sie, dass dies je nach Ihren Netzwerkbedingungen zu Verbindungsabbrüchen führen kann.

AIOHTTP_CLIENT_TIMEOUT_OPENAI_MODEL_LIST

• Typ: int
• Beschreibung: Legt das Timeout in Sekunden für das Abrufen der Modellliste fest. Dies kann nützlich sein, wenn die Netzwerklatenz eine längere Timeout-Dauer erfordert, um die Modellliste erfolgreich abzurufen.

Verzeichnisse

DATA_DIR

• Typ: str
• Standard: ./data
• Beschreibung: Gibt das Basisverzeichnis für die Datenspeicherung an, einschließlich Uploads, Cache, Vektordatenbank usw.

FONTS_DIR

• Typ: str
• Beschreibung: Gibt das Verzeichnis für Schriftarten an.

FRONTEND_BUILD_DIR

• Typ: str
• Standard: ../build
• Beschreibung: Gibt den Speicherort der erstellten Frontend-Dateien an.

STATIC_DIR

• Typ: str
• Standard: ./static
• Beschreibung: Gibt das Verzeichnis für statische Dateien wie das Favicon an.

Ollama

ENABLE_OLLAMA_API

• Typ: bool
• Standard: True
• Beschreibung: Ermöglicht die Verwendung von Ollama-APIs.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

OLLAMA_BASE_URL (OLLAMA_API_BASE_URL ist veraltet)

• Typ: str
• Standard: https://:11434
• Docker Standard
  • Wenn K8S_FLAG gesetzt ist: http://ollama-service.open-webui.svc.cluster.local:11434
  • Wenn USE_OLLAMA_DOCKER=True: https://:11434
  • Andernfalls http://host.docker.internal:11434
• Beschreibung: Konfiguriert die Ollama-Backend-URL.

OLLAMA_BASE_URLS

• Typ: str
• Beschreibung: Konfiguriert geladene, balancierte Ollama-Backend-Hosts, getrennt durch ;. Siehe OLLAMA_BASE_URL. Hat Vorrang vor OLLAMA_BASE_URL.
• Beispiel: http://host-one:11434;http://host-two:11434
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

USE_OLLAMA_DOCKER

• Typ: bool
• Standard: False
• Beschreibung: Erstellt das Docker-Image mit einer gebündelten Ollama-Instanz.

K8S_FLAG

• Typ: bool
• Standard: False
• Beschreibung: Wenn gesetzt, wird eine Helm-Chart-Bereitstellung angenommen und OLLAMA_BASE_URL auf http://ollama-service.open-webui.svc.cluster.local:11434 gesetzt.

OpenAI

ENABLE_OPENAI_API

• Typ: bool
• Standard: True
• Beschreibung: Ermöglicht die Verwendung von OpenAI-APIs.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

OPENAI_API_BASE_URL

• Typ: str
• Standard: https://api.openai.com/v1
• Beschreibung: Konfiguriert die OpenAI-Basis-API-URL.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

OPENAI_API_BASE_URLS

• Typ: str
• Beschreibung: Unterstützt balancierte OpenAI-Basis-API-URLs, Semikolon-getrennt.
• Beispiel: http://host-one:11434;http://host-two:11434
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

OPENAI_API_KEY

• Typ: str
• Beschreibung: Legt den OpenAI-API-Schlüssel fest.
• Beispiel: sk-124781258123
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

OPENAI_API_KEYS

• Typ: str
• Beschreibung: Unterstützt mehrere OpenAI-API-Schlüssel, Semikolon-getrennt.
• Beispiel: sk-124781258123;sk-4389759834759834
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

Aufgaben

TASK_MODEL

• Typ: str
• Beschreibung: Das Standardmodell, das für Aufgaben wie Titel- und Websuchanfragen-Generierung bei Verwendung von Ollama-Modellen verwendet wird.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

TASK_MODEL_EXTERNAL

• Typ: str
• Beschreibung: Das Standardmodell, das für Aufgaben wie Titel- und Websuchanfragen-Generierung bei Verwendung von OpenAI-kompatiblen Endpunkten verwendet wird.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

TITLE_GENERATION_PROMPT_TEMPLATE

• Typ: str
• Beschreibung: Prompt, der bei der Generierung von Chat-Titeln verwendet wird.
• Standard: Der Wert der Umgebungsvariable DEFAULT_TITLE_GENERATION_PROMPT_TEMPLATE.

DEFAULT_TITLE_GENERATION_PROMPT_TEMPLATE:

### Task:
Generate a concise, 3-5 word title with an emoji summarizing the chat history.
### Guidelines:
- The title should clearly represent the main theme or subject of the conversation.
- Use emojis that enhance understanding of the topic, but avoid quotation marks or special formatting.
- Write the title in the chat's primary language; default to English if multilingual.
- Prioritize accuracy over excessive creativity; keep it clear and simple.
### Output:
JSON format: { "title": "your concise title here" }
### Examples:
- { "title": "📉 Stock Market Trends" },
- { "title": "🍪 Perfect Chocolate Chip Recipe" },
- { "title": "Evolution of Music Streaming" },
- { "title": "Remote Work Productivity Tips" },
- { "title": "Artificial Intelligence in Healthcare" },
- { "title": "🎮 Video Game Development Insights" }
### Chat History:
<chat_history>
{{MESSAGES:END:2}}
</chat_history>

• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

ENABLE_FOLLOW_UP_GENERATION

• Typ: bool
• Standard: True
• Beschreibung: Aktiviert oder deaktiviert die Folgefragen-Generierung.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

FOLLOW_UP_GENERATION_PROMPT_TEMPLATE

• Typ: str
• Beschreibung: Prompt, der zur Generierung mehrerer relevanter Folgefragen verwendet wird.
• Standard: Der Wert der Umgebungsvariable DEFAULT_FOLLOW_UP_GENERATION_PROMPT_TEMPLATE.

DEFAULT_FOLLOW_UP_GENERATION_PROMPT_TEMPLATE:

### Task:
Suggest 3-5 relevant follow-up questions or prompts that the user might naturally ask next in this conversation as a **user**, based on the chat history, to help continue or deepen the discussion.
### Guidelines:
- Write all follow-up questions from the user’s point of view, directed to the assistant.
- Make questions concise, clear, and directly related to the discussed topic(s).
- Only suggest follow-ups that make sense given the chat content and do not repeat what was already covered.
- If the conversation is very short or not specific, suggest more general (but relevant) follow-ups the user might ask.
- Use the conversation's primary language; default to English if multilingual.
- Response must be a JSON array of strings, no extra text or formatting.
### Output:
JSON format: { "follow_ups": ["Question 1?", "Question 2?", "Question 3?"] }
### Chat History:
<chat_history>
{{MESSAGES:END:6}}
</chat_history>"

• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE

• Typ: str
• Beschreibung: Prompt, der beim Aufrufen von Tools verwendet wird.
• Standard: Der Wert der Umgebungsvariable DEFAULT_TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE.

DEFAULT_TOOLS_FUNCTION_CALLING_PROMPT_TEMPLATE:

Available Tools: {{TOOLS}}

Your task is to choose and return the correct tool(s) from the list of available tools based on the query. Follow these guidelines:

- Return only the JSON object, without any additional text or explanation.

- If no tools match the query, return an empty array: 
   {
     "tool_calls": []
   }

- If one or more tools match the query, construct a JSON response containing a "tool_calls" array with objects that include:
   - "name": The tool's name.
   - "parameters": A dictionary of required parameters and their corresponding values.

The format for the JSON response is strictly:
{
  "tool_calls": [
    {"name": "toolName1", "parameters": {"key1": "value1"}},
    {"name": "toolName2", "parameters": {"key2": "value2"}}
  ]
}

• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

Codeausführung

ENABLE_CODE_EXECUTION

• Typ: bool
• Standard: True
• Beschreibung: Aktiviert oder deaktiviert die Codeausführung.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

CODE_EXECUTION_ENGINE

• Typ: str
• Standard: pyodide
• Beschreibung: Gibt die zu verwendende Codeausführungs-Engine an.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

CODE_EXECUTION_JUPYTER_URL

• Typ: str
• Standard: None
• Beschreibung: Gibt die zu verwendende Jupyter-URL für die Codeausführung an.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

CODE_EXECUTION_JUPYTER_AUTH

• Typ: str
• Standard: None
• Beschreibung: Gibt die zu verwendende Jupyter-Authentifizierungsmethode für die Codeausführung an.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

CODE_EXECUTION_JUPYTER_AUTH_TOKEN

• Typ: str
• Standard: None
• Beschreibung: Gibt das zu verwendende Jupyter-Authentifizierungstoken für die Codeausführung an.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

CODE_EXECUTION_JUPYTER_AUTH_PASSWORD

• Typ: str
• Standard: None
• Beschreibung: Gibt das zu verwendende Jupyter-Authentifizierungspasswort für die Codeausführung an.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

CODE_EXECUTION_JUPYTER_TIMEOUT

• Typ: str
• Standard: Leere Zeichenkette (' '), da None als Standardwert festgelegt ist.
• Beschreibung: Gibt das Timeout für die Jupyter-Codeausführung an.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

Code-Interpreter

ENABLE_CODE_INTERPRETER

• Typ: bool
• Standard: True
• Beschreibung: Aktiviert oder deaktiviert den Code-Interpreter.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

CODE_INTERPRETER_ENGINE

• Typ: str
• Standard: pyodide
• Beschreibung: Gibt die zu verwendende Code-Interpreter-Engine an.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

CODE_INTERPRETER_PROMPT_TEMPLATE

• Typ: str
• Standard: None
• Beschreibung: Gibt die zu verwendende Prompt-Vorlage für den Code-Interpreter an.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

CODE_INTERPRETER_JUPYTER_URL

• Typ: str
• Standard: Leere Zeichenkette (' '), da None als Standardwert festgelegt ist.
• Beschreibung: Gibt die zu verwendende Jupyter-URL für den Code-Interpreter an.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

CODE_INTERPRETER_JUPYTER_AUTH

• Typ: str
• Standard: Leere Zeichenkette (' '), da None als Standardwert festgelegt ist.
• Beschreibung: Gibt die zu verwendende Jupyter-Authentifizierungsmethode für den Code-Interpreter an.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

CODE_INTERPRETER_JUPYTER_AUTH_TOKEN

• Typ: str
• Standard: Leere Zeichenkette (' '), da None als Standardwert festgelegt ist.
• Beschreibung: Gibt das zu verwendende Jupyter-Authentifizierungstoken für den Code-Interpreter an.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

CODE_INTERPRETER_JUPYTER_AUTH_PASSWORD

• Typ: str
• Standard: Leere Zeichenkette (' '), da None als Standardwert festgelegt ist.
• Beschreibung: Gibt das zu verwendende Jupyter-Authentifizierungspasswort für den Code-Interpreter an.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

CODE_INTERPRETER_JUPYTER_TIMEOUT

• Typ: str
• Standard: Leere Zeichenkette (' '), da None als Standardwert festgelegt ist.
• Beschreibung: Gibt das Timeout für den Jupyter-Code-Interpreter an.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

Direkte Verbindungen (OpenAPI/MCPO Tool-Server)

ENABLE_DIRECT_CONNECTIONS

• Typ: bool
• Standard: True
• Beschreibung: Aktiviert oder deaktiviert direkte Verbindungen.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

Autovervollständigung

ENABLE_AUTOCOMPLETE_GENERATION

• Typ: bool
• Standard: True
• Beschreibung: Aktiviert oder deaktiviert die Autovervollständigungs-Generierung.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

Info

Wenn Sie ENABLE_AUTOCOMPLETE_GENERATION aktivieren, stellen Sie sicher, dass Sie auch AUTOCOMPLETE_GENERATION_INPUT_MAX_LENGTH und AUTOCOMPLETE_GENERATION_PROMPT_TEMPLATE entsprechend konfigurieren.

AUTOCOMPLETE_GENERATION_INPUT_MAX_LENGTH

• Typ: int
• Standard: -1
• Beschreibung: Legt die maximale Eingabelänge für die Autovervollständigungs-Generierung fest.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

AUTOCOMPLETE_GENERATION_PROMPT_TEMPLATE

• Typ: str
• Standard: Der Wert der Umgebungsvariable DEFAULT_AUTOCOMPLETE_GENERATION_PROMPT_TEMPLATE.

DEFAULT_AUTOCOMPLETE_GENERATION_PROMPT_TEMPLATE:

### Task:
You are an autocompletion system. Continue the text in `<text>` based on the **completion type** in `<type>` and the given language.  

### **Instructions**:
1. Analyze `<text>` for context and meaning.  
2. Use `<type>` to guide your output:  
   - **General**: Provide a natural, concise continuation.  
   - **Search Query**: Complete as if generating a realistic search query.  
3. Start as if you are directly continuing `<text>`. Do **not** repeat, paraphrase, or respond as a model. Simply complete the text.  
4. Ensure the continuation:
   - Flows naturally from `<text>`.  
   - Avoids repetition, overexplaining, or unrelated ideas.  
5. If unsure, return: `{ "text": "" }`.  

### **Output Rules**:
- Respond only in JSON format: `{ "text": "<your_completion>" }`.

### **Examples**:
#### Example 1:  
Input:  
<type>General</type>  
<text>The sun was setting over the horizon, painting the sky</text>  
Output:  
{ "text": "with vibrant shades of orange and pink." }

#### Example 2:  
Input:  
<type>Search Query</type>  
<text>Top-rated restaurants in</text>  
Output:  
{ "text": "New York City for Italian cuisine." }  

---
### Context:
<chat_history>
{{MESSAGES:END:6}}
</chat_history>
<type>{{TYPE}}</type>  
<text>{{PROMPT}}</text>  
#### Output:

• Beschreibung: Legt die Prompt-Vorlage für die Autovervollständigungs-Generierung fest.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

Modell der Bewertungsarena

ENABLE_EVALUATION_ARENA_MODELS

• Typ: bool
• Standard: True
• Beschreibung: Aktiviert oder deaktiviert Modelle der Bewertungsarena.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

ENABLE_MESSAGE_RATING

• Typ: bool
• Standard: True
• Beschreibung: Aktiviert die Nachrichtenbewertungsfunktion.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

ENABLE_COMMUNITY_SHARING

• Typ: bool
• Standard: True
• Beschreibung: Steuert, ob Benutzern die Schaltfläche "Teilen mit Community" angezeigt wird.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

Tag-Generierung

ENABLE_TAGS_GENERATION

• Typ: bool
• Standard: True
• Beschreibung: Aktiviert oder deaktiviert die Tag-Generierung.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

TAGS_GENERATION_PROMPT_TEMPLATE

• Typ: str
• Standard: Der Wert der Umgebungsvariablen DEFAULT_TAGS_GENERATION_PROMPT_TEMPLATE.

DEFAULT_TAGS_GENERATION_PROMPT_TEMPLATE:

### Task:
Generate 1-3 broad tags categorizing the main themes of the chat history, along with 1-3 more specific subtopic tags.

### Guidelines:
- Start with high-level domains (e.g. Science, Technology, Philosophy, Arts, Politics, Business, Health, Sports, Entertainment, Education)
- Consider including relevant subfields/subdomains if they are strongly represented throughout the conversation
- If content is too short (less than 3 messages) or too diverse, use only ["General"]
- Use the chat's primary language; default to English if multilingual
- Prioritize accuracy over specificity

### Output:
JSON format: { "tags": ["tag1", "tag2", "tag3"] }

### Chat History:
<chat_history>
{{MESSAGES:END:6}}
</chat_history>

• Beschreibung: Legt die Prompt-Vorlage für die Tag-Generierung fest.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

API-Schlüssel-Endpunktbeschränkungen

ENABLE_API_KEY

• Typ: bool
• Standard: True
• Beschreibung: Aktiviert die API-Schlüssel-Authentifizierung.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

ENABLE_API_KEY_ENDPOINT_RESTRICTIONS

• Typ: bool
• Standard: False
• Beschreibung: Aktiviert API-Schlüssel-Endpunktbeschränkungen für zusätzliche Sicherheit und Konfigurierbarkeit.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

API_KEY_ALLOWED_ENDPOINTS

• Typ: str
• Beschreibung: Gibt eine kommagetrennte Liste von zulässigen API-Endpunkten an, wenn API-Schlüssel-Endpunktbeschränkungen aktiviert sind.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

Hinweis

Der Wert von API_KEY_ALLOWED_ENDPOINTS sollte eine kommagetrennte Liste von Endpunkt-URLs sein, z. B. /api/v1/messages, /api/v1/channels.

JWT_EXPIRES_IN

• Typ: str
• Standard: -1
• Beschreibung: Legt die JWT-Ablaufzeit in Sekunden fest. Gültige Zeiteinheiten: s, m, h, d, w oder -1 für kein Ablaufdatum.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

Warnung

Das Setzen von JWT_EXPIRES_IN auf -1 deaktiviert das Ablaufdatum von JWTs, wodurch ausgestellte Token für immer gültig sind. Dies ist in der Produktion extrem gefährlich und setzt Ihr System erheblichen Sicherheitsrisiken aus, wenn Token lecken oder kompromittiert werden.

Legen Sie in der Produktion immer eine angemessene Ablaufzeit fest (z. B. 3600s, 1h usw.), um die Lebensdauer von Authentifizierungstoken zu begrenzen. Verwenden Sie niemals -1 in einer Produktionsumgebung.

Wenn Sie bereits mit JWT_EXPIRES_IN=-1 bereitgestellt haben, können Sie Ihren WEBUI_SECRET_KEY rotieren oder ändern, um alle vorhandenen Token sofort ungültig zu machen.

Sicherheitsvariablen

ENABLE_FORWARD_USER_INFO_HEADERS

• Typ: bool
• Standard: False
• Beschreibung: Leitet Benutzerinformationen (Name, ID, E-Mail, Rolle und Chat-ID) als X-Header an die OpenAI API und Ollama API weiter. Wenn aktiviert, werden die folgenden Header weitergeleitet
  • X-OpenWebUI-User-Name
  • X-OpenWebUI-User-Id
  • X-OpenWebUI-User-Email
  • X-OpenWebUI-User-Role
  • X-OpenWebUI-Chat-Id

ENABLE_WEB_LOADER_SSL_VERIFICATION

• Typ: bool
• Standard: True
• Beschreibung: Umgeht die SSL-Überprüfung für RAG auf Websites.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

WEBUI_SESSION_COOKIE_SAME_SITE

• Typ: str
• Optionen
  • lax - Setzt das Attribut SameSite auf lax, wodurch Sitzungs-Cookies mit von Drittanbieter-Websites initiierten Anfragen gesendet werden können.
  • strict - Setzt das Attribut SameSite auf strict, wodurch das Senden von Sitzungs-Cookies mit von Drittanbieter-Websites initiierten Anfragen blockiert wird.
  • none - Setzt das Attribut SameSite auf none, wodurch Sitzungs-Cookies mit von Drittanbieter-Websites initiierten Anfragen gesendet werden können, jedoch nur über HTTPS.
• Standard: lax
• Beschreibung: Legt das Attribut SameSite für Sitzungs-Cookies fest.

Warnung

Wenn ENABLE_OAUTH_SIGNUP aktiviert ist, kann das Setzen von WEBUI_SESSION_COOKIE_SAME_SITE auf strict zu Anmeldefehlern führen. Dies liegt daran, dass Open WebUI ein Sitzungs-Cookie zur Validierung des Callbacks vom OAuth-Anbieter verwendet, was zur Verhinderung von CSRF-Angriffen beiträgt.

Ein strict Sitzungs-Cookie wird jedoch nicht mit der Callback-Anfrage gesendet, was zu möglichen Anmeldeproblemen führt. Wenn Sie dieses Problem haben, verwenden Sie stattdessen den Standardwert lax.

WEBUI_SESSION_COOKIE_SECURE

• Typ: bool
• Standard: False
• Beschreibung: Legt das Attribut Secure für Sitzungs-Cookies fest, wenn es auf True gesetzt ist.

WEBUI_AUTH_COOKIE_SAME_SITE

• Typ: str
• Optionen
  • lax - Setzt das Attribut SameSite auf lax, wodurch Authentifizierungs-Cookies mit von Drittanbieter-Websites initiierten Anfragen gesendet werden können.
  • strict - Setzt das Attribut SameSite auf strict, wodurch das Senden von Authentifizierungs-Cookies mit von Drittanbieter-Websites initiierten Anfragen blockiert wird.
  • none - Setzt das Attribut SameSite auf none, wodurch Authentifizierungs-Cookies mit von Drittanbieter-Websites initiierten Anfragen gesendet werden können, jedoch nur über HTTPS.
• Standard: lax
• Beschreibung: Legt das Attribut SameSite für Authentifizierungs-Cookies fest.

Info

Wenn der Wert nicht gesetzt ist, wird WEBUI_SESSION_COOKIE_SAME_SITE als Fallback verwendet.

WEBUI_AUTH_COOKIE_SECURE

• Typ: bool
• Standard: False
• Beschreibung: Legt das Attribut Secure für Authentifizierungs-Cookies fest, wenn es auf True gesetzt ist.

Info

Wenn der Wert nicht gesetzt ist, wird WEBUI_SESSION_COOKIE_SECURE als Fallback verwendet.

WEBUI_AUTH

• Typ: bool
• Standard: True
• Beschreibung: Diese Einstellung aktiviert oder deaktiviert die Authentifizierung.

Gefahr

Wenn auf False gesetzt, wird die Authentifizierung für Ihre Open WebUI-Instanz deaktiviert. Es ist jedoch wichtig zu beachten, dass das Deaktivieren der Authentifizierung nur für Neuinstallationen ohne vorhandene Benutzer möglich ist. Wenn bereits Benutzer registriert sind, können Sie die Authentifizierung nicht direkt deaktivieren. Stellen Sie sicher, dass keine Benutzer in der Datenbank vorhanden sind, wenn Sie WEBUI_AUTH deaktivieren möchten.

WEBUI_SECRET_KEY

• Typ: str
• Standard: t0p-s3cr3t
• Docker-Standard: Zufällig generiert beim ersten Start
• Beschreibung: Überschreibt den zufällig generierten String, der für JSON Web Token verwendet wird.

Info

Bei der Bereitstellung von Open WebUI in einem Multi-Node/Worker-Cluster mit einem Load Balancer müssen Sie sicherstellen, dass der Wert von WEBUI_SECRET_KEY über alle Instanzen hinweg gleich ist, damit Benutzer weiterarbeiten können, wenn ein Knoten recycelt wird oder ihre Sitzung auf einen anderen Knoten übertragen wird. Ohne dies müssen sie sich bei jeder Änderung des zugrunde liegenden Knotens neu anmelden.

ENABLE_VERSION_UPDATE_CHECK

• Typ: bool
• Standard: True
• Beschreibung: Wenn aktiviert, prüft die Anwendung automatisch auf Updates und benachrichtigt Sie über Versionsaktualisierungen.

Info

Wenn OFFLINE_MODE aktiviert ist, wird dieses Flag ENABLE_VERSION_UPDATE_CHECK automatisch immer auf false gesetzt.

OFFLINE_MODE

• Typ: bool
• Standard: False
• Beschreibung: Deaktiviert die Netzwerkverbindungen von Open WebUI für Update-Prüfungen und automatische Modell-Downloads.

Info

Deaktiviert bei Aktivierung

• Automatische Versionsupdate-Prüfungen (siehe Flag ENABLE_VERSION_UPDATE_CHECK)
• Downloads von Embedding-Modellen vom Hugging Face Hub
  • Wenn Sie vor der Aktivierung von OFFLINE_MODE kein Embedding-Modell heruntergeladen haben, funktionieren RAG-, Websuchen- und Dokumentenanalyse-Funktionen möglicherweise nicht richtig.
• Update-Benachrichtigungen in der Benutzeroberfläche (siehe Flag ENABLE_VERSION_UPDATE_CHECK)

Weiterhin funktionsfähig

• Verbindungen zu externen LLM-APIs (OpenAI, etc.)
• OAuth-Authentifizierungsanbieter
• Websuche und RAG mit externen APIs

Lesen Sie mehr über den Offline-Modus in diesem Leitfaden.

RESET_CONFIG_ON_START

• Typ: bool
• Standard: False
• Beschreibung: Setzt die Datei config.json beim Start zurück.

SAFE_MODE

• Typ: bool
• Standard: False
• Beschreibung: Aktiviert den sicheren Modus, der potenziell unsichere Funktionen deaktiviert und alle Funktionen abschaltet.

CORS_ALLOW_ORIGIN

• Typ: str
• Standard: *
• Beschreibung: Legt die zulässigen Ursprünge für Cross-Origin Resource Sharing (CORS) fest.

RAG_EMBEDDING_MODEL_TRUST_REMOTE_CODE

• Typ: bool
• Standard: False
• Beschreibung: Bestimmt, ob benutzerdefinierte Modelle, die auf dem Hub in ihren eigenen Modelldateien definiert sind, zugelassen werden sollen.

RAG_RERANKING_MODEL_TRUST_REMOTE_CODE

• Typ: bool
• Standard: False
• Beschreibung: Bestimmt, ob benutzerdefinierte Modelle, die auf dem Hub in ihren eigenen Modelldateien für das Reranking definiert sind, zugelassen werden sollen.

RAG_EMBEDDING_MODEL_AUTO_UPDATE

• Typ: bool
• Standard: True
• Beschreibung: Schaltet das automatische Update des Sentence-Transformer-Modells um.

RAG_RERANKING_MODEL_AUTO_UPDATE

• Typ: bool
• Standard: True
• Beschreibung: Schaltet das automatische Update des Reranking-Modells um.

Vektordatenbank

VECTOR_DB

• Typ: str
• Optionen
• chroma, elasticsearch, milvus, opensearch, pgvector, qdrant, pinecone
• Standard: chroma
• Beschreibung: Gibt das zu verwendende Vektordatenbanksystem an. Diese Einstellung bestimmt, welches Vektorspeichersystem für die Verwaltung von Embeddings verwendet wird.

ChromaDB

CHROMA_TENANT

• Typ: str
• Standard: Der Wert von chromadb.DEFAULT_TENANT (eine Konstante im Modul chromadb)
• Beschreibung: Legt den Mandanten fest, den ChromaDB für RAG-Embeddings verwenden soll.

CHROMA_DATABASE

• Typ: str
• Standard: Der Wert von chromadb.DEFAULT_DATABASE (eine Konstante im Modul chromadb)
• Beschreibung: Legt die Datenbank im ChromaDB-Mandanten fest, die für RAG-Embeddings verwendet werden soll.

CHROMA_HTTP_HOST

• Typ: str
• Beschreibung: Gibt den Hostnamen eines Remote-ChromaDB-Servers an. Verwendet eine lokale ChromaDB-Instanz, wenn nicht gesetzt.

CHROMA_HTTP_PORT

• Typ: int
• Standard: 8000
• Beschreibung: Gibt den Port eines Remote-ChromaDB-Servers an.

CHROMA_HTTP_HEADERS

• Typ: str
• Beschreibung: Eine kommagetrennte Liste von HTTP-Headern, die mit jeder ChromaDB-Anfrage gesendet werden sollen.
• Beispiel: Authorization=Bearer heuhagfuahefj,User-Agent=OpenWebUI.

CHROMA_HTTP_SSL

• Typ: bool
• Standard: False
• Beschreibung: Steuert, ob SSL für ChromaDB-Serververbindungen verwendet wird oder nicht.

CHROMA_CLIENT_AUTH_PROVIDER

• Typ: str
• Beschreibung: Gibt einen Authentifizierungsanbieter für den Remote-ChromaDB-Server an.
• Beispiel: chromadb.auth.basic_authn.BasicAuthClientProvider

CHROMA_CLIENT_AUTH_CREDENTIALS

• Typ: str
• Beschreibung: Gibt Anmeldedaten für den Remote-ChromaDB-Server an.
• Beispiel: username:password

Elasticsearch

ELASTICSEARCH_API_KEY

• Typ: str
• Standard: Leere Zeichenkette (' '), da None als Standardwert festgelegt ist.
• Beschreibung: Gibt den Elasticsearch API-Schlüssel an.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

ELASTICSEARCH_CA_CERTS

• Typ: str
• Standard: Leere Zeichenkette (' '), da None als Standardwert festgelegt ist.
• Beschreibung: Gibt den Pfad zu den CA-Zertifikaten für Elasticsearch an.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

ELASTICSEARCH_CLOUD_ID

• Typ: str
• Standard: Leere Zeichenkette (' '), da None als Standardwert festgelegt ist.
• Beschreibung: Gibt die Elasticsearch Cloud-ID an.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

ELASTICSEARCH_INDEX_PREFIX

• Typ: str
• Standard: open_webui_collections
• Beschreibung: Gibt das Präfix für den Elasticsearch-Index an.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

ELASTICSEARCH_PASSWORD

• Typ: str
• Standard: Leere Zeichenkette (' '), da None als Standardwert festgelegt ist.
• Beschreibung: Gibt das Passwort für Elasticsearch an.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

ELASTICSEARCH_URL

• Typ: str
• Standard: https://:9200
• Beschreibung: Gibt die URL für die Elasticsearch-Instanz an.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

ELASTICSEARCH_USERNAME

• Typ: str
• Standard: Leere Zeichenkette (' '), da None als Standardwert festgelegt ist.
• Beschreibung: Gibt den Benutzernamen für Elasticsearch an.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

Milvus

MILVUS_URI

• Typ: str
• Standard: ${DATA_DIR}/vector_db/milvus.db
• Beschreibung: Gibt die URI für die Verbindung zur Milvus-Vektordatenbank an. Diese kann je nach Konfiguration der Bereitstellung auf einen lokalen oder entfernten Milvus-Server verweisen.

MILVUS_DB

• Typ: str
• Standard: default
• Beschreibung: Gibt die Datenbank an, mit der innerhalb einer Milvus-Instanz eine Verbindung hergestellt werden soll.

MILVUS_TOKEN

• Typ: str
• Standard: None
• Beschreibung: Gibt ein optionales Verbindungstoken für Milvus an.

MILVUS_INDEX_TYPE

• Typ: str
• Standard: HNSW
• Optionen: AUTOINDEX, FLAT, IVF_FLAT, HNSW
• Beschreibung: Gibt den zu verwendenden Index-Typ beim Erstellen einer neuen Sammlung in Milvus an. AUTOINDEX wird im Allgemeinen für Milvus-Standalone empfohlen. HNSW kann eine bessere Leistung bieten, erfordert jedoch typischerweise ein Milvus-Cluster-Setup.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

MILVUS_METRIC_TYPE

• Typ: str
• Standard: COSINE
• Optionen: COSINE, IP, L2
• Beschreibung: Gibt den Metrik-Typ für die Vektor-Ähnlichkeitssuche in Milvus an.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

MILVUS_HNSW_M

• Typ: int
• Standard: 16
• Beschreibung: Gibt den M-Parameter für den HNSW-Index-Typ in Milvus an. Dieser beeinflusst die Anzahl der bidirektionalen Verbindungen, die für jedes neue Element während der Erstellung erstellt werden. Gilt nur, wenn MILVUS_INDEX_TYPE HNSW ist.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

MILVUS_HNSW_EFCONSTRUCTION

• Typ: int
• Standard: 100
• Beschreibung: Gibt den efConstruction-Parameter für den HNSW-Index-Typ in Milvus an. Dieser beeinflusst die Größe der dynamischen Liste für die nächsten Nachbarn während der Indexerstellung. Gilt nur, wenn MILVUS_INDEX_TYPE HNSW ist.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

MILVUS_IVF_FLAT_NLIST

• Typ: int
• Standard: 128
• Beschreibung: Gibt den nlist-Parameter für den IVF_FLAT-Index-Typ in Milvus an. Dies ist die Anzahl der Cluster-Einheiten. Gilt nur, wenn MILVUS_INDEX_TYPE IVF_FLAT ist.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

OpenSearch

OPENSEARCH_CERT_VERIFY

• Typ: bool
• Standard: False
• Beschreibung: Aktiviert oder deaktiviert die OpenSearch-Zertifikatsprüfung.

OPENSEARCH_PASSWORD

• Typ: str
• Standard: None
• Beschreibung: Legt das Passwort für OpenSearch fest.

OPENSEARCH_SSL

• Typ: bool
• Standard: True
• Beschreibung: Aktiviert oder deaktiviert SSL für OpenSearch.

OPENSEARCH_URI

• Typ: str
• Standard: https://:9200
• Beschreibung: Legt die URI für OpenSearch fest.

OPENSEARCH_USERNAME

• Typ: str
• Standard: None
• Beschreibung: Legt den Benutzernamen für OpenSearch fest.

PGVector

PGVECTOR_DB_URL

• Typ: str
• Standard: Der Wert der Umgebungsvariablen DATABASE_URL
• Beschreibung: Legt die Datenbank-URL für die Modellspeicherung fest.

PGVECTOR_INITIALIZE_MAX_VECTOR_LENGTH

• Typ: str
• Standard: 1536
• Beschreibung: Gibt die maximale Vektorlänge für die PGVector-Initialisierung an.

Qdrant

QDRANT_API_KEY

• Typ: str
• Beschreibung: Legt den API-Schlüssel für Qdrant fest.

QDRANT_URI

• Typ: str
• Beschreibung: Legt die URI für Qdrant fest.

QDRANT_ON_DISK

• Typ: bool
• Standard: False
• Beschreibung: Aktiviert die Verwendung von Memmap (auch als On-Disk bekannt) als Speicher.

QDRANT_PREFER_GRPC

• Typ: bool
• Standard: False
• Beschreibung: Nutzt die gRPC-Schnittstelle, wann immer möglich.

QDRANT_GRPC_PORT

• Typ: int
• Standard: 6334
• Beschreibung: Legt die gRPC-Portnummer für Qdrant fest.

ENABLE_QDRANT_MULTITENANCY_MODE

• Typ: bool
• Standard: False
• Beschreibung: Aktiviert das Multitenancy-Muster für die Verwaltung von Qdrant-Sammlungen, was den RAM-Verbrauch und den Rechenaufwand durch Konsolidierung ähnlicher Vektordatenstrukturen erheblich reduziert. Empfohlen zu aktivieren.

Info

Dies wird alle Qdrant-Sammlungen, die im vorherigen Muster erstellt wurden (nicht-Multitenancy), trennen. Gehen Sie zu Admin-Einstellungen > Dokumente > Wissensdatenbank neu indizieren, um vorhandenes Wissen zu migrieren.

Die im vorherigen Muster erstellten Qdrant-Sammlungen werden weiterhin Ressourcen verbrauchen.

Derzeit gibt es keine Schaltfläche in der Benutzeroberfläche, um nur die Vektordatenbank zurückzusetzen. Wenn Sie Wissen in den Multitenancy-Modus migrieren möchten

• Entfernen Sie alle Sammlungen mit dem Präfix open_webui-knowledge (oder das Präfix open_webui, um alle Open WebUI-bezogenen Sammlungen zu entfernen) mithilfe des nativen Qdrant-Clients.
• Gehen Sie zu Admin-Einstellungen > Dokumente > Wissensdatenbank neu indizieren, um die vorhandene Wissensbasis zu migrieren.

Wissensdatenbank neu indizieren migriert NUR die Wissensbasis.

Gefahr

Wenn Sie sich entscheiden, das Multitenancy-Muster als Standard zu verwenden und keine alten Kenntnisse migrieren müssen, gehen Sie zu Admin-Einstellungen > Dokumente, um Vektor und Wissen zurückzusetzen, was alle Sammlungen mit dem Präfix open_webui und das gesamte gespeicherte Wissen löscht.

QDRANT_COLLECTION_PREFIX

• Typ: str
• Standard: open-webui
• Beschreibung: Legt das Präfix für Qdrant-Sammlungsnamen fest. Nützlich für Namespacing oder Isolierung von Sammlungen, insbesondere im Multitenancy-Modus. Das Ändern dieses Werts führt dazu, dass die Anwendung einen anderen Satz von Sammlungen in Qdrant verwendet. Vorhandene Sammlungen mit einem anderen Präfix werden nicht beeinträchtigt.

Pinecone

Wenn Pinecone als Vektorspeicher verwendet wird, werden die folgenden Umgebungsvariablen verwendet, um sein Verhalten zu steuern. Stellen Sie sicher, dass Sie diese Variablen in Ihrer .env-Datei oder Bereitstellungsumgebung festlegen.

PINECONE_API_KEY

• Typ: str
• Standard: None
• Beschreibung: Legt den API-Schlüssel fest, der zur Authentifizierung bei der Pinecone-Dienstleistung verwendet wird.

PINECONE_ENVIRONMENT

• Typ: str
• Standard: None
• Beschreibung: Gibt die Pinecone-Umgebung an, zu der eine Verbindung hergestellt werden soll (z. B. us-west1-gcp, gcp-starter usw.).

PINECONE_INDEX_NAME

• Typ: str
• Standard: open-webui-index
• Beschreibung: Definiert den Namen des Pinecone-Indexes, der zum Speichern und Abfragen von Vektor-Embeddings verwendet wird.

PINECONE_DIMENSION

• Typ: int
• Standard: 1536
• Beschreibung: Die Dimensionalität der Vektor-Embeddings. Muss mit der vom Index erwarteten Dimension übereinstimmen (häufig 768, 1024, 1536 oder 3072 basierend auf dem verwendeten Modell).

PINECONE_METRIC

• Typ: str
• Standard: cosine
• Optionen: cosine, dotproduct, euclidean
• Beschreibung: Gibt die Ähnlichkeitsmetrik an, die für Vektorvergleiche innerhalb des Pinecone-Indexes verwendet werden soll.

PINECONE_CLOUD

• Typ: str
• Standard: aws
• Optionen: aws, gcp, azure
• Beschreibung: Gibt den Cloud-Anbieter an, auf dem der Pinecone-Index gehostet wird.

RAG-Inhalts-Extraktions-Engine

CONTENT_EXTRACTION_ENGINE

• Typ: str
• Optionen
  • Leer lassen, um die Standardeinstellung zu verwenden
  • external - Externen Lader verwenden
  • tika - Einen lokalen Apache Tika Server verwenden
  • docling - Docling Engine verwenden
  • document_intelligence - Document Intelligence Engine verwenden
  • mistral_ocr - Mistral OCR Engine verwenden
• Beschreibung: Legt die zu verwendende Inhalts-Extraktions-Engine für die Dokumentenaufnahme fest.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

MISTRAL_OCR_API_KEY

• Typ: str
• Standard: None
• Beschreibung: Gibt den zu verwendenden Mistral OCR API-Schlüssel an.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

EXTERNAL_DOCUMENT_LOADER_URL

• Typ: str
• Standard: None
• Beschreibung: Legt die URL für den externen Dokumenten-Lader-Dienst fest.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

EXTERNAL_DOCUMENT_LOADER_API_KEY

• Typ: str
• Standard: None
• Beschreibung: Legt den API-Schlüssel für die Authentifizierung beim externen Dokumenten-Lader-Dienst fest.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

TIKA_SERVER_URL

• Typ: str
• Standard: https://:9998
• Beschreibung: Legt die URL für den Apache Tika Server fest.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

DOCLING_SERVER_URL

• Typ: str
• Standard: http://docling:5001
• Beschreibung: Gibt die URL für den Docling Server an.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

DOCLING_OCR_ENGINE

• Typ: str
• Standard: tesseract
• Beschreibung: Gibt die von Docling verwendete OCR-Engine an.
  Unterstützte Werte sind: tesseract (Standard), easyocr, ocrmac, rapidocr und tesserocr.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

DOCLING_OCR_LANG

• Typ: str
• Standard: eng,fra,deu,spa (bei Verwendung der Standard-Engine tesseract)
• Beschreibung: Gibt die zu verwendenden OCR-Sprache(n) für die konfigurierte DOCLING_OCR_ENGINE an.
  Format und verfügbare Sprachcodes hängen von der ausgewählten OCR-Engine ab.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

Retrieval Augmented Generation (RAG)

RAG_EMBEDDING_ENGINE

• Typ: str
• Optionen
  • Leer lassen für Standard (SentenceTransformers) - Verwendet SentenceTransformers für Embeddings.
  • ollama - Verwendet die Ollama API für Embeddings.
  • openai - Verwendet die OpenAI API für Embeddings.
• Beschreibung: Wählt eine zu verwendende Embedding-Engine für RAG aus.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

RAG_EMBEDDING_MODEL

• Typ: str
• Standard: sentence-transformers/all-MiniLM-L6-v2
• Beschreibung: Legt ein Modell für Embeddings fest. Lokal wird ein Sentence-Transformer-Modell verwendet.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

ENABLE_RAG_HYBRID_SEARCH

• Typ: bool
• Standard: False
• Beschreibung: Ermöglicht die Verwendung von Ensemble-Suche mit BM25 + ChromaDB, mit Reranking unter Verwendung von sentence_transformers-Modellen.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

RAG_TOP_K

• Typ: int
• Standard: 3
• Beschreibung: Legt die Standardanzahl der Ergebnisse fest, die für das Embedding bei Verwendung von RAG berücksichtigt werden sollen.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

RAG_TOP_K_RERANKER

• Typ: int
• Standard: 3
• Beschreibung: Legt die Standardanzahl der Ergebnisse fest, die für den Reranker bei Verwendung von RAG berücksichtigt werden sollen.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

RAG_RELEVANCE_THRESHOLD

• Typ: float
• Standard: 0.0
• Beschreibung: Legt den Relevanzschwellenwert fest, der für Dokumente bei Verwendung mit Reranking berücksichtigt werden soll.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

RAG_HYBRID_BM25_WEIGHT

• Typ: float
• Standard: 0.5
• Beschreibung: Legt das Gewicht fest, das der Stichwortsuche (BM25) bei der hybriden Suche zugewiesen wird. 1 bedeutet nur Stichwortsuche, 0 bedeutet nur Vektorsuche.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

RAG_TEMPLATE

• Typ: str
• Standard: Der Wert der Umgebungsvariablen DEFAULT_RAG_TEMPLATE.

DEFAULT_RAG_TEMPLATE:

### Task:
Respond to the user query using the provided context, incorporating inline citations in the format [id] **only when the <source> tag includes an explicit id attribute** (e.g., <source id="1">).

### Guidelines:
- If you don't know the answer, clearly state that.
- If uncertain, ask the user for clarification.
- Respond in the same language as the user's query.
- If the context is unreadable or of poor quality, inform the user and provide the best possible answer.
- If the answer isn't present in the context but you possess the knowledge, explain this to the user and provide the answer using your own understanding.
- **Only include inline citations using [id] (e.g., [1], [2]) when the <source> tag includes an id attribute.**
- Do not cite if the <source> tag does not contain an id attribute.
- Do not use XML tags in your response.
- Ensure citations are concise and directly related to the information provided.

### Example of Citation:
If the user asks about a specific topic and the information is found in a source with a provided id attribute, the response should include the citation like in the following example:
* "According to the study, the proposed method increases efficiency by 20% [1]."

### Output:
Provide a clear and direct response to the user's query, including inline citations in the format [id] only when the <source> tag with id attribute is present in the context.

<context>
{{CONTEXT}}
</context>

<user_query>
{{QUERY}}
</user_query>

• Beschreibung: Vorlage, die beim Einfügen von RAG-Dokumenten in die Chat-Vervollständigung verwendet wird.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

RAG_TEXT_SPLITTER

• Typ: str
• Optionen
  • character
  • token
• Standard: character
• Beschreibung: Legt den Textteiler für RAG-Modelle fest.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

TIKTOKEN_CACHE_DIR

• Typ: str
• Standard: {CACHE_DIR}/tiktoken
• Beschreibung: Legt das Verzeichnis für den TikToken-Cache fest.

TIKTOKEN_ENCODING_NAME

• Typ: str
• Standard: cl100k_base
• Beschreibung: Legt den Namen der Kodierung für TikToken fest.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

CHUNK_SIZE

• Typ: int
• Standard: 1000
• Beschreibung: Legt die Dokumenten-Chunk-Größe für Embeddings fest.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

CHUNK_OVERLAP

• Typ: int
• Standard: 100
• Beschreibung: Gibt an, wie viel Überlappung es zwischen den Chunks geben soll.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

PDF_EXTRACT_IMAGES

• Typ: bool
• Standard: False
• Beschreibung: Extrahiert Bilder aus PDFs mithilfe von OCR beim Laden von Dokumenten.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

RAG_FILE_MAX_SIZE

• Typ: int
• Beschreibung: Legt die maximale Größe einer Datei in Megabyte fest, die für die Dokumentenaufnahme hochgeladen werden kann.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

RAG_FILE_MAX_COUNT

• Typ: int
• Beschreibung: Legt die maximale Anzahl von Dateien fest, die gleichzeitig für die Dokumenteninjektion hochgeladen werden können.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

Info

Stellen Sie bei der Konfiguration von RAG_FILE_MAX_SIZE und RAG_FILE_MAX_COUNT sicher, dass die Werte angemessen sind, um übermäßige Dateiuploads und potenzielle Leistungsprobleme zu vermeiden.

RAG_ALLOWED_FILE_EXTENSIONS

• Typ: list von str
• Standard: [] (was bedeutet, dass alle unterstützten Dateitypen zulässig sind)
• Beschreibung: Gibt an, welche Dateierweiterungen für den Upload zulässig sind.

["pdf,docx,txt"]

• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

RAG_RERANKING_MODEL

• Typ: str
• Beschreibung: Legt ein Modell für das Neuanordnen von Ergebnissen fest. Lokal wird ein Sentence-Transformer-Modell verwendet.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

RAG_OPENAI_API_BASE_URL

• Typ: str
• Standard: ${OPENAI_API_BASE_URL}
• Beschreibung: Legt die OpenAI-Basis-API-URL fest, die für RAG-Embeddings verwendet werden soll.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

RAG_OPENAI_API_KEY

• Typ: str
• Standard: ${OPENAI_API_KEY}
• Beschreibung: Legt den OpenAI-API-Schlüssel fest, der für RAG-Embeddings verwendet werden soll.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

RAG_EMBEDDING_OPENAI_BATCH_SIZE

• Typ: int
• Standard: 1
• Beschreibung: Legt die Batch-Größe für OpenAI-Embeddings fest.

RAG_EMBEDDING_BATCH_SIZE

• Typ: int
• Standard: 1
• Beschreibung: Legt die Batch-Größe für Embeddings in RAG-Modellen (Retrieval-Augmented Generator) fest.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

RAG_OLLAMA_API_KEY

• Typ: str
• Beschreibung: Legt den API-Schlüssel für die Ollama-API fest, der in RAG-Modellen verwendet wird.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

RAG_OLLAMA_BASE_URL

• Typ: str
• Beschreibung: Legt die Basis-URL für die Ollama-API fest, die in RAG-Modellen verwendet wird.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

ENABLE_RETRIEVAL_QUERY_GENERATION

• Typ: bool
• Standard: True
• Beschreibung: Aktiviert oder deaktiviert die Generierung von Abfragen für die Abrufung.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

QUERY_GENERATION_PROMPT_TEMPLATE

• Typ: str
• Standard: Der Wert der Umgebungsvariablen DEFAULT_QUERY_GENERATION_PROMPT_TEMPLATE.

DEFAULT_QUERY_GENERATION_PROMPT_TEMPLATE:

### Task:
Analyze the chat history to determine the necessity of generating search queries, in the given language. By default, **prioritize generating 1-3 broad and relevant search queries** unless it is absolutely certain that no additional information is required. The aim is to retrieve comprehensive, updated, and valuable information even with minimal uncertainty. If no search is unequivocally needed, return an empty list.

### Guidelines:
- Respond **EXCLUSIVELY** with a JSON object. Any form of extra commentary, explanation, or additional text is strictly prohibited.
- When generating search queries, respond in the format: { "queries": ["query1", "query2"] }, ensuring each query is distinct, concise, and relevant to the topic.
- If and only if it is entirely certain that no useful results can be retrieved by a search, return: { "queries": [] }.
- Err on the side of suggesting search queries if there is **any chance** they might provide useful or updated information.
- Be concise and focused on composing high-quality search queries, avoiding unnecessary elaboration, commentary, or assumptions.
- Today's date is: {{CURRENT_DATE}}.
- Always prioritize providing actionable and broad queries that maximize informational coverage.

### Output:
Strictly return in JSON format: 
{
  "queries": ["query1", "query2"]
}

### Chat History:
<chat_history>
{{MESSAGES:END:6}}
</chat_history>

• Beschreibung: Legt die Prompt-Vorlage für die Abfragegenerierung fest.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

BYPASS_EMBEDDING_AND_RETRIEVAL

• Typ: bool
• Standard: False
• Beschreibung: Umgeht den Embedding- und Abrufungsprozess.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

DOCUMENT_INTELLIGENCE_ENDPOINT

• Typ: str
• Standard: None
• Beschreibung: Gibt den Endpunkt für die Dokumentenintelligenz an.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

DOCUMENT_INTELLIGENCE_KEY

• Typ: str
• Standard: None
• Beschreibung: Gibt den Schlüssel für die Dokumentenintelligenz an.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

ENABLE_RAG_LOCAL_WEB_FETCH

• Typ: bool
• Standard: False
• Beschreibung: Aktiviert oder deaktiviert das lokale Web-Fetching für RAG.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

RAG_EMBEDDING_CONTENT_PREFIX

• Typ: str
• Standard: None
• Beschreibung: Gibt das Präfix für den RAG-Embedding-Inhalt an.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

RAG_EMBEDDING_PREFIX_FIELD_NAME

• Typ: str
• Standard: None
• Beschreibung: Gibt den Feldnamen für das RAG-Embedding-Präfix an.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

RAG_EMBEDDING_QUERY_PREFIX

• Typ: str
• Standard: None
• Beschreibung: Gibt das Präfix für die RAG-Embedding-Abfrage an.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

RAG_FULL_CONTEXT

• Typ: bool
• Standard: False
• Beschreibung: Gibt an, ob der vollständige Kontext für RAG verwendet werden soll.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

Google Drive

ENABLE_GOOGLE_DRIVE_INTEGRATION

• Typ: bool
• Standard: False
• Beschreibung: Aktiviert oder deaktiviert die Google Drive-Integration. Wenn auf true gesetzt und GOOGLE_DRIVE_CLIENT_ID & GOOGLE_DRIVE_API_KEY beide konfiguriert sind, wird Google Drive als Upload-Option in der Chat-Benutzeroberfläche angezeigt.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

Info

Wenn Sie GOOGLE_DRIVE_INTEGRATION aktivieren, stellen Sie sicher, dass Sie GOOGLE_DRIVE_CLIENT_ID und GOOGLE_DRIVE_API_KEY korrekt konfiguriert haben und die Nutzungsbedingungen und Richtlinien von Google überprüft haben.

GOOGLE_DRIVE_CLIENT_ID

• Typ: str
• Beschreibung: Legt die Client-ID für Google Drive fest (Client muss mit aktivierter Drive API und Picker API konfiguriert sein).
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

GOOGLE_DRIVE_API_KEY

• Typ: str
• Beschreibung: Legt den API-Schlüssel für die Google Drive-Integration fest.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

OneDrive

ENABLE_ONEDRIVE_INTEGRATION

• Typ: bool
• Standard: False
• Beschreibung: Aktiviert oder deaktiviert die OneDrive-Integration.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

ONEDRIVE_CLIENT_ID

• Typ: str
• Standard: None
• Beschreibung: Gibt die Client-ID für die OneDrive-Integration an.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

ONEDRIVE_SHAREPOINT_URL

• Typ: str
• Standard: None
• Beschreibung: Gibt die SharePoint-Site-URL für die OneDrive-Integration an, z. B. https://companyname.sharepoint.com.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

ONEDRIVE_SHAREPOINT_TENANT_ID

• Typ: str
• Standard: None
• Beschreibung: Gibt die SharePoint-Tenant-ID für die OneDrive-Integration an.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

Websuche

ENABLE_WEB_SEARCH

• Typ: bool
• Standard: False
• Beschreibung: Aktiviert den Websuch-Schalter.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

ENABLE_SEARCH_QUERY_GENERATION

• Typ: bool
• Standard: True
• Beschreibung: Aktiviert oder deaktiviert die Generierung von Suchanfragen.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

WEB_SEARCH_TRUST_ENV

• Typ: bool
• Standard: False
• Beschreibung: Aktiviert den durch http_proxy und https_proxy gesetzten Proxy beim Abrufen von Websuchergebnissen.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

WEB_SEARCH_RESULT_COUNT

• Typ: int
• Standard: 3
• Beschreibung: Maximale Anzahl von Suchergebnissen, die gecrawlt werden sollen.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

WEB_SEARCH_CONCURRENT_REQUESTS

• Typ: int
• Standard: 10
• Beschreibung: Anzahl gleichzeitiger Anfragen zum Crawlen von Webseiten, die aus Suchergebnissen zurückgegeben werden.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

WEB_SEARCH_ENGINE

• Typ: str
• Optionen
  • searxng - Verwendet die SearXNG-Suchmaschine.
  • google_pse - Verwendet die Google Programmable Search Engine.
  • brave - Verwendet die Brave-Suchmaschine.
  • kagi - Verwendet die Kagi-Suchmaschine.
  • mojeek - Verwendet die Mojeek-Suchmaschine.
  • bocha - Verwendet die Bocha-Suchmaschine.
  • serpstack - Verwendet die Serpstack-Suchmaschine.
  • serper - Verwendet die Serper-Suchmaschine.
  • serply - Verwendet die Serply-Suchmaschine.
  • searchapi - Verwendet die SearchAPI-Suchmaschine.
  • serpapi - Verwendet die SerpApi-Suchmaschine.
  • duckduckgo - Verwendet die DuckDuckGo-Suchmaschine.
  • tavily - Verwendet die Tavily-Suchmaschine.
  • jina - Verwendet die Jina-Suchmaschine.
  • bing - Verwendet die Bing-Suchmaschine.
  • exa - Verwendet die Exa-Suchmaschine.
  • perplexity - Verwendet die Perplexity AI-Suchmaschine.
  • sougou - Verwendet die Sougou-Suchmaschine.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

BYPASS_WEB_SEARCH_EMBEDDING_AND_RETRIEVAL

• Typ: bool
• Standard: False
• Beschreibung: Umgeht den Prozess des Einbettens und Abrufens von Websuchen.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

SEARXNG_QUERY_URL

• Typ: str
• Beschreibung: Die SearXNG Search API-URL, die JSON-Ausgabe unterstützt. <query> wird durch die Suchanfrage ersetzt. Beispiel: http://searxng.local/search?q=<query>
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

GOOGLE_PSE_API_KEY

• Typ: str
• Beschreibung: Legt den API-Schlüssel für den Google Programmable Search Engine (PSE) -Dienst fest.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

GOOGLE_PSE_ENGINE_ID

• Typ: str
• Beschreibung: Die Engine-ID für den Google Programmable Search Engine (PSE) -Dienst.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

BRAVE_SEARCH_API_KEY

• Typ: str
• Beschreibung: Legt den API-Schlüssel für die Brave Search API fest.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

KAGI_SEARCH_API_KEY

• Typ: str
• Beschreibung: Legt den API-Schlüssel für die Kagi Search API fest.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

MOJEEK_SEARCH_API_KEY

• Typ: str
• Beschreibung: Legt den API-Schlüssel für die Mojeek Search API fest.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

SERPSTACK_API_KEY

• Typ: str
• Beschreibung: Legt den API-Schlüssel für die Serpstack-Such-API fest.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

SERPSTACK_HTTPS

• Typ: bool
• Standard: True
• Beschreibung: Konfiguriert die Verwendung von HTTPS für Serpstack-Anfragen. Anfragen des kostenlosen Tarifs sind nur über HTTP zulässig.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

SERPER_API_KEY

• Typ: str
• Beschreibung: Legt den API-Schlüssel für die Serper-Such-API fest.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

SERPLY_API_KEY

• Typ: str
• Beschreibung: Legt den API-Schlüssel für die Serply-Such-API fest.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

SEARCHAPI_API_KEY

• Typ: str
• Beschreibung: Legt den API-Schlüssel für SearchAPI fest.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

SEARCHAPI_ENGINE

• Typ: str
• Beschreibung: Legt die SearchAPI-Engine fest.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

TAVILY_API_KEY

• Typ: str
• Beschreibung: Legt den API-Schlüssel für die Tavily-Such-API fest.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

JINA_API_KEY

• Typ: str
• Beschreibung: Legt den API-Schlüssel für Jina fest.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

BING_SEARCH_V7_ENDPOINT

• Typ: str
• Beschreibung: Legt den Endpunkt für die Bing Search API fest.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

BING_SEARCH_V7_SUBSCRIPTION_KEY

• Typ: str
• Standard: https://api.bing.microsoft.com/v7.0/search
• Beschreibung: Legt den Abonnement-Schlüssel für die Bing Search API fest.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

BOCHA_SEARCH_API_KEY

• Typ: str
• Standard: None
• Beschreibung: Legt den API-Schlüssel für die Bocha Search API fest.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

EXA_API_KEY

• Typ: str
• Standard: None
• Beschreibung: Legt den API-Schlüssel für die Exa-Such-API fest.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

SERPAPI_API_KEY

• Typ: str
• Standard: None
• Beschreibung: Legt den API-Schlüssel für SerpAPI fest.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

SERPAPI_ENGINE

• Typ: str
• Standard: None
• Beschreibung: Gibt die Suchmaschine an, die für SerpAPI verwendet werden soll.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

SOUGOU_API_SID

• Typ: str
• Standard: None
• Beschreibung: Legt die Sogou API SID fest.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

SOUGOU_API_SK

• Typ: str
• Standard: None
• Beschreibung: Legt die Sogou API SK fest.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

TAVILY_EXTRACT_DEPTH

• Typ: str
• Standard: basic
• Beschreibung: Gibt die Extraktionstiefe für Tavily-Suchergebnisse an.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

Web Loader Konfiguration

WEB_LOADER_ENGINE

• Typ: str
• Standard: safe_web
• Beschreibung: Gibt den Loader an, der zum Abrufen und Verarbeiten von Webinhalten verwendet werden soll.
• Optionen
  • requests - Verwendet das Requests-Modul mit verbesserter Fehlerbehandlung.
  • playwright - Verwendet Playwright für fortgeschrittenere Webseiten-Rendering- und Interaktionsfunktionen.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

Info

Bei Verwendung von playwright haben Sie zwei Optionen

1. Wenn PLAYWRIGHT_WS_URI nicht gesetzt ist, wird Playwright mit Chromium-Abhängigkeiten beim Start automatisch im Open WebUI-Container installiert.
2. Wenn PLAYWRIGHT_WS_URI gesetzt ist, wird Open WebUI eine Verbindung zu einer Remote-Browserinstanz herstellen, anstatt Abhängigkeiten lokal zu installieren.

PLAYWRIGHT_WS_URL

• Typ: str
• Standard: None
• Beschreibung: Gibt die WebSocket-URI einer Remote-Playwright-Browserinstanz an. Wenn gesetzt, verwendet Open WebUI diesen Remote-Browser anstelle der lokalen Installation von Browser-Abhängigkeiten. Dies ist besonders nützlich in Containerumgebungen, in denen der Open WebUI-Container schlank gehalten und Browser-Angelegenheiten getrennt werden sollen. Beispiel: ws://playwright:3000
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

Tipp

Die Verwendung eines Remote-Playwright-Browsers über PLAYWRIGHT_WS_URL kann vorteilhaft sein für

• Reduzierung der Größe des Open WebUI-Containers
• Verwendung eines anderen Browsers als des Standard-Chromium
• Verbindung zu einem Nicht-Headless-Browser (GUI)

FIRECRAWL_API_BASE_URL

• Typ: str
• Standard: https://api.firecrawl.dev
• Beschreibung: Legt die Basis-URL für die Firecrawl-API fest.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

FIRECRAWL_API_KEY

• Typ: str
• Standard: None
• Beschreibung: Legt den API-Schlüssel für die Firecrawl-API fest.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

PERPLEXITY_API_KEY

• Typ: str
• Standard: None
• Beschreibung: Legt den API-Schlüssel für die Perplexity-API fest.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

PLAYWRIGHT_TIMEOUT

• Typ: int
• Standard: Leere Zeichenkette (' '), da None als Standardwert festgelegt ist.
• Beschreibung: Legt das Timeout für Playwright-Anfragen fest.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

YouTube Loader

YOUTUBE_LOADER_PROXY_URL

• Typ: str
• Beschreibung: Legt die Proxy-URL für den YouTube-Loader fest.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

YOUTUBE_LOADER_LANGUAGE

• Typ: str
• Standard: en
• Beschreibung: Komma-getrennte Liste von Sprachcodes, die beim Abrufen von YouTube-Transkriptionen in der Reihenfolge der Priorität versucht werden.
• Beispiel: Wenn auf es,de gesetzt, werden zuerst spanische Transkriptionen versucht, dann deutsche, wenn spanisch nicht verfügbar war, und zuletzt englische. Hinweis: Wenn keine der angegebenen Sprachen verfügbar ist und en nicht in Ihrer Liste war, versucht das System automatisch Englisch als letzten Fallback.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

Audio

Whisper Sprache-zu-Text (Lokal)

WHISPER_MODEL

• Typ: str
• Standard: base
• Beschreibung: Legt das Whisper-Modell fest, das für Sprache-zu-Text verwendet werden soll. Das verwendete Backend ist faster_whisper mit Quantisierung auf int8.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

WHISPER_MODEL_DIR

• Typ: str
• Standard: ${DATA_DIR}/cache/whisper/models
• Beschreibung: Gibt das Verzeichnis an, in dem Whisper-Modell-Dateien gespeichert werden sollen.

WHISPER_VAD_FILTER

• Typ: bool
• Standard: False
• Beschreibung: Gibt an, ob ein Voice Activity Detection (VAD) -Filter für Whisper Sprache-zu-Text angewendet werden soll.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

WHISPER_MODEL_AUTO_UPDATE

• Typ: bool
• Standard: False
• Beschreibung: Schaltet die automatische Aktualisierung des Whisper-Modells um.

WHISPER_LANGUAGE

• Typ: str
• Standard: None
• Beschreibung: Gibt die ISO 639-1-Sprache an, die Whisper für STT verwendet (ISO 639-2 für Hawaiianisch und Kantonesisch). Whisper sagt die Sprache standardmäßig voraus.

Sprache-zu-Text (OpenAI)

AUDIO_STT_ENGINE

• Typ: str
• Optionen
  • Leer lassen, um die integrierte lokale Whisper-Engine für Sprache-zu-Text zu verwenden.
  • openai - Verwendet die OpenAI-Engine für Sprache-zu-Text.
  • deepgram - Verwendet die Deepgram-Engine für Sprache-zu-Text.
  • azure - Verwendet die Azure-Engine für Sprache-zu-Text.
• Beschreibung: Gibt die zu verwendende Sprache-zu-Text-Engine an.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

AUDIO_STT_MODEL

• Typ: str
• Standard: whisper-1
• Beschreibung: Gibt das zu verwendende Sprache-zu-Text-Modell für OpenAI-kompatible Endpunkte an.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

AUDIO_STT_OPENAI_API_BASE_URL

• Typ: str
• Standard: ${OPENAI_API_BASE_URL}
• Beschreibung: Legt die OpenAI-kompatible Basis-URL fest, die für Sprache-zu-Text verwendet werden soll.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

AUDIO_STT_OPENAI_API_KEY

• Typ: str
• Standard: ${OPENAI_API_KEY}
• Beschreibung: Legt den OpenAI-API-Schlüssel fest, der für Sprache-zu-Text verwendet werden soll.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

Sprache-zu-Text (Azure)

AUDIO_STT_AZURE_API_KEY

• Typ: str
• Standard: None
• Beschreibung: Gibt den Azure-API-Schlüssel an, der für Sprache-zu-Text verwendet werden soll.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

AUDIO_STT_AZURE_REGION

• Typ: str
• Standard: None
• Beschreibung: Gibt die Azure-Region an, die für Sprache-zu-Text verwendet werden soll.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

AUDIO_STT_AZURE_LOCALES

• Typ: str
• Standard: None
• Beschreibung: Gibt die zu verwendenden Lokalisierungen für Azure Sprache-zu-Text an.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

Sprache-zu-Text (Deepgram)

DEEPGRAM_API_KEY

• Typ: str
• Standard: None
• Beschreibung: Gibt den Deepgram-API-Schlüssel an, der für Sprache-zu-Text verwendet werden soll.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

Text-zu-Sprache

AUDIO_TTS_API_KEY

• Typ: str
• Beschreibung: Legt den API-Schlüssel für Text-zu-Sprache fest.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

AUDIO_TTS_ENGINE

• Typ: str
• Optionen
  • Leer lassen, um die integrierte WebAPI-Engine für Text-zu-Sprache zu verwenden.
  • azure - Verwendet die Azure-Engine für Text-zu-Sprache.
  • elevenlabs - Verwendet die ElevenLabs-Engine für Text-zu-Sprache.
  • openai - Verwendet die OpenAI-Engine für Text-zu-Sprache.
  • transformers - Verwendet SentenceTransformers für Text-zu-Sprache.
• Beschreibung: Gibt die zu verwendende Text-zu-Sprache-Engine an.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

AUDIO_TTS_MODEL

• Typ: str
• Standard: tts-1
• Beschreibung: Gibt das OpenAI-Text-zu-Sprache-Modell an, das verwendet werden soll.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

AUDIO_TTS_VOICE

• Typ: str
• Standard: alloy
• Beschreibung: Legt die zu verwendende OpenAI-Text-zu-Sprache-Stimme fest.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

AUDIO_TTS_SPLIT_ON

• Typ: str
• Standard: punctuation
• Beschreibung: Legt fest, auf welche Satzzeichen die OpenAI-Text-zu-Sprache-Ausgabe aufgeteilt werden soll.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

Azure Text-zu-Sprache

AUDIO_TTS_AZURE_SPEECH_REGION

• Typ: str
• Beschreibung: Legt die Region für Azure Text-zu-Sprache fest.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

AUDIO_TTS_AZURE_SPEECH_OUTPUT_FORMAT

• Typ: str
• Beschreibung: Legt das Ausgabeformat für Azure Text-zu-Sprache fest.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

OpenAI Text-zu-Sprache

AUDIO_TTS_OPENAI_API_BASE_URL

• Typ: str
• Standard: ${OPENAI_API_BASE_URL}
• Beschreibung: Legt die OpenAI-kompatible Basis-URL fest, die für Text-zu-Sprache verwendet werden soll.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

AUDIO_TTS_OPENAI_API_KEY

• Typ: str
• Standard: ${OPENAI_API_KEY}
• Beschreibung: Legt den API-Schlüssel fest, der für Text-zu-Sprache verwendet werden soll.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

Bilderzeugung

IMAGE_GENERATION_ENGINE

• Typ: str
• Optionen
  • openai - Verwendet OpenAI DALL-E für die Bilderzeugung.
  • comfyui - Verwendet die ComfyUI-Engine für die Bilderzeugung.
  • automatic1111 - Verwendet die AUTOMATIC1111-Engine für die Bilderzeugung.
  • gemini - Verwendet Gemini für die Bilderzeugung.
• Standard: openai
• Beschreibung: Gibt die zu verwendende Engine für die Bilderzeugung an.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

ENABLE_IMAGE_GENERATION

• Typ: bool
• Standard: False
• Beschreibung: Aktiviert oder deaktiviert Funktionen zur Bilderzeugung.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

ENABLE_IMAGE_PROMPT_GENERATION

• Typ: bool
• Standard: True
• Beschreibung: Aktiviert oder deaktiviert die Generierung von Bild-Prompts.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

IMAGE_PROMPT_GENERATION_PROMPT_TEMPLATE

• Typ: str
• Standard: None
• Beschreibung: Gibt die zu verwendende Vorlage für die Generierung von Bild-Prompts an.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

DEFAULT_IMAGE_PROMPT_GENERATION_PROMPT_TEMPLATE:

### Task:
Generate a detailed prompt for am image generation task based on the given language and context. Describe the image as if you were explaining it to someone who cannot see it. Include relevant details, colors, shapes, and any other important elements.

### Guidelines:
- Be descriptive and detailed, focusing on the most important aspects of the image.
- Avoid making assumptions or adding information not present in the image.
- Use the chat's primary language; default to English if multilingual.
- If the image is too complex, focus on the most prominent elements.

### Output:
Strictly return in JSON format:
{
    "prompt": "Your detailed description here."
}

### Chat History:
<chat_history>
{{MESSAGES:END:6}}
</chat_history>

IMAGE_SIZE

• Typ: str
• Standard: 512x512
• Beschreibung: Legt die Standardgröße der zu erzeugenden Bilder fest.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

IMAGE_STEPS

• Typ: int
• Standard: 50
• Beschreibung: Legt die Standard-Iterationsschritte für die Bilderzeugung fest. Wird für ComfyUI und AUTOMATIC1111 verwendet.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

IMAGE_GENERATION_MODEL

• Typ: str
• Beschreibung: Standardmodell, das für die Bilderzeugung verwendet werden soll
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

AUTOMATIC1111

AUTOMATIC1111_BASE_URL

• Typ: str
• Beschreibung: Gibt die URL zur Stable Diffusion API von AUTOMATIC1111 an.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

AUTOMATIC1111_API_AUTH

• Typ: str
• Beschreibung: Legt die Authentifizierung für die AUTOMATIC1111 API fest.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

AUTOMATIC1111_CFG_SCALE

• Typ: float
• Beschreibung: Legt die Skalierung für die AUTOMATIC1111-Inferenz fest.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

AUTOMATIC1111_SAMPLER

• Typ: str
• Beschreibung: Legt den Sampler für die AUTOMATIC1111-Inferenz fest.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

AUTOMATIC1111_SCHEDULER

• Typ: str
• Beschreibung: Legt den Scheduler für die AUTOMATIC1111-Inferenz fest.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

ComfyUI

COMFYUI_BASE_URL

• Typ: str
• Beschreibung: Gibt die URL zur ComfyUI-Bilderzeugungs-API an.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

COMFYUI_API_KEY

• Typ: str
• Beschreibung: Legt den API-Schlüssel für ComfyUI fest.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

COMFYUI_WORKFLOW

• Typ: str
• Standard

{
  "3": {
    "inputs": {
      "seed": 0,
      "steps": 20,
      "cfg": 8,
      "sampler_name": "euler",
      "scheduler": "normal",
      "denoise": 1,
      "model": [
        "4",
        0
      ],
      "positive": [
        "6",
        0
      ],
      "negative": [
        "7",
        0
      ],
      "latent_image": [
        "5",
        0
      ]
    },
    "class_type": "KSampler",
    "_meta": {
      "title": "KSampler"
    }
  },
  "4": {
    "inputs": {
      "ckpt_name": "model.safetensors"
    },
    "class_type": "CheckpointLoaderSimple",
    "_meta": {
      "title": "Load Checkpoint"
    }
  },
  "5": {
    "inputs": {
      "width": 512,
      "height": 512,
      "batch_size": 1
    },
    "class_type": "EmptyLatentImage",
    "_meta": {
      "title": "Empty Latent Image"
    }
  },
  "6": {
    "inputs": {
      "text": "Prompt",
      "clip": [
        "4",
        1
      ]
    },
    "class_type": "CLIPTextEncode",
    "_meta": {
      "title": "CLIP Text Encode (Prompt)"
    }
  },
  "7": {
    "inputs": {
      "text": "",
      "clip": [
        "4",
        1
      ]
    },
    "class_type": "CLIPTextEncode",
    "_meta": {
      "title": "CLIP Text Encode (Prompt)"
    }
  },
  "8": {
    "inputs": {
      "samples": [
        "3",
        0
      ],
      "vae": [
        "4",
        2
      ]
    },
    "class_type": "VAEDecode",
    "_meta": {
      "title": "VAE Decode"
    }
  },
  "9": {
    "inputs": {
      "filename_prefix": "ComfyUI",
      "images": [
        "8",
        0
      ]
    },
    "class_type": "SaveImage",
    "_meta": {
      "title": "Save Image"
    }
  }
}

• Beschreibung: Legt den ComfyUI-Workflow fest.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

Gemini

GEMINI_API_BASE_URL

• Typ: str
• Standard: None
• Beschreibung: Gibt die URL zur Gemini-API an.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

GEMINI_API_KEY

• Typ: str
• Standard: None
• Beschreibung: Legt den Gemini-API-Schlüssel fest.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

IMAGES_GEMINI_API_BASE_URL

• Typ: str
• Standard: None
• Beschreibung: Gibt die URL zur Gemini-API für die Bilderzeugung an.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

IMAGES_GEMINI_API_KEY

• Typ: str
• Standard: None
• Beschreibung: Legt den Gemini-API-Schlüssel für die Bilderzeugung fest.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

OpenAI DALL-E

IMAGES_OPENAI_API_BASE_URL

• Typ: str
• Standard: ${OPENAI_API_BASE_URL}
• Beschreibung: Legt die OpenAI-kompatible Basis-URL fest, die für die DALL-E-Bilderzeugung verwendet werden soll.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

IMAGES_OPENAI_API_KEY

• Typ: str
• Standard: ${OPENAI_API_KEY}
• Beschreibung: Legt den API-Schlüssel fest, der für die DALL-E-Bilderzeugung verwendet werden soll.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

OAuth

Info

Sie können immer nur einen OAUTH-Anbieter gleichzeitig konfigurieren. Sie können nicht zwei oder mehr OAUTH-Anbieter gleichzeitig konfigurieren.

ENABLE_OAUTH_SIGNUP

• Typ: bool
• Standard: False
• Beschreibung: Ermöglicht die Kontoerstellung bei der Anmeldung über OAuth. Abweichend von ENABLE_SIGNUP.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

Gefahr

ENABLE_LOGIN_FORM muss auf False gesetzt werden, wenn ENABLE_OAUTH_SIGNUP auf True gesetzt ist. Andernfalls ist eine Anmeldung nicht möglich.

OAUTH_MERGE_ACCOUNTS_BY_EMAIL

• Typ: bool
• Standard: False
• Beschreibung: Wenn aktiviert, werden OAuth-Konten mit vorhandenen Konten mit derselben E-Mail-Adresse zusammengeführt. Dies gilt als unsicher, da nicht alle OAuth-Anbieter E-Mail-Adressen verifizieren und dies zu potenziellen Kontoübernahmen führen kann.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

OAUTH_UPDATE_PICTURE_ON_LOGIN

• Typ: bool
• Standard: False
• Beschreibung: Wenn aktiviert, wird das lokale Benutzerprofilbild beim Einloggen mit dem von OAuth bereitgestellten Bild aktualisiert.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

Info

Wenn der OAuth-Bild-Claim durch Setzen von OAUTH_PICTURE_CLAIM auf '' (leerer String) deaktiviert ist, dann wird das Setzen dieser Variablen auf true die Benutzerprofilbilder nicht aktualisieren.

WEBUI_AUTH_TRUSTED_EMAIL_HEADER

• Typ: str
• Beschreibung: Definiert den vertrauenswürdigen Anforderungsheader für die Authentifizierung. Siehe SSO-Dokumentation.

WEBUI_AUTH_TRUSTED_NAME_HEADER

• Typ: str
• Beschreibung: Definiert den vertrauenswürdigen Anforderungsheader für den Benutzernamen von Personen, die sich mit dem Header WEBUI_AUTH_TRUSTED_EMAIL_HEADER registrieren. Siehe SSO-Dokumentation.

WEBUI_AUTH_TRUSTED_GROUPS_HEADER

• Typ: str
• Beschreibung: Definiert den vertrauenswürdigen Anforderungsheader, der eine kommagetrennte Liste von Gruppenmitgliedschaften für den Benutzer enthält, wenn eine vertrauenswürdige Header-Authentifizierung verwendet wird. Siehe SSO-Dokumentation.

Google

Siehe https://support.google.com/cloud/answer/6158849?hl=en

Info

Sie müssen auch OPENID_PROVIDER_URL setzen, sonst funktioniert die Abmeldung möglicherweise nicht.

GOOGLE_CLIENT_ID

• Typ: str
• Beschreibung: Legt die Client-ID für Google OAuth fest.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

GOOGLE_CLIENT_SECRET

• Typ: str
• Beschreibung: Legt das Client-Secret für Google OAuth fest.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

GOOGLE_OAUTH_SCOPE

• Typ: str
• Standard: openid email profile
• Beschreibung: Legt den Scope für die Google OAuth-Authentifizierung fest.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

GOOGLE_REDIRECT_URI

• Typ: str
• Standard: <backend>/oauth/google/callback
• Beschreibung: Legt die Weiterleitungs-URI für Google OAuth fest.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

Microsoft

Siehe https://learn.microsoft.com/en-us/entra/identity-platform/quickstart-register-app

Info

Sie müssen auch OPENID_PROVIDER_URL setzen, sonst funktioniert die Abmeldung möglicherweise nicht.

MICROSOFT_CLIENT_ID

• Typ: str
• Beschreibung: Legt die Client-ID für Microsoft OAuth fest.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

MICROSOFT_CLIENT_SECRET

• Typ: str
• Beschreibung: Legt das Client-Secret für Microsoft OAuth fest.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

MICROSOFT_CLIENT_TENANT_ID

• Typ: str
• Beschreibung: Legt die Tenant-ID für Microsoft OAuth fest.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

MICROSOFT_OAUTH_SCOPE

• Typ: str
• Standard: openid email profile
• Beschreibung: Legt den Scope für die Microsoft OAuth-Authentifizierung fest.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

MICROSOFT_REDIRECT_URI

• Typ: str
• Standard: <backend>/oauth/microsoft/callback
• Beschreibung: Legt die Weiterleitungs-URI für Microsoft OAuth fest.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

GitHub

Siehe https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/authorizing-oauth-apps

Info

Sie müssen auch OPENID_PROVIDER_URL setzen, sonst funktioniert die Abmeldung möglicherweise nicht.

GITHUB_CLIENT_ID

• Typ: str
• Beschreibung: Legt die Client-ID für GitHub OAuth fest.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

GITHUB_CLIENT_SECRET

• Typ: str
• Beschreibung: Legt das Client-Secret für GitHub OAuth fest.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

GITHUB_CLIENT_SCOPE

• Typ: str
• Standard: user:email
• Beschreibung: Legt den Scope für die GitHub OAuth-Authentifizierung fest.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

GITHUB_CLIENT_REDIRECT_URI

• Typ: str
• Standard: <backend>/oauth/github/callback
• Beschreibung: Legt die Weiterleitungs-URI für GitHub OAuth fest.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

OpenID (OIDC)

OAUTH_CLIENT_ID

• Typ: str
• Beschreibung: Legt die Client-ID für OIDC fest.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

OAUTH_CLIENT_SECRET

• Typ: str
• Beschreibung: Legt das Client-Secret für OIDC fest.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

OPENID_PROVIDER_URL

• Typ: str
• Beschreibung: Pfad zum Endpunkt .well-known/openid-configuration
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

Gefahr

Die Umgebungsvariable OPENID_PROVIDER_URL MUSS konfiguriert sein, da sonst die Abmeldefunktion für die meisten Anbieter nicht funktioniert. Auch bei der Verwendung von Microsoft, GitHub oder anderen Anbietern MÜSSEN Sie die Umgebungsvariable OPENID_PROVIDER_URL setzen.

OPENID_REDIRECT_URI

• Typ: str
• Standard: <backend>/oauth/oidc/callback
• Beschreibung: Legt die Weiterleitungs-URI für OIDC fest.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

OAUTH_SCOPES

• Typ: str
• Standard: openid email profile
• Beschreibung: Legt den Scope für die OIDC-Authentifizierung fest. openid und email sind erforderlich.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

OAUTH_CODE_CHALLENGE_METHOD

• Typ: str
• Standard: Leere Zeichenkette (' '), da None als Standardwert festgelegt ist.
• Beschreibung: Legt die Code-Challenge-Methode für die OAuth-Authentifizierung fest.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

OAUTH_PROVIDER_NAME

• Typ: str
• Standard: SSO
• Beschreibung: Legt den Namen für den OIDC-Anbieter fest.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

OAUTH_USERNAME_CLAIM

• Typ: str
• Standard: name
• Beschreibung: Legt den Benutzernamen-Claim für OpenID fest.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

OAUTH_EMAIL_CLAIM

• Typ: str
• Standard: email
• Beschreibung: Legt den E-Mail-Claim für OpenID fest.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

OAUTH_PICTURE_CLAIM

• Typ: str
• Standard: picture
• Beschreibung: Legt den Bild- (Avatar-) Claim für OpenID fest.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

Info

Wenn OAUTH_PICTURE_CLAIM auf '' (leerer String) gesetzt ist, dann ist der OAuth-Bild-Claim deaktiviert und die Benutzerprofilbilder werden nicht gespeichert.

OAUTH_GROUP_CLAIM

• Typ: str
• Standard: groups
• Beschreibung: Legt den Gruppen-Claim für die OAuth-Authentifizierung fest.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

ENABLE_OAUTH_ROLE_MANAGEMENT

• Typ: bool
• Standard: False
• Beschreibung: Ermöglicht die Rollenverwaltung für die OAuth-Delegation.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

ENABLE_OAUTH_GROUP_MANAGEMENT

• Typ: bool
• Standard: False
• Beschreibung: Ermöglicht oder deaktiviert die OAuth-Gruppenverwaltung.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

OAUTH_ROLES_CLAIM

• Typ: str
• Standard: roles
• Beschreibung: Legt den Rollen-Claim fest, nach dem im OIDC-Token gesucht werden soll.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

OAUTH_ALLOWED_ROLES

• Typ: str
• Standard: user,admin
• Beschreibung: Legt die Rollen fest, die Zugriff auf die Plattform haben.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

OAUTH_ADMIN_ROLES

• Typ: str
• Standard: admin
• Beschreibung: Legt die Rollen fest, die als Administratoren gelten.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

OAUTH_ALLOWED_DOMAINS

• Typ: str
• Standard: *
• Beschreibung: Gibt die zulässigen Domänen für die OAuth-Authentifizierung an (z. B. "example1.com,example2.com").
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

LDAP

ENABLE_LDAP

• Typ: bool
• Standard: False
• Beschreibung: Ermöglicht oder deaktiviert die LDAP-Authentifizierung.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

LDAP_SERVER_LABEL

• Typ: str
• Beschreibung: Legt die Bezeichnung des LDAP-Servers fest.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

LDAP_SERVER_HOST

• Typ: str
• Standard: localhost
• Beschreibung: Legt den Hostnamen des LDAP-Servers fest.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

LDAP_SERVER_PORT

• Typ: int
• Standard: 389
• Beschreibung: Legt die Portnummer des LDAP-Servers fest.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

LDAP_ATTRIBUTE_FOR_MAIL

• Typ: str
• Beschreibung: Legt das Attribut fest, das als E-Mail für die LDAP-Authentifizierung verwendet werden soll.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

LDAP_ATTRIBUTE_FOR_USERNAME

• Typ: str
• Beschreibung: Legt das Attribut fest, das als Benutzername für die LDAP-Authentifizierung verwendet werden soll.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

LDAP_APP_DN

• Typ: str
• Beschreibung: Legt den Distinguished Name (DN) für die LDAP-Anwendung fest.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

LDAP_APP_PASSWORD

• Typ: str
• Beschreibung: Legt das Passwort für die LDAP-Anwendung fest.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

LDAP_SEARCH_BASE

• Typ: str
• Beschreibung: Legt die Basis für die Suche nach LDAP-Authentifizierung fest.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

LDAP_SEARCH_FILTER

• Typ: str
• Standard: None
• Beschreibung: Legt einen einzelnen Filter für die LDAP-Suche fest. Alternative zu LDAP_SEARCH_FILTERS.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

LDAP_SEARCH_FILTERS

• Typ: str
• Beschreibung: Legt den Filter für die LDAP-Suche fest.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

LDAP_USE_TLS

• Typ: bool
• Standard: True
• Beschreibung: Aktiviert oder deaktiviert TLS für die LDAP-Verbindung.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

LDAP_CA_CERT_FILE

• Typ: str
• Beschreibung: Legt den Pfad zur LDAP-CA-Zertifikatsdatei fest.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

LDAP_VALIDATE_CERT

• Typ: bool
• Beschreibung: Legt fest, ob das LDAP-CA-Zertifikat validiert werden soll.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

LDAP_CIPHERS

• Typ: str
• Standard: ALL
• Beschreibung: Legt die zu verwendenden Chiffren für die LDAP-Verbindung fest.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

ENABLE_LDAP_GROUP_MANAGEMENT

• Typ: bool
• Standard: False
• Beschreibung: Ermöglicht die Gruppenverwaltungsfunktion.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

ENABLE_LDAP_GROUP_CREATION

• Typ: bool
• Standard: False
• Beschreibung: Wenn eine Gruppe aus LDAP in Open WebUI nicht existiert, wird sie automatisch erstellt.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

LDAP_ATTRIBUTE_FOR_GROUPS

• Typ: str
• Standard: memberOf
• Beschreibung: Gibt das LDAP-Attribut an, das die Gruppenmitgliedschaften des Benutzers enthält. memberOf ist ein Standardattribut für diesen Zweck in Active Directory-Umgebungen.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

Benutzerberechtigungen

Chat-Berechtigungen

USER_PERMISSIONS_CHAT_CONTROLS

• Typ: bool
• Standard: True
• Beschreibung: Ermöglicht oder deaktiviert die Berechtigung des Benutzers für den Zugriff auf Chat-Steuerelemente.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

USER_PERMISSIONS_CHAT_FILE_UPLOAD

• Typ: bool
• Standard: True
• Beschreibung: Ermöglicht oder deaktiviert die Berechtigung des Benutzers, Dateien in Chats hochzuladen.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

USER_PERMISSIONS_CHAT_DELETE

• Typ: bool
• Standard: True
• Beschreibung: Ermöglicht oder deaktiviert die Berechtigung des Benutzers, Chats zu löschen.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

USER_PERMISSIONS_CHAT_EDIT

• Typ: bool
• Standard: True
• Beschreibung: Ermöglicht oder deaktiviert die Berechtigung des Benutzers, Chats zu bearbeiten.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

USER_PERMISSIONS_CHAT_STT

• Typ: bool
• Standard: True
• Beschreibung: Ermöglicht oder deaktiviert die Berechtigung des Benutzers, Sprache-zu-Text in Chats zu verwenden.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

USER_PERMISSIONS_CHAT_TTS

• Typ: bool
• Standard: True
• Beschreibung: Ermöglicht oder deaktiviert die Berechtigung des Benutzers, Text-zu-Sprache in Chats zu verwenden.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

USER_PERMISSIONS_CHAT_CALL

• Typ: str
• Standard: True
• Beschreibung: Ermöglicht oder deaktiviert die Berechtigung des Benutzers, Anrufe in Chats zu tätigen.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

USER_PERMISSIONS_CHAT_MULTIPLE_MODELS

• Typ: str
• Standard: True
• Beschreibung: Ermöglicht oder deaktiviert die Berechtigung des Benutzers, mehrere Modelle in Chats zu verwenden.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

USER_PERMISSIONS_CHAT_TEMPORARY

• Typ: bool
• Standard: True
• Beschreibung: Ermöglicht oder deaktiviert die Berechtigung des Benutzers, temporäre Chats zu erstellen.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

USER_PERMISSIONS_CHAT_TEMPORARY_ENFORCED

• Typ: str
• Standard: False
• Beschreibung: Erzwingt oder erlaubt Benutzern, temporäre Chats zu erstellen.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

USER_PERMISSIONS_CHAT_SYSTEM_PROMPT

• Typ: str
• Standard: True
• Beschreibung: Erlaubt oder verbietet Benutzern, eine benutzerdefinierte System-Eingabeaufforderung für alle ihre Chats festzulegen.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

Feature-Berechtigungen

USER_PERMISSIONS_FEATURES_DIRECT_TOOL_SERVERS

• Typ: str
• Standard: False
• Beschreibung: Ermöglicht oder deaktiviert die Berechtigung des Benutzers für den Zugriff auf direkte Werkzeugserver.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

USER_PERMISSIONS_FEATURES_WEB_SEARCH

• Typ: str
• Standard: True
• Beschreibung: Ermöglicht oder deaktiviert die Berechtigung des Benutzers, die Websuche-Funktion zu nutzen.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

USER_PERMISSIONS_FEATURES_IMAGE_GENERATION

• Typ: str
• Standard: True
• Beschreibung: Ermöglicht oder deaktiviert die Berechtigung des Benutzers, die Bildgenerierungsfunktion zu nutzen.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

USER_PERMISSIONS_FEATURES_CODE_INTERPRETER

• Typ: str
• Standard: True
• Beschreibung: Ermöglicht oder deaktiviert die Berechtigung des Benutzers, die Code-Interpreter-Funktion zu nutzen.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

Arbeitsbereich-Berechtigungen

USER_PERMISSIONS_WORKSPACE_MODELS_ACCESS

• Typ: bool
• Standard: False
• Beschreibung: Ermöglicht oder deaktiviert die Berechtigung des Benutzers für den Zugriff auf Arbeitsbereichsmodelle.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

USER_PERMISSIONS_WORKSPACE_KNOWLEDGE_ACCESS

• Typ: bool
• Standard: False
• Beschreibung: Ermöglicht oder deaktiviert die Berechtigung des Benutzers für den Zugriff auf Arbeitsbereichswissen.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

USER_PERMISSIONS_WORKSPACE_PROMPTS_ACCESS

• Typ: bool
• Standard: False
• Beschreibung: Ermöglicht oder deaktiviert die Berechtigung des Benutzers für den Zugriff auf Arbeitsbereich-Prompts.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

USER_PERMISSIONS_WORKSPACE_TOOLS_ACCESS

• Typ: bool
• Standard: False
• Beschreibung: Ermöglicht oder deaktiviert die Berechtigung des Benutzers für den Zugriff auf Arbeitsbereichswerkzeuge.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

USER_PERMISSIONS_WORKSPACE_MODELS_ALLOW_PUBLIC_SHARING

• Typ: str
• Standard: False
• Beschreibung: Ermöglicht oder deaktiviert die öffentliche Freigabe von Arbeitsbereichsmodellen.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

USER_PERMISSIONS_WORKSPACE_KNOWLEDGE_ALLOW_PUBLIC_SHARING

• Typ: str
• Standard: False
• Beschreibung: Ermöglicht oder deaktiviert die öffentliche Freigabe von Arbeitsbereichswissen.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

USER_PERMISSIONS_WORKSPACE_PROMPTS_ALLOW_PUBLIC_SHARING

• Typ: str
• Standard: False
• Beschreibung: Ermöglicht oder deaktiviert die öffentliche Freigabe von Arbeitsbereich-Prompts.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

USER_PERMISSIONS_WORKSPACE_TOOLS_ALLOW_PUBLIC_SHARING

• Typ: str
• Standard: False
• Beschreibung: Ermöglicht oder deaktiviert die öffentliche Freigabe von Arbeitsbereichswerkzeugen.
• Persistenz: Diese Umgebungsvariable ist eine PersistentConfig-Variable.

Verschiedene Umgebungsvariablen

Diese Variablen sind nicht spezifisch für Open WebUI, können aber in bestimmten Kontexten dennoch wertvoll sein.

Cloud-Speicher

STORAGE_PROVIDER

• Typ: str
• Optionen
  • s3 - verwendet die S3-Clientbibliothek und zugehörige Umgebungsvariablen, die unter Amazon S3 Storage erwähnt werden.
  • gcs - verwendet die GCS-Clientbibliothek und zugehörige Umgebungsvariablen, die unter Google Cloud Storage erwähnt werden.
  • azure - verwendet die Azure-Clientbibliothek und zugehörige Umgebungsvariablen, die unter Microsoft Azure Storage erwähnt werden.
• Standard: leerer String (' '), der zu local standardmäßig wird
• Beschreibung: Legt den Speicheranbieter fest.

Amazon S3 Speicher

S3_ACCESS_KEY_ID

• Typ: str
• Beschreibung: Legt die Zugriffs-Schlüssel-ID für S3-Speicher fest.

S3_ADDRESSING_STYLE

• Typ: str
• Standard: None
• Beschreibung: Legt den Adressierungsstil fest, der für S3-Speicher verwendet werden soll (z. B. 'path', 'virtual').

S3_BUCKET_NAME

• Typ: str
• Beschreibung: Legt den Bucket-Namen für S3-Speicher fest.

S3_ENDPOINT_URL

• Typ: str
• Beschreibung: Legt die Endpunkt-URL für S3-Speicher fest.

S3_KEY_PREFIX

• Typ: str
• Beschreibung: Legt das Schlüssel-Präfix für ein S3-Objekt fest.

S3_REGION_NAME

• Typ: str
• Beschreibung: Legt den Regionennamen für S3-Speicher fest.

S3_SECRET_ACCESS_KEY

• Typ: str
• Beschreibung: Legt den geheimen Zugriffs-Schlüssel für S3-Speicher fest.

S3_USE_ACCELERATE_ENDPOINT

• Typ: str
• Standard: False
• Beschreibung: Gibt an, ob der beschleunigte Endpunkt für S3-Speicher verwendet werden soll.

S3_ENABLE_TAGGING

• Typ: str
• Standard: False
• Beschreibung: Aktiviert das Tagging von S3-Objekten nach dem Hochladen für bessere Organisation, Suche und Integration mit Dateiverwaltungsrichtlinien. Setzen Sie dies immer auf False, wenn Sie Cloudflare R2 verwenden, da R2 das Tagging von Objekten nicht unterstützt.

Google Cloud Storage

GOOGLE_APPLICATION_CREDENTIALS_JSON

• Typ: str
• Beschreibung: Inhalt der Google Application Credentials JSON-Datei.
  • Optional – wenn nicht angegeben, werden die Anmeldedaten aus der Umgebung übernommen. Benutzeranmeldedaten, wenn lokal ausgeführt, und Google Metadata Server, wenn auf einer Google Compute Engine ausgeführt.
  • Eine Datei kann für ein Dienstkonto erstellt werden, indem Sie dieser Anleitung folgen.

GCS_BUCKET_NAME

• Typ: str
• Beschreibung: Legt den Bucket-Namen für Google Cloud Storage fest. Der Bucket muss bereits existieren.

Microsoft Azure Storage

AZURE_STORAGE_ENDPOINT

• Typ: str
• Beschreibung: Legt die Endpunkt-URL für Azure Storage fest.

AZURE_STORAGE_CONTAINER_NAME

• Typ: str
• Beschreibung: Legt den Container-Namen für Azure Storage fest.

AZURE_STORAGE_KEY

• Typ: str
• Beschreibung: Legt den Zugriffs-Schlüssel für Azure Storage fest.
  • Optional – wenn nicht angegeben, werden die Anmeldedaten aus der Umgebung übernommen. Benutzeranmeldedaten, wenn lokal ausgeführt, und Managed Identity, wenn in Azure-Diensten ausgeführt.

Datenbank-Pool

DATABASE_URL

• Typ: str
• Standard: sqlite:///${DATA_DIR}/webui.db
• Beschreibung: Gibt die Datenbank-URL für die Verbindung an.

Info

Unterstützt SQLite und Postgres. Das Ändern der URL migriert keine Daten zwischen Datenbanken. Dokumentation zum URL-Schema ist hier verfügbar.

Wenn Ihr Datenbankpasswort Sonderzeichen enthält, stellen Sie sicher, dass diese ordnungsgemäß URL-kodiert sind. Zum Beispiel sollte ein Passwort wie p@ssword als p%40ssword kodiert werden.

DATABASE_SCHEMA

• Typ: str
• Standard: None
• Beschreibung: Gibt das zu verbindende Datenbankschema an.

DATABASE_POOL_SIZE

• Typ: int
• Standard: None
• Beschreibung: Gibt die Pooling-Strategie und Größe des Datenbank-Pools an. Standardmäßig wählt SQLAlchemy automatisch die richtige Pooling-Strategie für die ausgewählte Datenbankverbindung aus. Ein Wert von 0 deaktiviert das Pooling. Ein Wert größer als 0 setzt die Pooling-Strategie auf QueuePool und die Poolgröße entsprechend.

DATABASE_POOL_MAX_OVERFLOW

• Typ: int
• Standard: 0
• Beschreibung: Gibt den maximalen Überlauf des Datenbank-Pools an.

Info

Weitere Informationen zu dieser Einstellung finden Sie hier.

DATABASE_POOL_TIMEOUT

• Typ: int
• Standard: 30
• Beschreibung: Gibt das Timeout des Datenbank-Pools in Sekunden an, um eine Verbindung zu erhalten.

Info

Weitere Informationen zu dieser Einstellung finden Sie hier.

DATABASE_POOL_RECYCLE

• Typ: int
• Standard: 3600
• Beschreibung: Gibt die Wiederverwendungszeit des Datenbank-Pools in Sekunden an.

Info

Weitere Informationen zu dieser Einstellung finden Sie hier.

Redis

REDIS_URL

• Typ: str
• Beispiel: redis://:6379/0
• Beispiel mit TLS: rediss://:6379/0
• Beschreibung: Gibt die URL der Redis-Instanz für den App-Status an.

Info

Wenn Sie Open WebUI in einem Multi-Node-/Worker-Cluster mit einem Load Balancer bereitstellen, müssen Sie sicherstellen, dass der Wert von REDIS_URL gesetzt ist. Ohne ihn treten Probleme mit Sitzungen, Persistenz und Konsistenz des App-Status auf, da die Worker nicht kommunizieren können.

REDIS_SENTINEL_HOSTS

• Typ: str
• Beschreibung: Kommagetrennte Liste von Redis Sentinels für den App-Status. Wenn angegeben, wird der "Hostname" in REDIS_URL als Sentinel-Servicename interpretiert.

REDIS_SENTINEL_PORT

• Typ: int
• Standard: 26379
• Beschreibung: Sentinel-Port für den App-Status-Redis.

REDIS_KEY_PREFIX

• Typ: str
• Standard: open-webui
• Beschreibung: Passt das Redis-Schlüsselpräfix an, das zum Speichern von Konfigurationswerten verwendet wird. Dies ermöglicht mehreren Open WebUI-Instanzen, dieselbe Redis-Instanz ohne Schlüsselkonflikte zu nutzen. Beim Betrieb im Redis-Cluster-Modus wird das Präfix als {präfix}: formatiert (z. B. {open-webui}:config:*), um Multi-Key-Operationen auf Konfigurationsschlüssel innerhalb desselben Hash-Slots zu ermöglichen.

ENABLE_WEBSOCKET_SUPPORT

• Typ: bool
• Standard: True
• Beschreibung: Ermöglicht die WebSocket-Unterstützung in Open WebUI.

Info

Wenn Sie Open WebUI in einem Multi-Node-/Worker-Cluster mit einem Load Balancer bereitstellen, müssen Sie sicherstellen, dass der Wert von ENABLE_WEBSOCKET_SUPPORT gesetzt ist. Ohne ihn treten Probleme mit WebSocket-Konsistenz und -Persistenz auf.

WEBSOCKET_MANAGER

• Typ: str
• Standard: redis
• Beschreibung: Gibt den zu verwendenden WebSocket-Manager an (in diesem Fall Redis).

Info

Wenn Sie Open WebUI in einem Multi-Node-/Worker-Cluster mit einem Load Balancer bereitstellen, müssen Sie sicherstellen, dass der Wert von WEBSOCKET_MANAGER gesetzt ist und eine Key-Value-NoSQL-Datenbank wie Redis verwendet wird. Ohne sie treten Probleme mit WebSocket-Konsistenz und -Persistenz auf.

WEBSOCKET_REDIS_URL

• Typ: str
• Standard: ${REDIS_URL}
• Beschreibung: Gibt die URL der Redis-Instanz für die WebSocket-Kommunikation an. Sie ist von REDIS_URL verschieden und in der Praxis wird empfohlen, beide zu setzen.

Info

Wenn Sie Open WebUI in einem Multi-Node-/Worker-Cluster mit einem Load Balancer bereitstellen, müssen Sie sicherstellen, dass der Wert von WEBSOCKET_REDIS_URL gesetzt ist und eine Key-Value-NoSQL-Datenbank wie Redis verwendet wird. Ohne sie treten Probleme mit WebSocket-Konsistenz und -Persistenz auf.

WEBSOCKET_SENTINEL_HOSTS

• Typ: str
• Beschreibung: Kommagetrennte Liste von Redis Sentinels für WebSockets. Wenn angegeben, wird der "Hostname" in WEBSOCKET_REDIS_URL als Sentinel-Servicename interpretiert.

WEBSOCKET_SENTINEL_PORT

• Typ: int
• Standard: 26379
• Beschreibung: Sentinel-Port für den WebSocket-Redis.

Uvicorn-Einstellungen

UVICORN_WORKERS

• Typ: int
• Standard: 1
• Beschreibung: Steuert die Anzahl der Worker-Prozesse, die Uvicorn zum Bearbeiten von Anfragen startet. Jeder Worker führt eine eigene Instanz der Anwendung in einem separaten Prozess aus.

Info

Bei der Bereitstellung in orchestrierten Umgebungen wie Kubernetes oder unter Verwendung von Helm-Charts wird empfohlen, UVICORN_WORKERS auf 1 zu belassen. Container-Orchestrierungsplattformen bieten bereits eigene Skalierungsmechanismen durch Pod-Replikation, und die Verwendung mehrerer Worker innerhalb von Containern kann zu Problemen bei der Ressourcenallokation und komplexen horizontalen Skalierungsstrategien führen.

Wenn Sie UVICORN_WORKERS verwenden, müssen Sie auch sicherstellen, dass verwandte Umgebungsvariablen für skalierbare Multi-Instanz-Setups entsprechend gesetzt sind.

Proxy-Einstellungen

Open WebUI unterstützt die Verwendung von Proxys für HTTP- und HTTPS-Abrufe. Um Proxy-Einstellungen anzugeben, verwendet Open WebUI die folgenden Umgebungsvariablen:

http_proxy

• Typ: str
• Beschreibung: Legt die URL für den HTTP-Proxy fest.

https_proxy

• Typ: str
• Beschreibung: Legt die URL für den HTTPS-Proxy fest.

no_proxy

• Typ: str
• Beschreibung: Listet Domänen-Erweiterungen (oder IP-Adressen) auf, für die der Proxy nicht verwendet werden soll, getrennt durch Kommas. Wenn Sie beispielsweise no_proxy auf '.mit.edu' setzen, wird sichergestellt, dass der Proxy beim Zugriff auf Dokumente von MIT umgangen wird.

Erforderliche Python-Pakete installieren

Open WebUI stellt Umgebungsvariablen zur Verfügung, um den Pip-Installationsprozess anzupassen. Nachfolgend finden Sie die von Open WebUI verwendeten Umgebungsvariablen zur Anpassung des Paketinstallationsverhaltens.

PIP_OPTIONS

• Typ: str
• Beschreibung: Gibt zusätzliche Befehlszeilenoptionen an, die pip bei der Installation von Paketen verwenden soll. Sie können beispielsweise Flags wie --upgrade, --user oder --no-cache-dir einschließen, um den Installationsprozess zu steuern.

PIP_PACKAGE_INDEX_OPTIONS

• Typ: str
• Beschreibung: Definiert benutzerdefiniertes Paketindexverhalten für pip. Dies kann die Angabe zusätzlicher oder alternativer Index-URLs (z. B. --extra-index-url), Authentifizierungsdaten oder anderer Parameter umfassen, um zu steuern, wie Pakete von verschiedenen Orten abgerufen werden.