Marco Beretta 4174c8dd6c fix(docs): add valid cache keys to Redis docs and Apple Silicon warning to Docker page (#541)
Fixes #428: The Redis configuration doc previously listed STATIC_CONFIG as
a valid cache key, which was deprecated and causes startup errors. Added a
complete table of valid CacheKeys values with descriptions, plus a callout
warning about invalid keys.

Fixes #228: The Docker installation page had no mention of the AVX
incompatibility with Apple Silicon (M-series) Macs. Added a prominent
callout in the Prerequisites section with the docker-compose.override.yml
fix to use mongo:4.4.18.
2026-03-22 03:31:46 +01:00
2024-05-09 17:09:13 -04:00
2024-05-09 17:09:13 -04:00
2024-05-09 17:09:13 -04:00
2024-05-09 17:09:13 -04:00
2024-05-09 17:09:13 -04:00
2024-05-09 17:09:13 -04:00
2024-05-09 17:09:13 -04:00
2026-02-18 21:46:20 -05:00
2024-05-09 17:09:13 -04:00

LibreChat Docs

The official documentation site for LibreChat, built with Next.js 15 and Fumadocs.

www.librechat.ai

Tech Stack

  • Framework: Next.js 15 (App Router)
  • Docs Engine: Fumadocs (fumadocs-mdx + fumadocs-ui)
  • Styling: Tailwind CSS
  • Icons: Lucide React
  • Package Manager: Bun

Local Development

Prerequisites: Bun 1.0+

  1. Clone the repository
  2. Copy .env.template to .env.local and fill in any optional values
  3. Install dependencies:
    bun i
    
  4. Start the dev server (uses Turbopack):
    bun dev
    
  5. Open http://localhost:3333

Note: Always run bun run build before opening a PR to catch build errors early.

Project Structure

app/              # Next.js App Router pages (docs, blog, changelog, API routes)
content/
  docs/           # Documentation pages (MDX)
  blog/           # Blog posts (MDX)
  changelog/      # Changelog entries (MDX)
components/       # React components (home, UI, icons, etc.)
lib/              # Utilities, icons, MDX components, Nextra shims
public/           # Static assets
pages/            # Legacy pages (migrating to app/)
source.config.ts  # Fumadocs content collections config

Documentation Content

Docs live in content/docs/ and are organized by section. Each directory has a meta.json that controls sidebar navigation:

{
  "title": "Section Title",
  "icon": "Wrench",
  "pages": ["index", "page-one", "page-two"]
}

Only pages listed in the pages array appear in the sidebar.

Scripts

Command Description
bun dev Start dev server on port 3333 (Turbopack)
bun run build Production build
bun start Start production server on port 3333
bun run lint Run ESLint
bun run prettier Format code with Prettier
bun run analyze Analyze production bundle size

License

MIT

Description
No description provided
Readme MIT 108 MiB
Languages
MDX 83.8%
TypeScript 14.9%
CSS 0.6%
JavaScript 0.6%
Shell 0.1%