Docs
Configuration
librechat.yaml
Object Structure
Config

Config Structure

Note: Fields not specifically mentioned as required are optional.

version

  • required
KeyTypeDescriptionExample
versionStringSpecifies the version of the configuration file.version: 1.0.8

cache

KeyTypeDescriptionExample
cacheBooleanToggles caching on or off. Set to `true` to enable caching (default).cache: true

fileStrategy

KeyTypeDescriptionExample
fileStrategyStringDetermines where to save user uploaded/generated files. Defaults to `"local"` if omitted.fileStrategy: "firebase"

filteredTools

KeyTypeDescriptionExample
filteredToolsArray of StringsFilters out specific tools from both Plugins and OpenAI Assistants endpoints.filteredTools: ["scholarai", "calculator"]
  • Notes:
    • If includedTools and filteredTools are both specified, only includedTools will be recognized.
    • Affects both gptPlugins and assistants endpoints
    • You can find the names of the tools to filter in api/app/clients/tools/manifest.json
      • Use the pluginKey value
    • Also, any listed under the “.well-known” directory api/app/clients/tools/.well-known
      • Use the name_for_model value

includedTools

KeyTypeDescriptionExample
includedToolsArray of StringsIncludes specific tools from both Plugins and OpenAI Assistants endpoints.includedTools: ["calculator"]
  • Notes:
    • If includedTools and filteredTools are both specified, only includedTools will be recognized.
    • Affects both gptPlugins and assistants endpoints
    • You can find the names of the tools to filter in api/app/clients/tools/manifest.json
      • Use the pluginKey value
    • Also, any listed under the “.well-known” directory api/app/clients/tools/.well-known
      • Use the name_for_model value

secureImageLinks

KeyTypeDescriptionExample
secureImageLinksBooleanWhether or not to secure access to image links that are hosted locally by the app. Default: false.secureImageLinks: true

imageOutputType

  • Note: Case-sensitive. Google endpoint only supports “jpeg” and “png” output types.
  • Options: “png” | “webp” | “jpeg”
KeyTypeDescriptionExample
imageOutputTypeStringThe image output type for image responses. Defaults to "png" if omitted.imageOutputType: "webp"

fileConfig

Key:

KeyTypeDescriptionExample
fileConfigObjectConfigures file handling settings for the application, including size limits and MIME type restrictions.

Subkeys:

KeyTypeDescriptionExample
endpointsRecord/ObjectSpecifies file handling configurations for individual endpoints, allowing customization per endpoint basis.
serverFileSizeLimitNumberThe maximum file size (in MB) that the server will accept. Applies globally across all endpoints unless overridden by endpoint-specific settings.
avatarSizeLimitNumberMaximum size (in MB) for user avatar images.

see: File Config Object Structure

rateLimits

Key:

KeyTypeDescriptionExample
rateLimitsObjectDefines rate limiting policies to prevent abuse by limiting the number of requests.

Subkeys:

KeyTypeDescriptionExample
fileUploadsObjectConfigures rate limits specifically for file upload operations.
conversationsImportObjectConfigures rate limits specifically for conversation import operations.

fileUploads Subkeys:

KeyTypeDescriptionExample
ipMaxNumberMaximum number of uploads allowed per IP address per window.
ipWindowInMinutesNumberTime window in minutes for the IP-based upload limit.
userMaxNumberMaximum number of uploads allowed per user per window.
userWindowInMinutesNumberTime window in minutes for the user-based upload limit.

conversationsImport Subkeys:

KeyTypeDescriptionExample
ipMaxNumberMaximum number of imports allowed per IP address per window.
ipWindowInMinutesNumberTime window in minutes for the IP-based imports limit.
userMaxNumberMaximum number of imports per user per window.
userWindowInMinutesNumberTime window in minutes for the user-based imports limit.
  • Example:
rateLimits
rateLimits:
  fileUploads:
    ipMax: 100
    ipWindowInMinutes: 60
    userMax: 50
    userWindowInMinutes: 60
  conversationsImport:
    ipMax: 100
    ipWindowInMinutes: 60
    userMax: 50
    userWindowInMinutes: 60

registration

Key:

KeyTypeDescriptionExample
registrationObjectConfigures registration-related settings for the application.

Subkeys:

KeyTypeDescriptionExample
socialLoginsSocial login configurations.
allowedDomainsSpecifies allowed domains for registration.

see also:

interface

Key:

KeyTypeDescriptionExample
interfaceObjectConfigures user interface elements within the application, allowing for customization of visibility and behavior of various components.

Subkeys:

KeyTypeDescriptionExample
privacyPolicyObjectContains settings related to the privacy policy link provided in the user interface.
termsOfServiceObjectContains settings related to the terms of service link provided in the user interface.
endpointsMenuBooleanControls the visibility of the endpoints dropdown menu in the interface.
modelSelectBooleanDetermines whether the model selection feature is available in the UI.
parametersBooleanToggles the visibility of parameter configuration options AKA conversation settings.
sidePanelBooleanControls the visibility of the right-most side panel in the application's interface.
presetsBooleanEnables or disables the presets menu in the application's UI.

see: Interface Object Structure

modelSpecs

Key:

KeyTypeDescriptionExample
modelSpecsObjectConfigures model specifications, allowing for detailed setup and customization of AI models and their behaviors within the application.

Subkeys:

KeyTypeDescriptionExample
enforceBooleanDetermines whether the model specifications should strictly override other configuration settings.
prioritizeBooleanSpecifies if model specifications should take priority over the default configuration when both are applicable.
listArray of ObjectsContains a list of individual model specifications detailing various configurations and behaviors.

see: Model Specs Object Structure

endpoints

Key:

KeyTypeDescriptionExample
endpointsObjectDefines custom API endpoints for the application.

Subkeys:

KeyTypeDescriptionExample
customArray of ObjectsEach object in the array represents a unique endpoint configuration.
azureOpenAIObjectAzure OpenAI endpoint-specific configuration
assistantsObjectAssistants endpoint-specific configuration.
azureAssistantsObjectAzure Assistants endpoint-specific configuration.

see: Full Custom Endpoint Object Structure see: Full Azure OpenAI Endpoint Object Structure see: Full Assistants Endpoint Object Structure