LibreChat Documentation

The official documentation, blog, and changelog for LibreChat, the open-source, self-hostable AI chat platform.

Visit www.librechat.ai »

This repository powers www.librechat.ai: the docs, guides, blog, and changelog for LibreChat. It is a Next.js application built on Fumadocs, with content authored in MDX.

Looking for the LibreChat app itself? It lives at danny-avila/LibreChat. Open code and product issues there, and documentation issues here.

• Features
• Tech Stack
• Getting Started
• Project Structure
• Writing Documentation
• Available Scripts
• Contributing
• Community & Support
• License

• 📚 Complete documentation covering setup, configuration, deployment, and every LibreChat feature.
• 📝 Blog & changelog authored in MDX, with release notes and long-form articles.
• 🤖 Ask AI — an in-page assistant (Vercel AI SDK + OpenRouter) that answers questions grounded in the docs.
• 🔍 Instant search — fast, fully client-side full-text search powered by Orama, with a prebuilt static index per language.
• 🌍 14 languages — English source with translations (中文, Español, Français, Deutsch, 日本語, Português, Italiano, Nederlands, Polski, Tiếng Việt, 한국어, Bahasa Indonesia, Türkçe), including dedicated tokenizers for CJK, Korean, Polish, and Vietnamese search.
• 🎨 Polished UI — responsive, accessible, light/dark themes out of the box via Fumadocs UI.
• ⚡ Static-first & fast — per-locale prebuilt search indexes, optimized images, and dynamic Open Graph images.
• 🔒 Privacy-friendly — cookieless, self-hosted analytics with no tracking banners.

• Node.js 22.x–24.x (CI and production run 24)
• pnpm 9.5+

# 1. Clone the repository
git clone https://github.com/LibreChat-AI/librechat.ai.git
cd librechat.ai

# 2. (Optional) create a local env file for Ask AI, rate limiting, etc.
cp .env.template .env.local

# 3. Install dependencies
pnpm install

# 4. Start the dev server
pnpm dev

Open http://localhost:3333 to view the site.

Environment variables are optional for local docs work. You only need to fill in .env.local to exercise features like Ask AI or rate limiting. Always run pnpm build before opening a PR to catch build errors early.

Generate an Ed25519 signing key, then copy the printed assignment into .env.local:

pnpm web-bot-auth:keygen

In the production secret manager, store the JSON between the single quotes as the WEB_BOT_AUTH_PRIVATE_JWK value.

Set WEB_BOT_AUTH_AGENT_ORIGIN when the public site origin is not https://www.librechat.ai. The app publishes the corresponding public JWKS at /.well-known/http-message-signatures-directory and signs requests from the docs AI agent. The directory returns 503 and agent requests fail closed until the private key is configured, so a deployment cannot advertise an empty key set or silently send unsigned agent traffic.

app/                # Next.js App Router: docs, blog, changelog pages + API routes
  api/
    chat/           # "Ask AI" endpoint (OpenRouter via the Vercel AI SDK)
    search/         # Per-locale static Orama search index
content/
  docs/             # Documentation pages (MDX), organized by section
  blog/             # Blog posts (MDX)
  changelog/        # Changelog entries (MDX)
components/         # React components (home, UI, icons, search dialog, etc.)
lib/                # Utilities: content sources, i18n, search, MDX components
public/             # Static assets (images, videos, icons)
scripts/            # Build, translation, and image-optimization scripts
source.config.ts    # Fumadocs content collections config

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

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

Only pages listed in the pages array appear in the sidebar, in the order given.

Localization: English (.mdx) is the source of truth. Translated pages use a locale suffix (for example index.es.mdx), and each locale's search index only includes pages that have a real translated file. Keep new content in English and let the translation workflow handle the rest.

Contributions are welcome, from fixing a typo to writing a whole new guide.

1. Fork the repo and create a branch from main.
2. Make your changes and preview them locally with pnpm dev.
3. Before opening a PR, run pnpm lint, pnpm typecheck, and pnpm build.
4. Open a pull request describing what you changed and why.

For questions about the documentation, join the Discord. For issues with the LibreChat application itself, please use the main repository.

• 🌐 Website: www.librechat.ai
• 💬 Discord: discord.librechat.ai
• 🧠 Ask DeepWiki: deepwiki.com/LibreChat-AI/librechat.ai
• 🚀 Main app: danny-avila/LibreChat

Released under the MIT License.