mirror of
https://github.com/danny-avila/LibreChat.git
synced 2025-09-21 21:50:49 +02:00

* feat: add SAML authentication * refactor: change SAML icon * refactor: resolve SAML metadata paths using paths.js * test: add samlStrategy tests * fix: update setupSaml import * test: add SAML settings tests in config.spec.js * test: add client tests * refactor: improve SAML button label and fallback localization * feat: allow only one authentication method OpenID or SAML at a time * doc: add SAML configuration sample to docker-compose.override * fix: require SAML_SESSION_SECRET to enable SAML * feat: update samlStrategy * test: update samle tests * feat: add SAML login button label to translations and remove default value * fix: update SAML cert file binding * chore: update override example with SAML cert volume * fix: update SAML session handling with Redis backend --------- Co-authored-by: Ruben Talstra <RubenTalstra1211@outlook.com>
136 lines
5.1 KiB
JavaScript
136 lines
5.1 KiB
JavaScript
const express = require('express');
|
|
const { CacheKeys, defaultSocialLogins, Constants } = require('librechat-data-provider');
|
|
const { getLdapConfig } = require('~/server/services/Config/ldap');
|
|
const { getProjectByName } = require('~/models/Project');
|
|
const { isEnabled } = require('~/server/utils');
|
|
const { getLogStores } = require('~/cache');
|
|
const { logger } = require('~/config');
|
|
|
|
const router = express.Router();
|
|
const emailLoginEnabled =
|
|
process.env.ALLOW_EMAIL_LOGIN === undefined || isEnabled(process.env.ALLOW_EMAIL_LOGIN);
|
|
const passwordResetEnabled = isEnabled(process.env.ALLOW_PASSWORD_RESET);
|
|
|
|
const sharedLinksEnabled =
|
|
process.env.ALLOW_SHARED_LINKS === undefined || isEnabled(process.env.ALLOW_SHARED_LINKS);
|
|
|
|
const publicSharedLinksEnabled =
|
|
sharedLinksEnabled &&
|
|
(process.env.ALLOW_SHARED_LINKS_PUBLIC === undefined ||
|
|
isEnabled(process.env.ALLOW_SHARED_LINKS_PUBLIC));
|
|
|
|
router.get('/', async function (req, res) {
|
|
const cache = getLogStores(CacheKeys.CONFIG_STORE);
|
|
const cachedStartupConfig = await cache.get(CacheKeys.STARTUP_CONFIG);
|
|
if (cachedStartupConfig) {
|
|
res.send(cachedStartupConfig);
|
|
return;
|
|
}
|
|
|
|
const isBirthday = () => {
|
|
const today = new Date();
|
|
return today.getMonth() === 1 && today.getDate() === 11;
|
|
};
|
|
|
|
const instanceProject = await getProjectByName(Constants.GLOBAL_PROJECT_NAME, '_id');
|
|
|
|
const ldap = getLdapConfig();
|
|
|
|
try {
|
|
const isOpenIdEnabled =
|
|
!!process.env.OPENID_CLIENT_ID &&
|
|
!!process.env.OPENID_CLIENT_SECRET &&
|
|
!!process.env.OPENID_ISSUER &&
|
|
!!process.env.OPENID_SESSION_SECRET;
|
|
|
|
const isSamlEnabled =
|
|
!!process.env.SAML_ENTRY_POINT &&
|
|
!!process.env.SAML_ISSUER &&
|
|
!!process.env.SAML_CERT &&
|
|
!!process.env.SAML_SESSION_SECRET;
|
|
|
|
/** @type {TStartupConfig} */
|
|
const payload = {
|
|
appTitle: process.env.APP_TITLE || 'LibreChat',
|
|
socialLogins: req.app.locals.socialLogins ?? defaultSocialLogins,
|
|
discordLoginEnabled: !!process.env.DISCORD_CLIENT_ID && !!process.env.DISCORD_CLIENT_SECRET,
|
|
facebookLoginEnabled:
|
|
!!process.env.FACEBOOK_CLIENT_ID && !!process.env.FACEBOOK_CLIENT_SECRET,
|
|
githubLoginEnabled: !!process.env.GITHUB_CLIENT_ID && !!process.env.GITHUB_CLIENT_SECRET,
|
|
googleLoginEnabled: !!process.env.GOOGLE_CLIENT_ID && !!process.env.GOOGLE_CLIENT_SECRET,
|
|
appleLoginEnabled:
|
|
!!process.env.APPLE_CLIENT_ID &&
|
|
!!process.env.APPLE_TEAM_ID &&
|
|
!!process.env.APPLE_KEY_ID &&
|
|
!!process.env.APPLE_PRIVATE_KEY_PATH,
|
|
openidLoginEnabled: isOpenIdEnabled,
|
|
openidLabel: process.env.OPENID_BUTTON_LABEL || 'Continue with OpenID',
|
|
openidImageUrl: process.env.OPENID_IMAGE_URL,
|
|
openidAutoRedirect: isEnabled(process.env.OPENID_AUTO_REDIRECT),
|
|
samlLoginEnabled: !isOpenIdEnabled && isSamlEnabled,
|
|
samlLabel: process.env.SAML_BUTTON_LABEL,
|
|
samlImageUrl: process.env.SAML_IMAGE_URL,
|
|
serverDomain: process.env.DOMAIN_SERVER || 'http://localhost:3080',
|
|
emailLoginEnabled,
|
|
registrationEnabled: !ldap?.enabled && isEnabled(process.env.ALLOW_REGISTRATION),
|
|
socialLoginEnabled: isEnabled(process.env.ALLOW_SOCIAL_LOGIN),
|
|
emailEnabled:
|
|
(!!process.env.EMAIL_SERVICE || !!process.env.EMAIL_HOST) &&
|
|
!!process.env.EMAIL_USERNAME &&
|
|
!!process.env.EMAIL_PASSWORD &&
|
|
!!process.env.EMAIL_FROM,
|
|
passwordResetEnabled,
|
|
showBirthdayIcon:
|
|
isBirthday() ||
|
|
isEnabled(process.env.SHOW_BIRTHDAY_ICON) ||
|
|
process.env.SHOW_BIRTHDAY_ICON === '',
|
|
helpAndFaqURL: process.env.HELP_AND_FAQ_URL || 'https://librechat.ai',
|
|
interface: req.app.locals.interfaceConfig,
|
|
turnstile: req.app.locals.turnstileConfig,
|
|
modelSpecs: req.app.locals.modelSpecs,
|
|
balance: req.app.locals.balance,
|
|
sharedLinksEnabled,
|
|
publicSharedLinksEnabled,
|
|
analyticsGtmId: process.env.ANALYTICS_GTM_ID,
|
|
instanceProjectId: instanceProject._id.toString(),
|
|
bundlerURL: process.env.SANDPACK_BUNDLER_URL,
|
|
staticBundlerURL: process.env.SANDPACK_STATIC_BUNDLER_URL,
|
|
};
|
|
/** @type {TCustomConfig['webSearch']} */
|
|
const webSearchConfig = req.app.locals.webSearch;
|
|
if (
|
|
webSearchConfig != null &&
|
|
(webSearchConfig.searchProvider ||
|
|
webSearchConfig.scraperType ||
|
|
webSearchConfig.rerankerType)
|
|
) {
|
|
payload.webSearch = {};
|
|
}
|
|
|
|
if (webSearchConfig?.searchProvider) {
|
|
payload.webSearch.searchProvider = webSearchConfig.searchProvider;
|
|
}
|
|
if (webSearchConfig?.scraperType) {
|
|
payload.webSearch.scraperType = webSearchConfig.scraperType;
|
|
}
|
|
if (webSearchConfig?.rerankerType) {
|
|
payload.webSearch.rerankerType = webSearchConfig.rerankerType;
|
|
}
|
|
|
|
if (ldap) {
|
|
payload.ldap = ldap;
|
|
}
|
|
|
|
if (typeof process.env.CUSTOM_FOOTER === 'string') {
|
|
payload.customFooter = process.env.CUSTOM_FOOTER;
|
|
}
|
|
|
|
await cache.set(CacheKeys.STARTUP_CONFIG, payload);
|
|
return res.status(200).send(payload);
|
|
} catch (err) {
|
|
logger.error('Error in startup config', err);
|
|
return res.status(500).send({ error: err.message });
|
|
}
|
|
});
|
|
|
|
module.exports = router;
|