Commit Graph

383 Commits

Author SHA1 Message Date
Marco Beretta
e3ad59744d feat: redesign docs site pages, migrate legal/about to App Router, add feedback widget (#502)
* feat: update table of content style in DocsPage component

* feat: add feedback widget, redesign DocsHub, and add sidebar logo

* feat: update demo images for dark and light themes

* feat: update demo images for dark and light themes

* feat: replace logo image and remove duplicate SVG file

* feat: add LocalInstallHub component and update documentation for local installation

* feat: enhance UI by updating feature icons and descriptions, and improving layout responsiveness

* Add legal pages: Cookie Policy, Privacy Policy, and Terms of Service

- Implemented Cookie Policy page with details on cookie usage and user privacy.
- Created Privacy Policy page outlining data collection practices and user rights.
- Developed Terms of Service page defining the usage terms for the documentation site.
- Removed outdated MDX files for cookie, privacy, and terms of service.
- Updated FeaturesHub component to include new feature highlights and improved layout.

* feat: enhance GitHub data fetching to include contributor count and update CommunitySection layout
2026-02-19 00:06:58 +01:00
Danny Avila
bd2eb566df chore: update configuration and dependencies for improved performance and compatibility (#501)
* chore: update configuration and dependencies for improved performance and compatibility

- Refactored \`next-env.d.ts` to use import syntax for route types.
- Updated \`next.config.mjs\` to enable turbopack and removed ESLint ignore settings.
- Modified \`package.json\` and \`pnpm-lock.yaml\` to upgrade dependencies, including Next.js to version 16.1.6 and ajv to version 8.18.0.
- Adjusted build scripts in \`package.json\` to use webpack.
- Added a new \`proxy.ts\` file for handling markdown requests.
- Updated \`tsconfig.json\` to include additional TypeScript definitions for development.

* chore: update Next.js bundle analysis workflow for improved compatibility and performance

- Updated GitHub Actions workflow to use the latest versions of actions for better stability.
- Changed Node.js version to 20 and updated pnpm setup to version 4.
- Simplified ESLint command and build process by using `pnpm lint` and `pnpm build`.
- Enhanced comment handling by consolidating create/update comment steps into a single action.
- Removed deprecated steps and comments for a cleaner workflow configuration.

* chore: update package manager version in package.json

- Set packageManager to pnpm@9.5.0 for improved dependency management.

* chore: enhance Next.js bundle analysis workflow with caching and telemetry settings

- Added environment variable to disable Next.js telemetry for privacy.
- Implemented caching for Next.js build to improve workflow performance by restoring build artifacts.

* refactor: simplify credentials generation logic in credentialsGenerator.ts

- Replaced crypto module with window.crypto for generating random hex values.
- Streamlined the generateCredentials function to use concise object return syntax.
2026-02-18 13:54:27 -05:00
Marco Beretta
4656b0116a feat: Migrate to Fumadocs, overhaul UI, and improve docs navigation (#500)
* feat: enhance accessibility and improve component structure across various files

* feat: enhance components with TypeScript typings and improve documentation

- Added TypeScript interface for Screenshot component props.
- Updated button component documentation for clarity.
- Removed unnecessary console log in ContainerScroll component.
- Added descriptive comments for FloatingDock and utility functions.
- Improved CSP headers in next.config.mjs for security.
- Cleaned up package.json by removing unused dependencies.
- Refactored _app.tsx to use AppProps for type safety.
- Updated meta configuration by removing hidden display property.
- Added API documentation comments for GitHub stats and subscription endpoints.
- Enhanced error handling in subscription API.
- Updated Tailwind CSS configuration with detailed comments.
- Cleaned up style.css by organizing and refining styles.
- Updated tsconfig.json to include TypeScript files for API routes.
- Added comments to Subscriber model and dbConnect utility for clarity.

* feat: add aria-labels to HeroLinks for improved accessibility

* feat: replace Twitter icon with X and add new X icon component

* chore: update code structure for better readability and maintenance

* chore: update .gitignore to include additional AI assistant files and Claude Flow generated files

* feat: replace sidebar emojis with Lucide icons, fix duplicate titles, and clean up codebase

- Add icon resolver (lib/icons.tsx) with 73 Lucide React icons mapped to string IDs
- Wire icon resolver into Fumadocs loader for automatic sidebar icon rendering
- Update all 19 meta.json files to use icon field instead of emoji prefixes
- Add icon frontmatter to all 162 MDX documentation pages
- Deduplicate adjacent sidebar icons (e.g. Search/ListFilter, Brain/Bookmark)
- Remove duplicate H1 headings from 154 MDX files (DocsTitle renders frontmatter)
- Add frontmatter to 33 files that were missing it
- Shorten overly long titles (agents, mcp, url_query)
- Rewrite /docs/local cards from old Nextra syntax to Fumadocs Card components
- Remove all emojis from Get Started and Features index pages
- Collapse sidebar folders by default (defaultOpenLevel: 0)
- Delete temporary debugging scripts, test specs, and screenshot artifacts
- Fix eslint errors in mdx-components, nextra-shims, tailwind config, and error page
- Update .gitignore to exclude test/debug artifacts

* feat: enhance accessibility and improve UI components

- Added aria-hidden attributes to social media icons in FooterMenu for better accessibility.
- Updated FooterMenu to use <footer> element for semantic HTML.
- Improved Carousel component by adding aria-labels to navigation buttons for better screen reader support.
- Modified OptionTable to use a unique key for each row to prevent rendering issues.
- Enhanced CredentialsGeneratorBox with aria-labels for input fields and buttons to improve accessibility.
- Updated documentation to remove unnecessary links and improve clarity in various sections.
- Fixed iframe attributes in documentation for better compatibility and accessibility.
- Adjusted CSS variable for muted foreground color to improve contrast.
- Updated package.json and pnpm-lock.yaml for dependency management and optimization.

* feat: update FileComponent and FolderComponent to include new props for enhanced functionality

* Add new AI provider icons and update documentation

- Introduced new SVG icons for AI providers: TogetherAI, TrueFoundry, VLLM, Vultr, and XAI.
- Updated existing AI endpoint documentation to reflect new icon names and improve clarity.
- Replaced generic \Plug\ icons with specific provider icons for Anyscale, APIpie, Cloudflare, Cohere, Databricks, DeepSeek, Fireworks, Groq, Helicone, HuggingFace, LiteLLM, Mistral, MLX, Moonshot, NeuroChain, Ollama, OpenRouter, Perplexity, Portkey, ShuttleAI, and TrueFoundry.
- Enhanced the icon resolution logic to include new icons in the icon registry.

* feat: add DocsHub and QuickStartHub components for enhanced documentation navigation

* feat: implement FeaturesHub component for enhanced feature navigation and update ViewOptions for improved links

* feat: add fresh-build script for streamlined project setup and development

* fix: update ESLint configuration and improve type handling in components

- Added 'next.config.mjs' to ESLint ignore list.
- Refactored version assignment in ChangelogPage for better type safety.
- Removed unnecessary type casting in Author components for cleaner code.
- Simplified BlogHeader component by removing redundant type assertions.
- Added eslint-disable comments for unused variables in CardCompat and Nextra shims.

* fix: update ViewOptions link for LibreChat to remove unnecessary submit parameter

* feat: enhance HomePage layout and improve GitHub star display

- Integrated HomeLayout component for better page structure.
- Updated HeroSection to improve the presentation of GitHub stars with a new layout and styling.
- Adjusted link attributes for better accessibility and user experience.

* refactor: simplify title for Model Context Protocol (MCP) documentation

- Changed the title from "Model Context Protocol (MCP)" to "MCP" for brevity.
- Updated the description to clarify how LibreChat utilizes MCP for integration with external tools and services.

* feat: enhance navigation styling and update HomeLayout props

- Added a new background style for the navigation bar with a blur effect.
- Updated HomeLayout component to include a transparent navigation mode for improved visual integration.

* refactor: deprecate plugins in favor of agents and update related documentation

- Removed references to plugins across various files, including the FeaturesHub and documentation.
- Updated navigation redirects to point to agents instead of plugins.
- Deleted the plugins documentation file to streamline content and reduce confusion.

* feat: update demo images for improved visual representation

---------

Co-authored-by: Danny Avila <danny@librechat.ai>
2026-02-18 10:44:38 -05:00
Danny Avila
72a7a934ab chore: Remove forcePrompt, add Moonshot Provider (#495)
* docs: add Moonshot AI configuration documentation and update known endpoints list

* docs: remove forcePrompt configuration from various AI endpoint examples and documentation
2026-02-11 15:03:26 -05:00
Danny Avila
6903a90c65 docs: enhance interface documentation for prompts and agents permissions (#497)
* docs: enhance interface documentation for prompts and agents permissions

Added 'create' permission to both prompts and agents sections, clarifying the configuration options. Updated examples to reflect changes in permission handling for boolean and object structures, ensuring users understand the implications of each setting.

* docs: clarify prompts and agents permission updates in configuration documentation

Enhanced the documentation for prompts and agents permissions by specifying how the 'create' permission interacts with other sub-permissions. Updated examples to illustrate the new behavior of permission updates when using object structures, ensuring clearer guidance for users on managing permissions effectively.

* docs: refine boolean and object configuration examples for prompts and agents

Updated the documentation to clarify the behavior of boolean and object configurations for prompts and agents. Simplified language in examples to enhance understanding of how permissions are preserved or updated, ensuring users can effectively manage their settings.
2026-02-11 15:02:47 -05:00
Marco Beretta
e5771248a4 🌍 docs: add Icelandic, Lithuanian, Norwegian Nynorsk, and Slovak translation support (#498) 2026-02-06 23:56:15 +01:00
Jannik Maierhöfer
626e6c0b1b docs: add langfuse tracing integration guide (#496)
* docs: add langfuse tracing integration guide

This document explains how to integrate Langfuse tracing with LibreChat, including setup instructions and example configurations.

* add to meta
2026-02-05 12:25:18 +01:00
Danny Avila
029b32e01e v0.8.2 (#493)
* docs: add changelog for v0.8.2 release with major accessibility improvements, dynamic MCP server management, and new model support

* docs: add documentation for Resumable Streams feature, including benefits, deployment modes, and troubleshooting tips

* ⚙️ Config v1.3.3

* docs: enhance Redis configuration guide to include horizontal scaling and resumable streams details

* docs: enhance configuration documentation for various services including Anthropic via Vertex AI, AWS Bedrock, Gemini Image Generation, and CDN options for Amazon S3 and Azure Blob Storage

* docs: enhance configuration documentation for logging, file upload, and speech features, including rate limiting options and environment variable references

* docs: update changelog for v0.8.2 to reflect major accessibility improvements and new resumable LLM streams feature

* docs: update changelog for v1.3.3 to include link to promptCache model specs documentation

* docs: enhance SSRF protection documentation for allowedDomains configuration in actions and MCP settings

* docs: update release date for Config v1.3.3 in changelog
2026-01-28 17:40:37 -05:00
ahalekelly
8dbd1e1bae docs: Update Traefik to v3.6 to support Docker v29 (#491)
Docker v29 dropped support for Docker API 1.24 which was the API version Traefik was using, see [here](https://github.com/traefik/traefik/issues/12257). This caused Traefik to not launch, Traefik fixed this issue in v3.6.1, I updated my setup and it fixed the issue.
2026-01-26 09:53:11 -05:00
Danny Avila
f9f940b30e docs: add changelog for v0.8.2-rc3 release with new features, fixes, and internationalization updates 2026-01-17 17:21:06 -05:00
Dustin Healy
872279c4e6 docs: update memory pages for custom endpoints PR (#488) 2026-01-13 11:47:39 -05:00
heptapod
53dfd1141b docs: remove YouTube tool documentation from tools configuration page (#487) 2026-01-13 11:45:05 -05:00
Dustin Healy
36f04ac896 docs: add docs for mcpSettings and mcpSettings.allowedDomains (#485) 2026-01-12 12:51:30 -05:00
Dustin Healy
09aeb8a50c 📢 docs: v0.8.2-rc2 changelog (#482)
* docs: v0.8.2-rc2 changelog

* docs: add highlights section

* fix: combine internationlization and change to correct full changelog link

* fix: add back what's changed header

* chore: polish highlights

* chore: final tweaks

* Update changelog for v0.8.2-rc2

* Remove highlights from v0.8.2-rc2 changelog

Removed highlights section from the changelog for version 0.8.2-rc2.

* Update release date for v0.8.2-rc2

---------

Co-authored-by: Danny Avila <danny@librechat.ai>
2026-01-07 12:00:56 -05:00
Odrec
cbf533592a docs: add groupIcon property documentation for modelSpecs (#479)
Co-authored-by: Odrec <odrec@Odrecs-MacBook-Pro.local>
2026-01-03 14:19:09 -05:00
David Neale
bdbba51564 docs: Add Bedrock Guardrails support (#475)
Co-authored-by: David Neale <david.neale@admiralfinancialservices.co.uk>
2026-01-03 12:49:01 -05:00
Joseph Licata
2bab1c9cd2 docs: Add Gemini Image Generation tool documentation (#452)
* docs: Add Gemini Image Generation tool documentation

* docs: Add Gemini Image Tools to image_gen features page

* fix: Update default model to gemini-2.5-flash-image
2026-01-03 12:48:43 -05:00
Joseph Licata
f2a90bb6ac docs: Add Anthropic Vertex AI documentation (#466)
* docs: Add Anthropic Vertex AI documentation

Add comprehensive documentation for running Anthropic Claude models
through Google Cloud Vertex AI, introduced in danny-avila/LibreChat#10780.

Changes:
- Updated anthropic.mdx with Vertex AI quick start section
- Created anthropic_vertex.mdx with detailed YAML configuration docs
- Updated _meta.ts navigation to include new page

* docs: Remove 'enabled' key from Anthropic Vertex AI configuration

Updated the documentation for the Anthropic Vertex AI configuration by removing the 'enabled' key, as it is no longer necessary. Clarified that the presence of the 'vertex' section indicates that Vertex AI is enabled. Adjusted examples and notes for better clarity regarding configuration options.
2026-01-01 12:00:30 -05:00
bene-we
5d232d45fb docs: add MCP OAuth Callback URL (#471)
* docs: add OAuth callback URL details in MCP documentation

* docs: update OAuth redirect URI examples in MCP servers documentation

* docs: improve readability & formatting
2025-12-25 20:45:44 -05:00
Dustin Healy
5861e77975 docs: v1.3.2 config changelog and accompanying docs updates (#469)
* docs: document config changes

* docs: add IMAGE_GEN_OAI_MODEL documentation
2025-12-25 20:42:50 -05:00
Marco Beretta
16d7e81bc9 docs: add configuration validation details and troubleshooting guidance for librechat.yaml (#456) 2025-12-25 23:37:25 +01:00
Danny Avila
d55d17c582 🗞️ docs: update changelog for v0.8.2-rc1 with highlights and new features 2025-12-16 20:28:41 -05:00
Dustin Healy
ac70887e5c 🗞️ docs: add v0.8.2-rc1 changelog (#467)
* docs: v0.8.2-rc1 changelog

* fix: swap out old mistake title

* fix: semantic commits take sorting precedence over emojis

* Update changelog for version 0.8.2-rc1

Added new features, bug fixes, and dependency updates for version 0.8.2-rc1.

* Update changelog for v0.8.2-rc1

Updated changelog for version 0.8.2-rc1 with new features, bug fixes, and dependency updates.

* Fix changelog entry for @librechat/agents bump

---------

Co-authored-by: Danny Avila <danny@librechat.ai>
2025-12-16 20:23:21 -05:00
Dustin Healy
e9cabbfb15 📢 docs: add v0.8.1 changelog (#458)
* docs: add v0.8.1 changelog

* chore: reorder model updates

* chore: bump date

* chore: bump date and latest commits

* chore: update release date to 2025/12/11 for v0.8.1

---------

Co-authored-by: Danny Avila <danny@librechat.ai>
2025-12-11 14:47:35 -05:00
Dustin Healy
296f502ee2 📙 docs: Add documentation for Direct Provider Attachments / OCR (#404)
* 📙 docs: Add documentation for Direct Provider Attachments / OCR

* docs: add note about Responses API

* Revise OCR documentation for clarity and accuracy

Updated section titles and clarified details regarding file uploads to OCR providers, including specific notes for OpenAI and Azure OpenAI.

---------

Co-authored-by: Danny Avila <danny@librechat.ai>
2025-12-11 14:47:16 -05:00
Dustin Healy
5e6f45b729 📬 docs: shareable_links feature page (#460) 2025-12-11 14:41:01 -05:00
Marco Beretta
1a556f38a5 📌 docs: Banner (#459)
* feat: add Banner system docs

* chore: cleanup old updates
2025-12-07 17:26:05 +01:00
Danny Avila
5d86bd2af9 📄 docs: Update Speech-to-Text configuration link in upload_as_text documentation
Replaced the link for Speech-to-Text Configuration to point to the new location in the LibreChat YAML structure for better clarity and accuracy.
2025-12-05 10:57:43 -05:00
Danny Avila
7c263ccf50 📄 docs: Update SharePoint configuration link for File Uploads section
Replaced the link for File Upload Configuration in the SharePoint documentation to point to the new location in the LibreChat YAML structure.
2025-12-05 10:55:47 -05:00
Danny Avila
68c903a9bb Revert "docs: Add OIDC Group Synchronization documentation for Keycloak (#426)" (#462)
This reverts commit 583330e2a4.
2025-12-05 10:54:24 -05:00
Danny Avila
ab364c23c4 📦 chore: Update Packages (#463)
* chore: bump packages

* chore: bump packages

* chore: bump packages

* chore: update package dependencies to latest versions

* chore: update configuration and dependencies for Nextra migration

- Updated TypeScript references in `next-env.d.ts` to align with new Nextra structure.
- Modified `next.config.mjs` to ignore ESLint and TypeScript build errors during the build process.
- Added a new `PACKAGE_UPDATE_SUMMARY.md` documenting package updates and migration details.
- Downgraded Next.js and Nextra versions for compatibility, and updated related dependencies.
- Introduced new `page.tsx` files for dynamic routing and metadata generation in the app directory.
- Added 'use client' directive to multiple components to support client-side rendering.
- Refactored components to remove deprecated Nextra context methods in preparation for App Router.

* chore: update ESLint configuration to use __dirname for tsconfigRootDir and fix lint errors

* chore: update initial statistics for GitHub stars and Docker pulls in Usage component

* chore: refactor clean-cache script to use CommonJS require syntax

* chore: remove redundant ESLint installation step in workflow
2025-12-05 10:53:29 -05:00
Dustin Healy
8218bd0a0e 📒 docs: Add documentation for adding default params via custom params (#454) 2025-12-02 08:11:36 -05:00
illgitthat
134aecad85 🔍 fix: Serper link typo in Docs (#410)
* (minor) add {convo} to titleprompt example

* 🔍 fix: Serper link typo in Docs

Current link was a 404
2025-11-26 11:46:54 -05:00
Rakshit
37e00c5b7b 📚 docs: update Azure OpenAI documentation for new domain format support (#437)
Updated documentation to reflect changes from LibreChat PR #10355, which fixed Azure OpenAI Speech-to-Text 400 Bad Request errors by adding support for the new `.cognitiveservices.azure.com` domain format alongside the legacy `.openai.azure.com` format.

Changes:
- Added domain format support callouts in STT/TTS configuration documentation
- Updated Azure OpenAI configuration guide with new endpoint format examples
- Enhanced instanceName field descriptions across all Azure configuration docs
- Updated DALL-E baseURL documentation to show both domain formats
- Added examples demonstrating both legacy and new domain usage

All changes maintain backward compatibility while documenting the new functionality.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-authored-by: Claude <noreply@anthropic.com>
2025-11-26 11:46:15 -05:00
heptapod
583330e2a4 docs: Add OIDC Group Synchronization documentation for Keycloak (#426)
* docs: Add OIDC Group Synchronization documentation for Keycloak

Add comprehensive documentation for the new OIDC group sync feature:
- Overview and prerequisites
- Configuration examples for realm roles, client roles, and groups
- Step-by-step setup instructions
- Troubleshooting guide with common claim paths
- Usage examples for permissions
- Limitations and best practices

Covers integration with LibreChat's granular permissions system
for agents, prompts, files, and conversations.

Related to LibreChat PR and issue #10006

* docs: Add group/role exclusion pattern documentation

Document OPENID_GROUPS_EXCLUDE_PATTERN configuration option:
- Explain exact match (case-insensitive) and regex pattern support
- Provide common Keycloak exclusion examples
- Show why to exclude system roles, default roles, and auth roles
- Add practical scenario with admin/developers vs system roles
- Include configuration examples for filtering out:
  - offline_access, uma_authorization (system roles)
  - default-roles-* (default realm roles)
  - manage-account, view-profile (account management)

Complements the group sync feature by allowing fine-grained control
over which roles become groups in LibreChat.
2025-11-26 11:45:55 -05:00
Dustin Healy
4646ecc8f7 📰 docs: add v0.8.1-rc2 changelog (#451)
* docs: add v0.8.1-rc2 changelog

* chore: bump release date
2025-11-26 11:45:27 -05:00
Dustin Healy
105f709276 docs: update model_specs.mdx (#453) 2025-11-26 11:37:32 -05:00
Peter Nancarrow
12f8c89885 docs: add groups to modelspecs (#429)
Co-authored-by: Dustin Healy <54083382+dustinhealy@users.noreply.github.com>
2025-11-26 11:34:46 -05:00
Mikhail Salkov
79b5d16781 docs: Fix indent in docker compose volumes bind (#447)
* Update 2024-03-02_ollama.mdx

* Update 2023-11-30_litellm.mdx

* Update google.mdx

* Update custom_endpoints.mdx
2025-11-26 11:07:43 -05:00
Dustin Healy
f1f319a92b 🗞️ docs: Add v0.8.1-rc1 changelog (#450) 2025-11-26 10:13:04 -05:00
Dustin Healy
587d65b87a 📖 docs: Document config changes (v0.8.0-rc1 to v0.8.1-rc1) (#448)
* feat: document new charLimit in memory configuration

* feat: document peoplePicker interface configuration

* feat: document Agent Marketplace configuration

* chore: better description for peoplePicker permissions

* feat: document fileStrategies configuration

* feat: document webSearch's firecrawlVersion addition and scraperType to scraperProvider refactor

* feat: document conversation file import limit env variable CONVERSATION_IMPORT_MAX_FILE_SIZE_BYTES

* feat: document modelSpecs group field configuration

* chore: fix formatting in peoplePicker interface markdown

* feat: add missing .env.example changes

* chore: formatting
2025-11-26 10:12:42 -05:00
Dustin Healy
39d7844bd7 feat: update promptCache documentation to include bedrock (anthropic models) (#442) 2025-11-25 09:23:29 -05:00
_juliettech
8b7de0cc6c docs: Known Custom Endpoint - Helicone (#444) 2025-11-25 09:23:03 -05:00
Danny Avila
4da57562c7 refactor: remove Code Interpreter API references from FooterMenu and meta files 2025-11-04 13:18:39 -05:00
Danny Avila
042d0eb812 🎉 feat: add Banner component (#435) 2025-11-04 11:50:24 -05:00
José Pedro Silva
cc3a6ce37a 📚 docs: Add support for users to be admins when logging in using OpenID (#398) 2025-10-09 03:51:51 -04:00
Danny Avila
a90b4c4ae3 docs: update changelog for v0.8.0 to include a link to the previous version v0.7.9 2025-10-01 17:47:47 -04:00
Danny Avila
888a9f1e8d docs: add changelog for v1.3.0 release with new features and configuration updates
- Introduced `context` capability for agents endpoint, enabling file uploads in chat.
- Enhanced `fileConfig` with OCR, text parsing, STT separation, and `fileTokenLimit` parameter.
- Added `transactions` object structure for token usage tracking.
- Included `jinaApiUrl` in `webSearch` configuration for custom Jina instances.
- Updated documentation for `fileConfig` to reflect new fields and processing methods.
2025-10-01 17:46:58 -04:00
Danny Avila
405137cc52 chore: update initial statistics for GitHub stars and Docker pulls in Usage component 2025-10-01 17:36:14 -04:00
Danny Avila
7416c3a720 feat: enhance TypeScript support and update configuration files
- Added type definitions for the BlogCard component props.
- Updated tsconfig.json to include new libraries and strict null checks.
- Modified next-env.d.ts to reference additional Next.js navigation types.
2025-10-01 17:36:00 -04:00