Skip to content

Commit 1a556f3

Browse files
authored
πŸ“Œ docs: Banner (#459)
* feat: add Banner system docs * chore: cleanup old updates
1 parent 5d86bd2 commit 1a556f3

File tree

3 files changed

+105
-0
lines changed

3 files changed

+105
-0
lines changed

β€Žpages/docs/configuration/_meta.tsβ€Ž

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,4 +12,5 @@ export default {
1212
azure: 'Azure OpenAI',
1313
docker_override: 'Docker Override',
1414
mod_system: 'Automated Moderation',
15+
banner: 'Banner',
1516
}
Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
---
2+
title: Banner
3+
description: Display announcements and notices to your users
4+
---
5+
6+
# πŸ“’ Banner
7+
8+
Display important messages to all your users at the top of the app. Perfect for announcements, maintenance notices, or updates.
9+
10+
<Callout type="info" title="Quick Overview">
11+
- Only **one banner** can be active at a time
12+
- Schedule banners to appear and disappear automatically
13+
- Choose whether users can dismiss the banner or not
14+
- Show banners to everyone, or only logged-in users
15+
</Callout>
16+
17+
---
18+
19+
## Creating a Banner
20+
21+
Run this command to create or update a banner:
22+
23+
```bash
24+
npm run update-banner
25+
```
26+
27+
You'll be guided through a few simple prompts:
28+
29+
```ansi
30+
--------------------------
31+
Update the banner!
32+
--------------------------
33+
Display From (Format: yyyy-mm-ddTHH:MM:SSZ, Default: now):
34+
> 2025-12-02T09:00:00Z
35+
36+
Display To (Format: yyyy-mm-ddTHH:MM:SSZ, Default: not specified):
37+
> 2025-12-31T23:59:59Z
38+
39+
Enter your message (Enter a single dot "." on a new line to finish):
40+
> πŸŽ‰ Welcome to LibreChat! Check out our new features.
41+
> .
42+
43+
Is public (y/N):
44+
> n
45+
46+
Is persistable (cannot be dismissed) (y/N):
47+
> n
48+
```
49+
50+
<Callout type="tip" title="What do these options mean?">
51+
- **Display From/To**: When the banner should appear and disappear. Leave empty for "now" and "forever"
52+
- **Is public**: Show to visitors who aren't logged in (like on the login page)
53+
- **Is persistable**: If yes, users can't dismiss the banner β€” use for important notices
54+
</Callout>
55+
56+
---
57+
58+
## Deleting a Banner
59+
60+
```bash
61+
npm run delete-banner
62+
```
63+
64+
You'll see the current banner and be asked to confirm before deleting.
65+
66+
---
67+
68+
## Example Banners
69+
70+
<Tabs items={['Welcome Message', 'Maintenance Notice', 'Security Alert']}>
71+
<Tabs.Tab>
72+
A simple welcome message that users can dismiss:
73+
74+
```bash
75+
npm run update-banner "" "" "πŸ‘‹ Welcome to LibreChat!" "false" "false"
76+
```
77+
</Tabs.Tab>
78+
<Tabs.Tab>
79+
A scheduled maintenance notice that can't be dismissed:
80+
81+
```bash
82+
npm run update-banner "2025-12-20T00:00:00Z" "2025-12-21T06:00:00Z" "⚠️ Scheduled maintenance on Dec 20th, 2-6 AM UTC" "true" "true"
83+
```
84+
</Tabs.Tab>
85+
<Tabs.Tab>
86+
An urgent security notice visible to everyone:
87+
88+
```bash
89+
npm run update-banner "" "" "πŸ”’ Please update your password by January 1st" "true" "true"
90+
```
91+
</Tabs.Tab>
92+
</Tabs>
93+
94+
---
95+
96+
## Date Format
97+
98+
Use this format for dates: `yyyy-mm-ddTHH:MM:SSZ`
99+
100+
**Examples:**
101+
- `2025-12-25T09:00:00Z` β†’ December 25, 2025 at 9:00 AM (UTC)
102+
- `2025-01-01T00:00:00Z` β†’ January 1, 2025 at midnight (UTC)
103+
104+
Leave the date empty to use the current time or no end date.

β€Žtsconfig.tsbuildinfoβ€Ž

Whitespace-only changes.

0 commit comments

Comments
Β (0)