Struktur des Interface-Objekts

Übersicht

Das interface Objekt ermöglicht die Anpassung verschiedener Benutzeroberflächenelemente innerhalb der Anwendung, einschließlich Sichtbarkeits- und Verhaltenseinstellungen für Komponenten wie Menüs, Panels und Links. Dieser Abschnitt bietet eine detaillierte Aufschlüsselung der Struktur des interface Objekts.

Dies sind Felder unter interface:

• mcpServers
• privacyPolicy
• termsOfService
• modelSelect
• parameters
• contextUsage
• contextCost
• currency
• presets
• prompts
• bookmarks
• memories
• multiConvo
• agents
• remoteAgents
• skills
• sharedLinks
• temporaryChat
• temporaryChatRetention
• retentionMode
• retainAgentFiles
• autoSubmitFromUrl
• customWelcome
• runCode
• webSearch
• fileSearch
• fileCitations
• defaultPinnedTools
• peoplePicker
• marketplace

Hinweise:

• Die interface-Konfigurationen werden global innerhalb der Anwendung angewendet.
• Für die meisten Einstellungen sind Standardwerte vorgesehen, diese können jedoch basierend auf spezifischen Anforderungen oder Bedingungen überschrieben werden.
• Die bedingte Logik in der Anwendung kann diese Einstellungen basierend auf anderen Konfigurationen, wie z. B. Model Specs, weiter modifizieren.

Beispiel

interface:
  mcpServers:
    placeholder: 'MCP Servers'
    use: true
    create: true
    share: false
    public: false
    configureObo: false
    trustCheckbox:
      label: 'I trust this server'
      subLabel: 'Only enable servers you trust'
  privacyPolicy:
    externalUrl: 'https://example.com/privacy'
    openNewTab: true
  termsOfService:
    externalUrl: 'https://example.com/terms'
    openNewTab: true
    modalAcceptance: true
    modalTitle: 'Terms of Service'
    modalContent: |
      # Terms of Service
      ## Introduction
      Welcome to LibreChat!
  modelSelect: false
  parameters: true
  contextUsage: true
  contextCost: true
  currency:
    code: EUR
    rate: 0.92
  presets: false
  prompts:
    use: true
    create: true
    share: true
    public: false
  bookmarks: true
  multiConvo: true
  agents:
    use: true
    create: true
    share: true
    public: false
  skills:
    use: true
    create: true
    share: false
    public: false
    defaultActiveOnShare: false
  sharedLinks:
    create: true
    share: true
    public: false
    snapshotFiles: true
  customWelcome: 'Hey {{user.name}}! Welcome to LibreChat'
  runCode: true
  webSearch: true
  fileSearch: true
  fileCitations: true
  defaultPinnedTools:
    - artifacts
    - execute_code
    - mcp

mcpServers

Veraltet für die Berechtigungsverwaltung. Die Unter-Keys use, create, share und public initialisieren Rollenberechtigungen beim Start. Bevorzugen Sie das Admin Panel für die Verwaltung von MCP-Server-Berechtigungen pro Rolle/Gruppe/Benutzer. Die Unter-Keys placeholder und trustCheckbox sind davon nicht betroffen.

Schlüssel:

Untergeordnete Schlüssel:

trustCheckbox Unter-Keys:

Beispiel:

interface:
  mcpServers:
    placeholder: 'Select MCP Server'
    use: true
    create: true
    share: false
    configureObo: false
    trustCheckbox:
      label:
        en: 'I trust this server'
        es: 'Confío en este servidor'
      subLabel:
        en: 'Only enable servers you trust'
        es: 'Solo habilite servidores en los que confíe'

privacyPolicy

Schlüssel:

Untergeordnete Schlüssel:

termsOfService

Schlüssel:

Untergeordnete Schlüssel:

modelSelect

Schlüssel:

Standard: true

Hinweise:

• Dies muss auf true gesetzt werden, wenn modelSpecs.addedEndpoints verwendet wird.
• Wenn modelSpecs.addedEndpoints verwendet wird und interface.modelSelect nicht explizit gesetzt ist, wird standardmäßig true verwendet.

Beispiel:

interface:
  modelSelect: true

parameters

Schlüssel:

Standard: true

Beispiel:

interface:
  parameters: false

contextUsage

Schlüssel:

Standard: true

Beispiel:

interface:
  contextUsage: true

contextCost

Schlüssel:

Standard: false

Hinweise:

• Setzen Sie contextCost: true, um sich für sichtbare Kostenwerte zu entscheiden. Die Token-Nutzung kann über contextUsage weiterhin sichtbar bleiben, während die Kostenwerte ausgeblendet bleiben.
• currency wirkt sich nur auf die angezeigten Kosten aus, wenn die Kostenanzeige aktiviert ist.

Beispiel:

interface:
  contextCost: true

currency

Schlüssel:

Untergeordnete Schlüssel:

Beispiel:

interface:
  currency:
    code: EUR
    rate: 0.92

presets

Schlüssel:

Standard: true

Beispiel:

interface:
  presets: true

prompts

Veraltet für die Berechtigungsverwaltung. Initialisiert die PROMPTS-Rollenberechtigungen beim Start nur für die Standard-USER-Rolle. Verwenden Sie bevorzugt das Admin Panel, um Prompt-Berechtigungen pro Rolle/Gruppe/Benutzer zu verwalten.

Schlüssel:

Standard: true

Wichtig: Boolean vs. Objekt-Konfiguration

• Boolean (prompts: true): Aktualisiert nur die use-Berechtigung. Bestehende create-, share- und public-Berechtigungswerte werden aus der Datenbank beibehalten. Verwenden Sie dies als einfachen Funktionsschalter, ohne andere Einstellungen zu beeinflussen, die über das Admin-Panel konfiguriert wurden.

• Objekt: Aktualisiert nur die Unterberechtigungen, die explizit angegeben sind. Alle Berechtigungen, die nicht in der Konfiguration enthalten sind, werden aus der Datenbank beibehalten.

Bei Verwendung der Objektstruktur:

Untergeordnete Schlüssel:

Beispiel (boolean - einfacher Feature-Toggle):

interface:
  prompts: true # Only updates USE; create/share/public remain unchanged

Beispiel (Objekt - granulare Steuerung):

interface:
  prompts:
    use: true
    create: false # Disable creation while allowing use
    # share and public not specified - preserves existing values

Beispiel (Objekt - volle Kontrolle):

interface:
  prompts:
    use: true
    create: true
    share: true
    public: false

bookmarks

Veraltet für die Berechtigungsverwaltung. Initialisiert die BOOKMARKS-Rollenberechtigung beim Start nur für die Standard-USER-Rolle. Bevorzugen Sie das Admin Panel.

Schlüssel:

Standard: true

Beispiel:

interface:
  bookmarks: true

memories

Veraltet für die Berechtigungsverwaltung. Initialisiert die MEMORIES-Rollenberechtigungen beim Start nur für die Standard-USER-Rolle. Bevorzugen Sie das Admin Panel. Beachten Sie, dass dieser Schalter unabhängig von der Konfiguration des memory-Verhaltens ist.

Schlüssel:

Standard: true

Hinweis: Dies steuert die Sichtbarkeit der Memory-Funktion in der Benutzeroberfläche. Für eine detaillierte Konfiguration des Memory-Verhaltens (Token-Limits, Personalisierung, Agenten-Einstellungen), siehe Memory Configuration.

Beispiel:

interface:
  memories: true

multiConvo

Veraltet für die Berechtigungsverwaltung. Initialisiert die MULTI_CONVO Rollenberechtigung beim Start nur für die Standard-USER-Rolle. Bevorzugen Sie das Admin Panel.

Schlüssel:

Standard: true

Beispiel:

interface:
  multiConvo: true

agents

Weitere Informationen zu Agents

Veraltet für die Berechtigungsverwaltung. Initialisiert die AGENTS-Rollenberechtigungen beim Start nur für die Standard-USER-Rolle. Bevorzugen Sie das Admin Panel für die Verwaltung von Agentenberechtigungen pro Rolle/Gruppe/Benutzer.

Schlüssel:

Standard: true

Wichtig: Boolean vs. Objekt-Konfiguration

• Boolean (agents: true): Aktualisiert nur die use-Berechtigung. Bestehende create-, share- und public-Berechtigungswerte werden aus der Datenbank beibehalten. Verwenden Sie dies als einfachen Funktionsschalter, ohne andere Einstellungen zu beeinflussen, die über das Admin-Panel konfiguriert wurden.

• Objekt: Aktualisiert nur die Unterberechtigungen, die explizit angegeben sind. Alle Berechtigungen, die nicht in der Konfiguration enthalten sind, werden aus der Datenbank beibehalten.

Bei Verwendung der Objektstruktur:

Untergeordnete Schlüssel:

Beispiel (boolean - einfacher Feature-Toggle):

interface:
  agents: true # Only updates USE; create/share/public remain unchanged

Beispiel (Objekt - granulare Steuerung):

interface:
  agents:
    use: true
    create: false # Disable creation while allowing use
    # share and public not specified - preserves existing values

Beispiel (Objekt - volle Kontrolle):

interface:
  agents:
    use: true
    create: true
    share: true
    public: false

remoteAgents

Steuert den Zugriff auf die Agents API (OpenAI-kompatible und Open Responses API-Endpunkte), die es externen Anwendungen ermöglicht, programmgesteuert über API-Schlüssel mit LibreChat-Agents zu interagieren.

Veraltet für die Berechtigungsverwaltung. Initialisiert die REMOTE_AGENTS Rollenberechtigungen beim Start nur für die Standard-USER-Rolle. Bevorzugen Sie das Admin Panel.

Schlüssel:

Untergeordnete Schlüssel:

Standard: Alle Felder sind standardmäßig auf false (deaktiviert) gesetzt.

Beispiel:

interface:
  remoteAgents:
    use: true
    create: true
    share: false
    public: false

Hinweis: Admin-Benutzer haben standardmäßig alle Berechtigungen für Remote-Agents aktiviert, unabhängig von dieser Konfiguration.

skills

Veraltet für die Berechtigungsverwaltung. Initialisiert die SKILLS-Rollenberechtigungen beim Start nur für die Standard-USER-Rolle. Bevorzugen Sie das Admin Panel für die Verwaltung von Skills-Berechtigungen pro Rolle/Gruppe/Benutzer. defaultActiveOnShare ist kein Berechtigungs-Bit und bleibt eine YAML-Verhaltenseinstellung.

Schlüssel:

Standard: true für use und create, false für share, public und defaultActiveOnShare.

Untergeordnete Schlüssel:

Beispiel:

interface:
  skills:
    use: true
    create: true
    share: false
    public: false
    defaultActiveOnShare: false

Für das Verhalten von Skills und deren Aufrufmodi, siehe Skills.

sharedLinks

Veraltet für die Berechtigungsverwaltung. Initialisiert die SHARED_LINKS Rollenberechtigungen beim Start nur für die Standard-USER-Rolle. Bevorzugen Sie das Admin Panel für die Verwaltung von Berechtigungen für geteilte Links pro Rolle/Gruppe/Benutzer.

Schlüssel:

Standard: create: true, share: true, public: true

Wichtig: Boolean vs. Objekt-Konfiguration

• Boolean (sharedLinks: true): Aktiviert alle SHARED_LINKS-Berechtigungen für die Standard-USER-Rolle.
• Boolean (sharedLinks: false): Deaktiviert alle SHARED_LINKS-Berechtigungen für die Standard-USER-Rolle.
• Objekt: Aktualisiert nur die Unterberechtigungen, die explizit angegeben sind. Alle Berechtigungen, die nicht in der Konfiguration enthalten sind, werden aus der Datenbank beibehalten.

Untergeordnete Schlüssel:

Beispiel:

interface:
  sharedLinks:
    create: true
    share: true
    public: false
    snapshotFiles: true

Für das Verhalten von geteilten Links aus Benutzersicht, siehe Shareable Links.

temporaryChat

Steuert, ob die Funktion für temporäre Chats für Benutzer verfügbar ist. Temporäre Chats werden nicht im Konversationsverlauf gespeichert und nach einem konfigurierbaren Aufbewahrungszeitraum automatisch gelöscht.

Veraltet für die Berechtigungsverwaltung. Initialisiert die TEMPORARY_CHAT Rollenberechtigung beim Start nur für die Standard-USER-Rolle. Bevorzugen Sie das Admin Panel. temporaryChatRetention weiter unten ist keine Berechtigung und bleibt die empfohlene Methode zur Konfiguration der Aufbewahrungsdauer.

Schlüssel:

Standard: true

Hinweis: Der Aufbewahrungszeitraum für temporäre Chats kann über temporaryChatRetention konfiguriert werden.

Beispiel:

interface:
  temporaryChat: true

temporaryChatRetention

Die temporaryChatRetention-Konfiguration ermöglicht es Ihnen anzupassen, wie lange temporäre Chats gespeichert werden, bevor sie automatisch gelöscht werden.

Schlüssel:

Validierungsregeln:

• Minimum: 1 Stunde (verhindert sofortiges Löschen)
• Maximum: 8760 Stunden (maximal 1 Jahr Aufbewahrungsdauer)
• Standard: 720 Stunden (30 Tage)

Konfigurationsmethoden:

1. LibreChat.yaml (empfohlen): interface.temporaryChatRetention: 168
2. Umgebungsvariable (veraltet): TEMP_CHAT_RETENTION_HOURS=168

Hinweis: Die Umgebungsvariable TEMP_CHAT_RETENTION_HOURS ist veraltet. Bitte verwenden Sie stattdessen die Konfigurationsoption interface.temporaryChatRetention in librechat.yaml. Der Wert in der Konfigurationsdatei hat Vorrang vor der Umgebungsvariablen.

Beispiel:

interface:
  temporaryChatRetention: 168 # Retain temporary chats for 7 days
  retentionMode: 'temporary'

Gängige Aufbewahrungsfristen:

• 1 Stunde: temporaryChatRetention: 1 (minimale Aufbewahrungsdauer)
• 24 Stunden: temporaryChatRetention: 24 (1 Tag)
• 168 Stunden: temporaryChatRetention: 168 (1 Woche)
• 720 Stunden: temporaryChatRetention: 720 (30 Tage – Standard)
• 8760 Stunden: temporaryChatRetention: 8760 (1 Jahr - Maximum)

retentionMode

Steuert, welche Daten Aufbewahrungsfristen erhalten.

Schlüssel:

Standard: temporary

Beispiel:

interface:
  temporaryChatRetention: 168
  retentionMode: 'all'

retainAgentFiles

Steuert, ob persistente Agenten-Ressourcendateien von der Aufbewahrung aller Daten ausgenommen sind.

Schlüssel:

Standard: false

Hinweise:

• Diese Einstellung ändert das Verhalten nur, wenn retentionMode auf "all" gesetzt ist.
• Setzen Sie dies auf true, wenn Agents ihre persistenten Ressourcendateien behalten sollen, auch wenn für Konversationen, Nachrichten und Nicht-Agent-Dateien Aufbewahrungsfristen gelten.

Beispiel:

interface:
  temporaryChatRetention: 168
  retentionMode: 'all'
  retainAgentFiles: true

autoSubmitFromUrl

Steuert, ob ein über URL-Abfrageparameter auf /c/new bereitgestellter Prompt automatisch an das Modell übermittelt wird.

Wenn /c/new?prompt=…&submit=true von einem authentifizierten Benutzer geöffnet wird, füllt LibreChat normalerweise das Eingabefeld mit dem über die URL bereitgestellten Prompt vor und sendet diesen sofort ab. Dies ist eine Komfortfunktion für erstellte Deeplinks und geteilte Chat-URLs.

Für Bereitstellungen, bei denen Benutzer manipulierte Links aus externen Quellen erhalten könnten – und bei denen Modelle mit Speicher- oder Tool-Unterstützung sensible Kontextinformationen preisgeben könnten, falls ein Prompt-Injection-Payload das Modell erreicht –, können Betreiber die automatische Übermittlung deaktivieren. Wenn das Flag auf false gesetzt ist, wird der Prompt zwar weiterhin im Composer vorausgefüllt, der Benutzer muss jedoch explizit auf Senden klicken.

Schlüssel:

Standard: true (das bestehende Verhalten bleibt erhalten, sofern es nicht explizit deaktiviert wird).

Hinweise:

• Diese Einstellung hat keine Auswirkungen auf die URL-gesteuerte Auswahl von Model Specs oder andere URL-gesteuerte Einstellungen – nur auf den automatischen Übermittlungsschritt.
• Der Abfrageparameter akzeptiert sowohl prompt als auch q als Prompt-Quelle, wobei prompt Vorrang hat. submit=true ist der Auslöser.
• Empfohlen für Instanzen, die sensible Speicher- oder Tool-Daten verarbeiten, bei denen ein 1-Klick-Prompt-Injection-Vektor eine explizite Benutzerbestätigung erfordern sollte.

Beispiel:

interface:
  autoSubmitFromUrl: false

customWelcome

Schlüssel:

Standard: Keine (falls nicht angegeben, wird eine Standardbegrüßung verwendet)

Beispiel:

interface:
  customWelcome: 'Hey {{user.name}}! Welcome to LibreChat'

Hinweis: Sie können {{user.name}} innerhalb der customWelcome-Nachricht verwenden, um den Namen des Benutzers dynamisch für eine personalisierte Begrüßung einzufügen.

runCode

Aktiviert/deaktiviert die Schaltfläche „Code ausführen“ für Markdown-Codeblöcke. Weitere Informationen zur LibreChat Code Interpreter API

Hinweis: Diese Einstellung deaktiviert nicht die Agents Code Interpreter Capability. Um die Agents-Funktion zu deaktivieren, siehe stattdessen die Agents Endpoint-Konfiguration.

Veraltet für die Berechtigungsverwaltung. Initialisiert die RUN_CODE Rollenberechtigung beim Start nur für die Standard-USER-Rolle. Bevorzugen Sie das Admin Panel.

Schlüssel:

Standard: true

Beispiel:

interface:
  runCode: true

webSearch

Aktiviert/deaktiviert die Websuch-Schaltfläche in der Chat-Oberfläche. Weitere Informationen finden Sie unter Web Search Configuration

Hinweis: Diese Einstellung deaktiviert nicht die Agents Web Search Capability. Um die Agents-Funktion zu deaktivieren, siehe stattdessen die Agents Endpoint configuration.

Veraltet für die Berechtigungsverwaltung. Initialisiert die WEB_SEARCH Rollenberechtigung beim Start nur für die Standard-USER-Rolle. Bevorzugen Sie das Admin Panel.

Schlüssel:

Standard: true

Beispiel:

interface:
  webSearch: true

fileSearch

Aktiviert/deaktiviert die Schaltfläche für die Dateisuche (für die RAG-API-Nutzung via Tool) in der Chat-Oberfläche

Hinweis: Diese Einstellung deaktiviert nicht die Agents File Search Capability. Um die Agents-Funktionalität zu deaktivieren, siehe stattdessen die Agents Endpoint-Konfiguration.

Veraltet für die Berechtigungsverwaltung. Initialisiert die FILE_SEARCH Rollenberechtigung beim Start nur für die Standard-USER-Rolle. Bevorzugen Sie das Admin Panel.

Schlüssel:

Standard: true

Beispiel:

interface:
  fileSearch: true

fileCitations

Steuert die globale Verfügbarkeit der Dateizitat-Funktionalität. Wenn diese deaktiviert ist, wird die FILE_CITATIONS-Berechtigung für alle Benutzer effektiv entfernt, wodurch verhindert wird, dass Dateizitate bei der Verwendung der Dateisuche angezeigt werden, unabhängig von individuellen Benutzerberechtigungen.

Veraltet für die Berechtigungsverwaltung. Legt beim Start die FILE_CITATIONS Rollenberechtigung global fest (Seeds/Globally Gates). Bevorzugen Sie das Admin Panel für die Verwaltung von Zitatberechtigungen pro Rolle/Gruppe/Benutzer.

Hinweis:

• Diese Einstellung fungiert als globaler Schalter für das FILE_CITATIONS-Berechtigungssystem im gesamten System.
• Wenn dies auf false gesetzt ist, sehen keine Benutzer Dateizitate, selbst wenn ihnen die Berechtigung durch Rollen erteilt wurde.
• Für Dateizitate muss die Funktion fileSearch aktiviert sein.
• Wenn Sie Agenten mit Dateisuchfunktion verwenden, kann das Zitierverhalten (Quantität und Qualität) über die Agents endpoint configuration konfiguriert werden.

Schlüssel:

Standard: true

Beispiel:

interface:
  fileCitations: true

defaultPinnedTools

Legt die anfänglichen angehefteten Tools in der Prompt-Leiste für Benutzer fest, die ihren Status für angeheftete Tools noch nicht angepasst haben. Sobald ein Benutzer ein Tool anheftet oder löst, speichert LibreChat die Wahl dieses Benutzers.

Schlüssel:

Unterstützte Werte:

• Integrierte Tool-Schlüssel: artifacts, execute_code, web_search, file_search, skills
• mcp, um das Dropdown-Menü der MCP-Server anzuheften
• Ein spezifischer MCP Server-Name, um diesen Server als angepinnt zu markieren

Beispiel:

interface:
  defaultPinnedTools:
    - artifacts
    - execute_code
    - mcp

peoplePicker

Steuert, welche Prinzipaltypen (Benutzer, Gruppen, Rollen) in der Personenauswahl-Schnittstelle zur Auswahl stehen; dies wird typischerweise beim Teilen von Agents oder bei der Verwaltung von Zugriffskontrollen verwendet.

Veraltet für die Berechtigungsverwaltung. Initialisiert die PEOPLE_PICKER-Rollenberechtigungen beim Start nur für die Standard-USER-Rolle. Bevorzugen Sie das Admin Panel.

Schlüssel:

Untergeordnete Schlüssel:

Standard:

peoplePicker:
  users: true
  groups: true
  roles: true

Beispiel:

interface:
  peoplePicker:
    users: true
    groups: true
    roles: false # Disable role selection in people picker

marketplace

Aktiviert/deaktiviert den Zugriff auf den Agent Marketplace.

Veraltet für die Berechtigungsverwaltung. Initialisiert die MARKETPLACE Rollenberechtigung beim Start nur für die Standard-USER-Rolle. Bevorzugen Sie das Admin Panel.

Schlüssel:

Untergeordnete Schlüssel:

Standard:

marketplace:
  use: false

Beispiel:

interface:
  marketplace:
    use: true # Enable marketplace access