Structuur van het interface-object

Overzicht

Het interface object maakt aanpassing van verschillende gebruikersinterface-elementen binnen de applicatie mogelijk, inclusief instellingen voor zichtbaarheid en gedrag van componenten zoals menu's, panelen en links. Dit gedeelte biedt een gedetailleerd overzicht van de structuur van het interface object.

Dit zijn velden onder 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

Opmerkingen:

• De interface configuraties worden globaal toegepast binnen de applicatie.
• Standaardwaarden worden voor de meeste instellingen verstrekt, maar kunnen worden overschreven op basis van specifieke vereisten of voorwaarden.
• Voorwaardelijke logica in de applicatie kan deze instellingen verder aanpassen op basis van andere configuraties, zoals Model Specs.

Voorbeeld

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

Afgekeurd voor rechtenbeheer. De sub-keys use, create, share en public initialiseren rolrechten bij het opstarten. Gebruik bij voorkeur het Admin Panel voor het beheren van MCP server-rechten per rol/groep/gebruiker. De sub-keys placeholder en trustCheckbox blijven ongewijzigd.

Sleutel:

Sub-keys:

trustCheckbox sub-keys:

Voorbeeld:

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

Sleutel:

Sub-keys:

termsOfService

Sleutel:

Sub-keys:

modelSelect

Sleutel:

Standaard: true

Opmerkingen:

• Dit moet true zijn als je modelSpecs.addedEndpoints gebruikt.
• Als modelSpecs.addedEndpoints wordt gebruikt en interface.modelSelect niet expliciet is ingesteld, is de standaardwaarde true.

Voorbeeld:

interface:
  modelSelect: true

parameters

Sleutel:

Standaard: true

Voorbeeld:

interface:
  parameters: false

contextUsage

Sleutel:

Standaard: true

Voorbeeld:

interface:
  contextUsage: true

contextCost

Sleutel:

Standaard: false

Opmerkingen:

• Stel contextCost: true in om je aan te melden voor zichtbare kostenwaarden. Tokengebruik kan zichtbaar blijven via contextUsage terwijl kostenwaarden verborgen blijven.
• currency heeft alleen invloed op de weergegeven kosten wanneer kostenweergave is ingeschakeld.

Voorbeeld:

interface:
  contextCost: true

currency

Sleutel:

Sub-keys:

Voorbeeld:

interface:
  currency:
    code: EUR
    rate: 0.92

presets

Sleutel:

Standaard: true

Voorbeeld:

interface:
  presets: true

prompts

Afgekeurd voor rechtenbeheer. Initialiseert de PROMPTS rolrechten bij het opstarten alleen voor de standaard USER rol. Gebruik bij voorkeur het Admin Panel voor het beheren van promptrechten per rol/groep/gebruiker.

Sleutel:

Standaard: true

Belangrijk: Boolean versus Object Configuratie

• Boolean (prompts: true): Werkt alleen de use toestemming bij. Bestaande create, share en public toestemmingswaarden worden behouden vanuit de database. Gebruik dit als een eenvoudige feature-schakelaar zonder andere instellingen te beïnvloeden die via het beheerderspaneel zijn geconfigureerd.

• Object: Werkt alleen de sub-rechten bij die expliciet zijn opgegeven. Alle rechten die niet in de config zijn opgenomen, blijven behouden zoals ze in de database staan.

Bij gebruik van de objectstructuur:

Sub-keys:

Voorbeeld (boolean - eenvoudige feature toggle):

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

Voorbeeld (object - gedetailleerde controle):

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

Voorbeeld (object - volledige controle):

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

bookmarks

Afgekeurd voor rechtenbeheer. Voegt bij het opstarten de BOOKMARKS roltoestemming toe voor alleen de standaard USER rol. Gebruik bij voorkeur het Admin Panel.

Sleutel:

Standaard: true

Voorbeeld:

interface:
  bookmarks: true

memories

Afgekeurd voor rechtenbeheer. Initialiseert de MEMORIES rolrechten bij het opstarten voor alleen de standaard USER rol. Gebruik bij voorkeur het Admin Panel. Let op: deze schakelaar staat los van de memory gedragsconfiguratie.

Sleutel:

Standaard: true

Let op: Dit bepaalt de zichtbaarheid van de geheugenfunctie in de UI. Voor gedetailleerde configuratie van het geheugengedrag (tokenlimieten, personalisatie, agentinstellingen), zie de Memory Configuration.

Voorbeeld:

interface:
  memories: true

multiConvo

Afgekeurd voor rechtenbeheer. Voegt de MULTI_CONVO rolrechten toe bij het opstarten, uitsluitend voor de standaard USER rol. Gebruik bij voorkeur het Admin Panel.

Sleutel:

Standaard: true

Voorbeeld:

interface:
  multiConvo: true

agents

Meer info over Agents

Afgekeurd voor rechtenbeheer. Initialiseert de AGENTS rolrechten bij het opstarten alleen voor de standaard USER rol. Gebruik bij voorkeur het Admin Panel voor het beheren van agent-rechten per rol/groep/gebruiker.

Sleutel:

Standaard: true

Belangrijk: Boolean versus Object Configuratie

• Boolean (agents: true): Werkt alleen de use permissie bij. Bestaande create, share en public permissiewaarden worden behouden vanuit de database. Gebruik dit als een eenvoudige functie-schakelaar zonder andere instellingen die via het admin-paneel zijn geconfigureerd te beïnvloeden.

• Object: Werkt alleen de sub-rechten bij die expliciet zijn opgegeven. Alle rechten die niet in de config zijn opgenomen, blijven behouden zoals ze in de database staan.

Bij gebruik van de objectstructuur:

Sub-keys:

Voorbeeld (boolean - eenvoudige feature toggle):

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

Voorbeeld (object - gedetailleerde controle):

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

Voorbeeld (object - volledige controle):

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

remoteAgents

Beheert de toegang tot de Agents API (OpenAI-compatibele en Open Responses API-endpoints), waarmee externe applicaties programmatisch via API-sleutels met LibreChat-agents kunnen communiceren.

Afgekeurd voor rechtenbeheer. Initialiseert de REMOTE_AGENTS rolrechten bij het opstarten, uitsluitend voor de standaard USER rol. Gebruik bij voorkeur het Admin Panel.

Sleutel:

Sub-keys:

Standaard: Alle velden staan standaard op false (uitgeschakeld).

Voorbeeld:

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

Let op: Beheerders (admin users) hebben standaard alle externe agent-rechten ingeschakeld, ongeacht deze configuratie.

skills

Afgekeurd voor rechtenbeheer. Initialiseert de SKILLS rolrechten bij het opstarten alleen voor de standaard USER rol. Gebruik bij voorkeur het Admin Panel voor het beheren van Skills-rechten per rol/groep/gebruiker. defaultActiveOnShare is geen rechtenbit en blijft een YAML-gedragsinstelling.

Sleutel:

Standaard: true voor use en create, false voor share, public en defaultActiveOnShare.

Sub-keys:

Voorbeeld:

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

Voor Skills-gedrag en aanroepmodi, zie Skills.

sharedLinks

Afgekeurd voor rechtenbeheer. Initialiseert de SHARED_LINKS rolrechten bij het opstarten alleen voor de standaard USER rol. Gebruik bij voorkeur het Admin Panel voor het beheren van rechten voor gedeelde links per rol/groep/gebruiker.

Sleutel:

Standaard: create: true, share: true, public: true

Belangrijk: Boolean versus Object Configuratie

• Boolean (sharedLinks: true): Schakelt alle SHARED_LINKS rechten in voor de standaard USER rol.
• Boolean (sharedLinks: false): Schakelt alle SHARED_LINKS permissies uit voor de standaard USER rol.
• Object: Werkt alleen de sub-rechten bij die expliciet zijn opgegeven. Alle rechten die niet in de config zijn opgenomen, blijven behouden zoals ze in de database staan.

Sub-keys:

Voorbeeld:

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

Voor het gedrag van gedeelde links voor gebruikers, zie Shareable Links.

temporaryChat

Bepaalt of de tijdelijke chatfunctie beschikbaar is voor gebruikers. Tijdelijke chats worden niet opgeslagen in de gespreksgeschiedenis en worden automatisch verwijderd na een configureerbare bewaarperiode.

Afgekeurd voor rechtenbeheer. Voegt de TEMPORARY_CHAT rolrechten toe bij het opstarten, uitsluitend voor de standaard USER rol. Gebruik bij voorkeur het Admin Panel. temporaryChatRetention hieronder is geen recht en blijft de aanbevolen manier om retentie te configureren.

Sleutel:

Standaard: true

Let op: De bewaartermijn voor tijdelijke chats kan worden geconfigureerd met temporaryChatRetention.

Voorbeeld:

interface:
  temporaryChat: true

temporaryChatRetention

Met de temporaryChatRetention configuratie kun je aanpassen hoe lang tijdelijke chats worden bewaard voordat ze automatisch worden verwijderd.

Sleutel:

Validatieregels:

• Minimum: 1 uur (voorkomt onmiddellijke verwijdering)
• Maximum: 8760 uur (maximaal 1 jaar retentie)
• Standaard: 720 uur (30 dagen)

Configuratiemethoden:

1. LibreChat.yaml (aanbevolen): interface.temporaryChatRetention: 168
2. Omgevingsvariabele (verouderd): TEMP_CHAT_RETENTION_HOURS=168

Let op: De omgevingsvariabele TEMP_CHAT_RETENTION_HOURS is verouderd. Gebruik in plaats daarvan de configuratieoptie interface.temporaryChatRetention in librechat.yaml. De waarde in het configuratiebestand heeft voorrang op de omgevingsvariabele.

Voorbeeld:

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

Veelvoorkomende bewaartermijnen:

• 1 uur: temporaryChatRetention: 1 (minimale retentie)
• 24 uur: temporaryChatRetention: 24 (1 dag)
• 168 uur: temporaryChatRetention: 168 (1 week)
• 720 uur: temporaryChatRetention: 720 (30 dagen - standaard)
• 8760 uur: temporaryChatRetention: 8760 (1 jaar - maximum)

retentionMode

Bepaalt voor welke gegevens bewaartermijnen gelden.

Sleutel:

Standaard: temporary

Voorbeeld:

interface:
  temporaryChatRetention: 168
  retentionMode: 'all'

retainAgentFiles

Bepaalt of persistente agent-resourcebestanden zijn vrijgesteld van retentie van alle gegevens.

Sleutel:

Standaard: false

Opmerkingen:

• Deze instelling wijzigt het gedrag alleen wanneer retentionMode is ingesteld op "all".
• Stel dit in op true wanneer agents hun persistente bronbestanden moeten behouden, zelfs wanneer gesprekken, berichten en niet-agentbestanden retentietermijnen ontvangen.

Voorbeeld:

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

autoSubmitFromUrl

Bepaalt of een prompt die via URL-queryparameters op /c/new wordt meegegeven, automatisch naar het model wordt verzonden.

Wanneer /c/new?prompt=…&submit=true wordt geopend door een geauthenticeerde gebruiker, vult LibreChat normaal gesproken de composer vooraf in met de via de URL meegegeven prompt en verstuurt deze onmiddellijk. Dit is een gemakfunctie voor speciaal gemaakte deeplinks en gedeelde chat-URL's.

Voor implementaties waarbij gebruikers mogelijk geprepareerde links van externe bronnen ontvangen — en waarbij modellen met geheugen- of tool-ondersteuning gevoelige context zouden kunnen lekken als een prompt-injection payload het model bereikt — kunnen beheerders automatische verzending uitschakelen. Wanneer de vlag op false is ingesteld, wordt de prompt nog steeds vooraf ingevuld in het invoerveld, maar moet de gebruiker expliciet op Verzenden drukken.

Sleutel:

Standaard: true (bestaand gedrag blijft behouden tenzij expliciet uitgeschakeld).

Opmerkingen:

• Deze instelling heeft geen invloed op de selectie van Model Specs via URL of andere URL-gestuurde instellingen — alleen op de stap voor automatische verzending.
• De queryparameter accepteert zowel prompt als q als bron voor de prompt, waarbij prompt voorrang heeft. submit=true is de trigger.
• Aanbevolen voor instanties die gevoelige geheugen- of toolgegevens verwerken, waarbij een prompt-injection vector met één klik expliciete bevestiging van de gebruiker moet vereisen.

Voorbeeld:

interface:
  autoSubmitFromUrl: false

customWelcome

Sleutel:

Standaard: Geen (indien niet gespecificeerd, wordt een standaard begroeting gebruikt)

Voorbeeld:

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

Let op: Je kunt {{user.name}} gebruiken binnen het customWelcome bericht om dynamisch de naam van de gebruiker in te voegen voor een gepersonaliseerde begroeting.

runCode

Schakelt de "Code uitvoeren"-knop voor Markdown-codeblokken in of uit. Meer informatie over de LibreChat Code Interpreter API

Let op: Deze instelling schakelt de Agents Code Interpreter Capability niet uit. Om de Agents Capability uit te schakelen, zie in plaats daarvan de Agents Endpoint configuration.

Afgekeurd voor rechtenbeheer. Voegt bij het opstarten de RUN_CODE rolrechten toe aan de standaard USER rol. Gebruik bij voorkeur het Admin Panel.

Sleutel:

Standaard: true

Voorbeeld:

interface:
  runCode: true

webSearch

Schakelt de webzoekknop in de chatinterface in/uit. Meer informatie over Web Search Configuration

Let op: Deze instelling schakelt de Agents Web Search Capability niet uit. Om de Agents-functionaliteit uit te schakelen, raadpleeg in plaats daarvan de Agents Endpoint-configuratie.

Afgekeurd voor rechtenbeheer. Voegt de WEB_SEARCH roltoestemming toe bij het opstarten, uitsluitend voor de standaard USER rol. Gebruik bij voorkeur het Admin Panel.

Sleutel:

Standaard: true

Voorbeeld:

interface:
  webSearch: true

fileSearch

Schakelt de knop voor bestandszoekopdrachten (voor RAG API-gebruik via tool) in de chatinterface in/uit

Let op: Deze instelling schakelt de Agents File Search Capability niet uit. Om de Agents Capability uit te schakelen, zie in plaats daarvan de Agents Endpoint configuration.

Afgekeurd voor rechtenbeheer. Voegt de FILE_SEARCH roltoestemming toe bij het opstarten, uitsluitend voor de standaard USER rol. Gebruik bij voorkeur het Admin Panel.

Sleutel:

Standaard: true

Voorbeeld:

interface:
  fileSearch: true

fileCitations

Beheert de globale beschikbaarheid van de functionaliteit voor bestandscitaties. Wanneer uitgeschakeld, verwijdert dit effectief de FILE_CITATIONS permissie voor alle gebruikers, waardoor wordt voorkomen dat bestandscitaties worden weergegeven bij het gebruik van bestandzoekopdrachten, ongeacht individuele gebruikerspermissies.

Afgekeurd voor rechtenbeheer. Seed/stelt de FILE_CITATIONS rolrechten globaal in bij het opstarten. Gebruik bij voorkeur het Admin Panel voor het beheren van citatierechten per rol/groep/gebruiker.

Let op:

• Deze instelling fungeert als een globale schakelaar voor het FILE_CITATIONS permissiesysteem op systeemniveau.
• Wanneer dit is ingesteld op false, zullen geen gebruikers bestandscitaties zien, zelfs niet als ze de toestemming via rollen hebben gekregen.
• Bestandscitaties vereisen dat de fileSearch functie is ingeschakeld.
• Bij het gebruik van agents met bestandzoekfunctionaliteit kan het citatiegedrag (kwantiteit en kwaliteit) worden geconfigureerd via de Agents endpoint configuration.

Sleutel:

Standaard: true

Voorbeeld:

interface:
  fileCitations: true

defaultPinnedTools

Seed de initiële vastgepinde tools in de prompt-balk voor gebruikers die hun vastgepinde tool-status nog niet hebben aangepast. Zodra een gebruiker een tool vastpint of lospint, behoudt LibreChat de keuze van die gebruiker.

Sleutel:

Ondersteunde waarden:

• Ingebouwde tool-sleutels: artifacts, execute_code, web_search, file_search, skills
• mcp om de MCP servers-dropdown vast te pinnen
• Een specifieke MCP servernaam om die server als vastgepind te markeren

Voorbeeld:

interface:
  defaultPinnedTools:
    - artifacts
    - execute_code
    - mcp

peoplePicker

Bepaalt welke principal-types (gebruikers, groepen, rollen) beschikbaar zijn voor selectie in de interface van de personenkiezer, meestal gebruikt bij het delen van agents of het beheren van toegangscontroles.

Afgekeurd voor rechtenbeheer. Initialiseert de PEOPLE_PICKER rolrechten bij het opstarten alleen voor de standaard USER rol. Gebruik bij voorkeur het Admin Panel.

Sleutel:

Sub-keys:

Standaard:

peoplePicker:
  users: true
  groups: true
  roles: true

Voorbeeld:

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

marketplace

Schakelt toegang tot de Agent Marketplace in/uit.

Afgekeurd voor rechtenbeheer. Voegt de MARKETPLACE rolrechten toe bij het opstarten, uitsluitend voor de standaard USER rol. Gebruik bij voorkeur het Admin Panel.

Sleutel:

Sub-keys:

Standaard:

marketplace:
  use: false

Voorbeeld:

interface:
  marketplace:
    use: true # Enable marketplace access