Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Add Custom Welcome Message Support in LibreChat #236

Merged
merged 2 commits into from
Feb 22, 2025
Merged

feat: Add Custom Welcome Message Support in LibreChat #236

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bbbd90a
feat: Add Custom Welcome Message Support in LibreChat [#5870](https:/…
rubentalstra Feb 14, 2025
5cbe1e8
📜 docs: update dotenv.mdx and interface.mdx to remove custom welcome …
rubentalstra Feb 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions pages/docs/configuration/dotenv.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -959,11 +959,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

Expand Down
24 changes: 23 additions & 1 deletion pages/docs/configuration/librechat_yaml/object_structure/interface.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ These are fields under `interface`:
- `bookmarks`
- `multiConvo`
- `agents`
- `customWelcome`

**Notes:**

Expand Down Expand Up @@ -49,6 +50,7 @@ interface:
bookmarks: true
multiConvo: true
agents: true
customWelcome: "Welcome to LibreChat!"
```

## privacyPolicy
Expand Down Expand Up @@ -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."
```

Loading