Docs
⚙️ Configuration
Banner

📢 Banner

Display important messages to all your users at the top of the app. Perfect for announcements, maintenance notices, or updates.

ℹ️
Quick Overview
  • Only one banner can be active at a time
  • Schedule banners to appear and disappear automatically
  • Choose whether users can dismiss the banner or not
  • Show banners to everyone, or only logged-in users

Creating a Banner

Run this command to create or update a banner:

npm run update-banner

You’ll be guided through a few simple prompts:

--------------------------
Update the banner!
--------------------------
Display From (Format: yyyy-mm-ddTHH:MM:SSZ, Default: now):
> 2025-12-02T09:00:00Z
 
Display To (Format: yyyy-mm-ddTHH:MM:SSZ, Default: not specified):
> 2025-12-31T23:59:59Z
 
Enter your message (Enter a single dot "." on a new line to finish):
> 🎉 Welcome to LibreChat! Check out our new features.
> .
 
Is public (y/N):
> n
 
Is persistable (cannot be dismissed) (y/N):
> n
🔥
What do these options mean?
  • Display From/To: When the banner should appear and disappear. Leave empty for “now” and “forever”
  • Is public: Show to visitors who aren’t logged in (like on the login page)
  • Is persistable: If yes, users can’t dismiss the banner — use for important notices

Deleting a Banner

npm run delete-banner

You’ll see the current banner and be asked to confirm before deleting.


Example Banners

A simple welcome message that users can dismiss:

npm run update-banner "" "" "👋 Welcome to LibreChat!" "false" "false"

Date Format

Use this format for dates: yyyy-mm-ddTHH:MM:SSZ

Examples:

  • 2025-12-25T09:00:00Z → December 25, 2025 at 9:00 AM (UTC)
  • 2025-01-01T00:00:00Z → January 1, 2025 at midnight (UTC)

Leave the date empty to use the current time or no end date.