const path = require('path'); const { CacheKeys, configSchema, EImageOutputType } = require('librechat-data-provider'); const getLogStores = require('~/cache/getLogStores'); const loadYaml = require('~/utils/loadYaml'); const { logger } = require('~/config'); const axios = require('axios'); const yaml = require('js-yaml'); const projectRoot = path.resolve(__dirname, '..', '..', '..', '..'); const defaultConfigPath = path.resolve(projectRoot, 'librechat.yaml'); let i = 0; /** * Load custom configuration files and caches the object if the `cache` field at root is true. * Validation via parsing the config file with the config schema. * @function loadCustomConfig * @returns {Promise} A promise that resolves to null or the custom config object. * */ async function loadCustomConfig() { // Use CONFIG_PATH if set, otherwise fallback to defaultConfigPath const configPath = process.env.CONFIG_PATH || defaultConfigPath; let customConfig; if (/^https?:\/\//.test(configPath)) { try { const response = await axios.get(configPath); customConfig = response.data; } catch (error) { i === 0 && logger.error(`Failed to fetch the remote config file from ${configPath}`, error); i === 0 && i++; return null; } } else { customConfig = loadYaml(configPath); if (!customConfig) { i === 0 && logger.info( 'Custom config file missing or YAML format invalid.\n\nCheck out the latest config file guide for configurable options and features.\nhttps://www.librechat.ai/docs/configuration/librechat_yaml\n\n', ); i === 0 && i++; return null; } if (customConfig.reason || customConfig.stack) { i === 0 && logger.error('Config file YAML format is invalid:', customConfig); i === 0 && i++; return null; } } if (typeof customConfig === 'string') { try { customConfig = yaml.load(customConfig); } catch (parseError) { i === 0 && logger.info(`Failed to parse the YAML config from ${configPath}`, parseError); i === 0 && i++; return null; } } const result = configSchema.strict().safeParse(customConfig); if (result?.error?.errors?.some((err) => err?.path && err.path?.includes('imageOutputType'))) { throw new Error( ` Please specify a correct \`imageOutputType\` value (case-sensitive). The available options are: - ${EImageOutputType.JPEG} - ${EImageOutputType.PNG} - ${EImageOutputType.WEBP} Refer to the latest config file guide for more information: https://www.librechat.ai/docs/configuration/librechat_yaml`, ); } if (!result.success) { i === 0 && logger.error(`Invalid custom config file at ${configPath}`, result.error); i === 0 && i++; return null; } else { logger.info('Custom config file loaded:'); logger.info(JSON.stringify(customConfig, null, 2)); logger.debug('Custom config:', customConfig); } if (customConfig.cache) { const cache = getLogStores(CacheKeys.CONFIG_STORE); await cache.set(CacheKeys.CUSTOM_CONFIG, customConfig); } if (result.data.modelSpecs) { customConfig.modelSpecs = result.data.modelSpecs; } return customConfig; } module.exports = loadCustomConfig;