Skip to content

docs: add APP_DESCRIPTION option and clarify APP_TITLE description. #543

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

Open
ucodia wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add APP_DESCRIPTION option and clarify APP_TITLE description. #543

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 4 additions & 2 deletions content/docs/configuration/dotenv.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1346,18 +1346,20 @@ 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, Description, and Footer

<OptionTable
options={[
['APP_TITLE', 'string', 'App title.','APP_TITLE=LibreChat'],
['APP_TITLE', 'string', 'App title. Applied to the browser tab, the HTML `<title>` tag, and the PWA manifest (`name` and `short_name`). Served server-side for SEO.','APP_TITLE=LibreChat'],
['APP_DESCRIPTION', 'string', 'App description. Applied to the HTML `<meta name="description">` tag and the PWA manifest `description` field. Served server-side for SEO.','# APP_DESCRIPTION='],
['CUSTOM_FOOTER', 'string', 'Custom footer.','# CUSTOM_FOOTER="My custom footer"'],
['TEMP_CHAT_RETENTION_HOURS', 'number', '**Deprecated:** Use `interface.temporaryChatRetention` in librechat.yaml instead. Hours to retain temporary chats. Default: 720 (30 days).','# TEMP_CHAT_RETENTION_HOURS=168'],
]}
/>

**Behaviour:**

* Both `APP_TITLE` and `APP_DESCRIPTION` are injected server-side into the HTML and PWA manifest at startup, so crawlers and social-sharing previews see the correct values without JavaScript.
* 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 (`|`).
Expand Down
Loading