Danny Avila 1625166492 docs: v0.8.0-rc3 missing documentation (#401)
* docs: Enhance dotenv.mdx with MongoDB connection pool and schema configuration options

- Added new sections for MongoDB connection pool configuration, detailing options like MONGO_MAX_POOL_SIZE and MONGO_MIN_POOL_SIZE.
- Introduced MongoDB schema configuration options, including MONGO_AUTO_INDEX and MONGO_AUTO_CREATE.
- Provided usage examples and explanations for each new option to improve clarity and usability.

* docs: Add Microsoft Graph API integration details for Azure Entra ID

- Introduced new sections in dotenv.mdx and azure.mdx for Microsoft Graph API integration, enhancing permissions and sharing capabilities with people and group search features.
- Added prerequisites and configuration steps for enabling Graph API permissions in Azure app registration.
- Updated token-reuse.mdx to include information on Microsoft Graph API integration when using Azure Entra ID with token reuse.

* docs: Add OPENID_GENERATE_NONCE environment variable to dotenv.mdx

- Introduced the OPENID_GENERATE_NONCE variable, which forces the OpenID client to generate a nonce parameter, addressing requirements from identity providers like AWS Cognito and Authentik.
- Updated documentation to enhance clarity on its usage and importance in OpenID configurations.

* docs: Add SharePoint integration details and configuration instructions

- Introduced a new section in dotenv.mdx for SharePoint integration, detailing environment variables required for enabling the SharePoint file picker.
- Added comprehensive documentation in sharepoint.mdx covering the integration process, prerequisites, and user experience for accessing SharePoint files within LibreChat.
- Updated azure.mdx with additional information on SharePoint permissions needed for Azure app registration.
- Enhanced existing documentation to clarify the setup and usage of SharePoint features, ensuring users can effectively utilize this enterprise capability.

* docs: Add file citation configuration for agents endpoint in v1.2.9

- Introduced new file citation settings (`maxCitations`, `maxCitationsPerFile`, `minRelevanceScore`) to enhance control over citation quality and quantity in agent responses.
- Updated interface configuration to include `fileCitations`, enabling display of file citations during file search functionality.
- Added detailed documentation for the new configuration options in the changelog and relevant sections of the documentation.

* docs: Update fileCitations configuration details in v1.2.9

- Revised the description of the `fileCitations` setting to clarify its role as a global toggle for the `FILE_CITATIONS` permission, affecting all users regardless of individual permissions.
- Enhanced documentation in both the changelog and interface configuration sections to reflect these changes and improve user understanding of citation display behavior during file searches.

* docs: Add USE_REDIS_CLUSTER environment variable to Redis configuration

- Introduced the USE_REDIS_CLUSTER variable in dotenv.mdx to enable Redis cluster mode when using a single URI.
- Updated redis.mdx to include usage instructions for the new variable, enhancing clarity on Redis cluster configurations.

* chore: remove non-existant image reference

* chore: add missing code block language

* docs: Add migration instructions for agent permissions in v0.8.0-rc3+

- Introduced a new section detailing the migration to an ACL-based permission system for agents, including permission levels (OWNER, EDITOR, VIEWER).
- Provided step-by-step commands for running the migration based on different deployment methods (docker-compose, deploy-compose, local development).
- Explained the implications of the migration on existing agents and included a note on prompt permissions migration.
2025-08-27 00:50:36 -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
2025-02-20 14:43:12 -05: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
2024-05-10 02:42:16 -04:00
2024-05-09 17:09:13 -04:00

LibreChat Docs

Based on Nextra

Local Development

Pre-requisites: Node.js v20.19.0+ (or ^22.12.0 or >= 23.0.0), pnpm 9+

  1. Optional: Create env based on .env.template
  2. Run pnpm i to install the dependencies.
  3. Run pnpm dev to start the development server on localhost:3333
  4. Run pnpm build to build...
  5. Run pnpm start to start the production server on localhost:3333

⚠️ Note: try building prod before making a PR

Bundle analysis

Run pnpm run analyze to analyze the bundle size of the production build using @next/bundle-analyzer.

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