feat: Add Custom Welcome Message Support in LibreChat (#236)

* feat: Add Custom Welcome Message Support in LibreChat [#5870](danny-avila/LibreChat#5870) * 📜 docs: update dotenv.mdx and interface.mdx to remove custom welcome message references
LibreChat-AI · Feb 22, 2025 · f5ee4e2 · f5ee4e2
1 parent bce321d
commit f5ee4e2
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 5 deletions.
diff --git a/pages/docs/configuration/dotenv.mdx b/pages/docs/configuration/dotenv.mdx
@@ -981,11 +981,11 @@ Properly setting cache headers is crucial for optimizing the performance and eff
 
 **Behaviour:**
 
-* Uncomment `CUSTOM_FOOTER` to add a custom footer.
-* Uncomment and leave `CUSTOM_FOOTER` empty to remove the footer.
-* You can now add one or more links in the CUSTOM_FOOTER value using the following format: `[Anchor text](URL)`. Each link should be delineated with a pipe (`|`).
+ * Uncomment `CUSTOM_FOOTER` to add a custom footer.
+ * Uncomment and leave `CUSTOM_FOOTER` empty to remove the footer.
+ * You can now add one or more links in the CUSTOM_FOOTER value using the following format: `[Anchor text](URL)`. Each link should be delineated with a pipe (`|`).
 
-> **Markdown example:** `CUSTOM_FOOTER=[Link 1](http://example1.com) | [Link 2](http://example2.com)`
+ > **Markdown example:** `CUSTOM_FOOTER=[Link 1](http://example1.com) | [Link 2](http://example2.com)`
 
 #### Birthday Hat
 

diff --git a/pages/docs/configuration/librechat_yaml/object_structure/interface.mdx b/pages/docs/configuration/librechat_yaml/object_structure/interface.mdx
@@ -17,6 +17,7 @@ These are fields under `interface`:
   - `bookmarks`
   - `multiConvo`
   - `agents`
+  - `customWelcome`
 
 **Notes:**
 
@@ -49,6 +50,7 @@ interface:
   bookmarks: true
   multiConvo: true
   agents: true
+  customWelcome: "Welcome to LibreChat!"
 ```
 
 ## privacyPolicy
@@ -241,4 +243,24 @@ More info on [Agents](/docs/features/agents)
 ```yaml filename="interface / agents"
 interface:
   agents: true
-```
+```
+
+---
+
+## customWelcome
+
+**Key:**
+<OptionTable
+  options={[
+    ['customWelcome', 'String', 'Allows administrators to define a custom welcome message for the chat interface.', 'This message will be displayed to users upon entering the chat, providing a personalized greeting.'],
+  ]}
+/>
+
+**Default:** _None (if not specified, a default greeting is used)_
+
+**Example:**
+```yaml filename="interface / customWelcome"
+interface:
+  customWelcome: "Welcome to LibreChat! Enjoy your conversation."
+```
+