🚀 feat: Add Custom Welcome Message in librechat.yaml (danny-avila#5870

) * feat: Custom Welcome Message (danny-avila#2967) * don't think I'm on the right path? * ✨ feat: Implement custom welcome message configuration in interface
The-GO · Feb 22, 2025 · 2a74ceb · 2a74ceb
1 parent b404e37
commit 2a74ceb
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 6 deletions.
diff --git a/api/server/services/start/interface.js b/api/server/services/start/interface.js
@@ -34,6 +34,7 @@ async function loadDefaultInterface(config, configDefaults, roleName = SystemRol
     multiConvo: interfaceConfig?.multiConvo ?? defaults.multiConvo,
     agents: interfaceConfig?.agents ?? defaults.agents,
     temporaryChat: interfaceConfig?.temporaryChat ?? defaults.temporaryChat,
+    customWelcome: interfaceConfig?.customWelcome ?? defaults.customWelcome,
   });
 
   await updateAccessPermissions(roleName, {

diff --git a/client/src/components/Chat/Landing.tsx b/client/src/components/Chat/Landing.tsx
@@ -87,7 +87,9 @@ export default function Landing({ Header }: { Header?: ReactNode }) {
       return localize('com_nav_welcome_agent');
     }
 
-    return localize('com_nav_welcome_message');
+    return typeof startupConfig?.interface?.customWelcome === 'string'
+      ? startupConfig?.interface?.customWelcome
+      : localize('com_nav_welcome_message');
   };
 
   return (
@@ -118,10 +120,13 @@ export default function Landing({ Header }: { Header?: ReactNode }) {
           <div className="flex flex-col items-center gap-0 p-2">
             <div className="text-center text-2xl font-medium dark:text-white">{name}</div>
             <div className="max-w-md text-center text-sm font-normal text-text-primary ">
-              {description ? description : localize('com_nav_welcome_message')}
+              {description ||
+                (typeof startupConfig?.interface?.customWelcome === 'string'
+                  ? startupConfig?.interface?.customWelcome
+                  : localize('com_nav_welcome_message'))}
             </div>
             {/* <div className="mt-1 flex items-center gap-1 text-token-text-tertiary">
-            <div className="text-sm text-token-text-tertiary">By Daniel Avila</div>
+             <div className="text-sm text-token-text-tertiary">By Daniel Avila</div>
           </div> */}
           </div>
         ) : (

diff --git a/librechat.example.yaml b/librechat.example.yaml
@@ -9,6 +9,7 @@ cache: true
 
 # Custom interface configuration
 interface:
+  customWelcome: "Welcome to LibreChat! Enjoy your experience."
   # Privacy policy settings
   privacyPolicy:
     externalUrl: 'https://librechat.ai/privacy-policy'
@@ -81,7 +82,7 @@ registration:
 #       model: ''
 #       voices: ['']
 
-#  
+#
 #   stt:
 #     openai:
 #       url: ''
@@ -234,10 +235,10 @@ endpoints:
       # Recommended: Drop the stop parameter from the request as Openrouter models use a variety of stop tokens.
       dropParams: ['stop']
       modelDisplayLabel: 'OpenRouter'
-      
+
     # Portkey AI Example
     - name: "Portkey"
-      apiKey: "dummy"  
+      apiKey: "dummy"
       baseURL: 'https://api.portkey.ai/v1'
       headers:
           x-portkey-api-key: '${PORTKEY_API_KEY}'

diff --git a/packages/data-provider/src/config.ts b/packages/data-provider/src/config.ts
@@ -446,6 +446,7 @@ export const intefaceSchema = z
       })
       .optional(),
     termsOfService: termsOfServiceSchema.optional(),
+    customWelcome: z.string().optional(),
     endpointsMenu: z.boolean().optional(),
     modelSelect: z.boolean().optional(),
     parameters: z.boolean().optional(),