From bbbd90a0699f2ca89674189e3d244e7a97f21240 Mon Sep 17 00:00:00 2001 From: Ruben Talstra Date: Fri, 14 Feb 2025 11:41:21 +0100 Subject: [PATCH 1/2] feat: Add Custom Welcome Message Support in LibreChat [#5870](https://github.com/danny-avila/LibreChat/pull/5870) --- pages/docs/configuration/dotenv.mdx | 20 +++++++++++++------- 1 file changed, 13 insertions(+), 7 deletions(-) diff --git a/pages/docs/configuration/dotenv.mdx b/pages/docs/configuration/dotenv.mdx index f6226b45..b77afeca 100644 --- a/pages/docs/configuration/dotenv.mdx +++ b/pages/docs/configuration/dotenv.mdx @@ -948,22 +948,28 @@ Properly setting cache headers is crucial for optimizing the performance and eff * Uncomment `STATIC_CACHE_S_MAX_AGE` to change the `s-maxage` for static files. By default this is set to 1 week. - This is for the _shared cache_, which is used by CDNs and proxies. -#### App Title and Footer +#### App Title, Welcome Message, and Footer **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 (`|`). +- **`CUSTOM_WELCOME_MESSAGE`**: + * Uncomment and set a value to display a custom welcome message on the landing page. + * Leave it commented or empty to use the default welcome message. -> **Markdown example:** `CUSTOM_FOOTER=[Link 1](http://example1.com) | [Link 2](http://example2.com)` +- **`CUSTOM_FOOTER`**: + * 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)` #### Birthday Hat From 5cbe1e82068d54ab31ca6fc09696f3f1b2fd813b Mon Sep 17 00:00:00 2001 From: Ruben Talstra Date: Sat, 22 Feb 2025 15:37:42 +0100 Subject: [PATCH 2/2] =?UTF-8?q?=F0=9F=93=9C=20docs:=20update=20dotenv.mdx?= =?UTF-8?q?=20and=20interface.mdx=20to=20remove=20custom=20welcome=20messa?= =?UTF-8?q?ge=20references?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- pages/docs/configuration/dotenv.mdx | 20 ++++++---------- .../object_structure/interface.mdx | 24 ++++++++++++++++++- 2 files changed, 30 insertions(+), 14 deletions(-) diff --git a/pages/docs/configuration/dotenv.mdx b/pages/docs/configuration/dotenv.mdx index b77afeca..2661795f 100644 --- a/pages/docs/configuration/dotenv.mdx +++ b/pages/docs/configuration/dotenv.mdx @@ -948,28 +948,22 @@ Properly setting cache headers is crucial for optimizing the performance and eff * Uncomment `STATIC_CACHE_S_MAX_AGE` to change the `s-maxage` for static files. By default this is set to 1 week. - This is for the _shared cache_, which is used by CDNs and proxies. -#### App Title, Welcome Message, and Footer +#### App Title and Footer **Behaviour:** -- **`CUSTOM_WELCOME_MESSAGE`**: - * Uncomment and set a value to display a custom welcome message on the landing page. - * Leave it commented or empty to use the default welcome message. + * 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 (`|`). -- **`CUSTOM_FOOTER`**: - * 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 index 3aa2d407..9b8d01c5 100644 --- 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 -``` \ No newline at end of file +``` + +--- + +## customWelcome + +**Key:** + + +**Default:** _None (if not specified, a default greeting is used)_ + +**Example:** +```yaml filename="interface / customWelcome" +interface: + customWelcome: "Welcome to LibreChat! Enjoy your conversation." +``` +