mirror of
https://github.com/danny-avila/LibreChat.git
synced 2025-09-22 06:00:56 +02:00
🧹📚 docs: refactor and clean up (#1392)
* 📑 update mkdocs * rename docker override file and add to gitignore * update .env.example - GOOGLE_MODELS * update index.md * doc refactor: split installation and configuration in two sub-folders * doc update: installation guides * doc update: configuration guides * doc: new docker override guide * doc: new beginner's guide for contributions - Thanks @Berry-13 * doc: update documentation_guidelines.md * doc: update testing.md * doc: update deployment guides * doc: update /dev readme * doc: update general_info * doc: add 0 value to doc weight * doc: add index.md to every doc folders * doc: add weight to index.md and move openrouter from free_ai_apis.md to ai_setup.md * doc: update toc so they display properly on the right had side in mkdocs * doc: update pandoranext.md * doc: index logging_system.md * doc: update readme.md * doc: update litellm.md * doc: update ./dev/readme.md * doc:🔖 new presets.md * doc: minor corrections * doc update: user_auth_system.md and presets.md, doc feat: add mermaid support to mkdocs * doc update: add screenshots to presets.md * doc update: add screenshots to - OpenID with AWS Cognito * doc update: BingAI cookie instruction * doc update: discord auth * doc update: facebook auth * doc: corrections to user_auth_system.md * doc update: github auth * doc update: google auth * doc update: auth clean up * doc organization: installation * doc organization: configuration * doc organization: features+plugins & update:plugins screenshots * doc organization: deploymend + general_info & update: tech_stack.md * doc organization: contributions * doc: minor fixes * doc: minor fixes
This commit is contained in:
Fuegovic
GitHub
parent
5c27fa304a
commit
51050cc4d3
66 changed files with 1617 additions and 869 deletions
|
|
@ -16,8 +16,6 @@
|
|||
APP_TITLE=LibreChat
|
||||
# CUSTOM_FOOTER="My custom footer"
|
||||
|
||||
DEBUG_LOGGING=true
|
||||
|
||||
HOST=localhost
|
||||
PORT=3080
|
||||
|
||||
|
|
@ -26,6 +24,12 @@ MONGO_URI=mongodb://127.0.0.1:27017/LibreChat
|
|||
DOMAIN_CLIENT=http://localhost:3080
|
||||
DOMAIN_SERVER=http://localhost:3080
|
||||
|
||||
#===============#
|
||||
# Debug Logging #
|
||||
#===============#
|
||||
DEBUG_LOGGING=true
|
||||
DEBUG_CONSOLE=false
|
||||
|
||||
#=============#
|
||||
# Permissions #
|
||||
#=============#
|
||||
|
|
@ -86,6 +90,7 @@ CHATGPT_MODELS=text-davinci-002-render-sha
|
|||
#============#
|
||||
|
||||
GOOGLE_KEY=user_provided
|
||||
# GOOGLE_MODELS=gemini-pro,gemini-pro-vision,chat-bison,chat-bison-32k,codechat-bison,codechat-bison-32k,text-bison,text-bison-32k,text-unicorn,code-gecko,code-bison,code-bison-32k
|
||||
# GOOGLE_REVERSE_PROXY=
|
||||
|
||||
#============#
|
||||
|
|
|
|||
1
.github/workflows/mkdocs.yaml
vendored
1
.github/workflows/mkdocs.yaml
vendored
|
|
@ -21,4 +21,5 @@ jobs:
|
|||
restore-keys: |
|
||||
mkdocs-material-
|
||||
- run: pip install mkdocs-material
|
||||
- run: pip install mkdocs-nav-weight
|
||||
- run: mkdocs gh-deploy --force
|
||||
|
|
|
|||
4
.gitignore
vendored
4
.gitignore
vendored
|
|
@ -71,6 +71,10 @@ config.local.ts
|
|||
**/storageState.json
|
||||
junit.xml
|
||||
|
||||
# docker override file
|
||||
docker-compose.override.yaml
|
||||
docker-compose.override.yml
|
||||
|
||||
# meilisearch
|
||||
meilisearch
|
||||
meilisearch.exe
|
||||
|
|
|
|||
102
README.md
102
README.md
|
|
@ -26,7 +26,7 @@
|
|||
</a>
|
||||
</p>
|
||||
|
||||
# Features
|
||||
# 📃 Features
|
||||
- 🖥️ UI matching ChatGPT, including Dark mode, Streaming, and 11-2023 updates
|
||||
- 💬 Multimodal Chat:
|
||||
- Upload and analyze images with GPT-4 and Gemini Vision 📸
|
||||
|
|
@ -46,7 +46,7 @@
|
|||
[For a thorough review of our features, see our docs here](https://docs.librechat.ai/features/plugins/introduction.html) 📚
|
||||
|
||||
|
||||
## All-In-One AI Conversations with LibreChat
|
||||
## 🪶 All-In-One AI Conversations with LibreChat
|
||||
LibreChat brings together the future of assistant AIs with the revolutionary technology of OpenAI's ChatGPT. Celebrating the original styling, LibreChat gives you the ability to integrate multiple AI models. It also integrates and enhances original client features such as conversation and message search, prompt templates and plugins.
|
||||
|
||||
With LibreChat, you no longer need to opt for ChatGPT Plus and can instead use free or pay-per-call APIs. We welcome contributions, cloning, and forking to enhance the capabilities of this advanced chatbot platform.
|
||||
|
|
@ -58,97 +58,20 @@ Click on the thumbnail to open the video☝️
|
|||
|
||||
---
|
||||
|
||||
## ⚠️ [Breaking Changes](docs/general_info/breaking_changes.md) ⚠️
|
||||
|
||||
**Please read this before updating from a previous version**
|
||||
## 📚 Documentation
|
||||
For more information on how to use our advanced features, install and configure our software, and access our guidelines and tutorials, please check out our documentation at [docs.librechat.ai](https://docs.librechat.ai)
|
||||
|
||||
---
|
||||
|
||||
## Changelog
|
||||
## 📝 Changelog
|
||||
Keep up with the latest updates by visiting the releases page - [Releases](https://github.com/danny-avila/LibreChat/releases)
|
||||
|
||||
---
|
||||
|
||||
<h1>Table of Contents</h1>
|
||||
|
||||
<details open>
|
||||
<summary><strong>Getting Started</strong></summary>
|
||||
|
||||
* Installation
|
||||
* [Docker Compose Install🐳](docs/install/docker_compose_install.md)
|
||||
* [Linux Install🐧](docs/install/linux_install.md)
|
||||
* [Mac Install🍎](docs/install/mac_install.md)
|
||||
* [Windows Install💙](docs/install/windows_install.md)
|
||||
* Configuration
|
||||
* [.env Configuration](./docs/install/dotenv.md)
|
||||
* [AI Setup](docs/install/ai_setup.md)
|
||||
* [User Auth System](docs/install/user_auth_system.md)
|
||||
* [Online MongoDB Database](docs/install/mongodb.md)
|
||||
* [Default Language](docs/install/default_language.md)
|
||||
* [LiteLLM Proxy: Load Balance LLMs + Spend Tracking](docs/install/litellm.md)
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary><strong>General Information</strong></summary>
|
||||
|
||||
* [Code of Conduct](.github/CODE_OF_CONDUCT.md)
|
||||
* [Project Origin](docs/general_info/project_origin.md)
|
||||
* [Multilingual Information](docs/general_info/multilingual_information.md)
|
||||
* [Tech Stack](docs/general_info/tech_stack.md)
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary><strong>Features</strong></summary>
|
||||
|
||||
* **Plugins**
|
||||
* [Introduction](docs/features/plugins/introduction.md)
|
||||
* [Google](docs/features/plugins/google_search.md)
|
||||
* [Stable Diffusion](docs/features/plugins/stable_diffusion.md)
|
||||
* [Wolfram](docs/features/plugins/wolfram.md)
|
||||
* [Make Your Own Plugin](docs/features/plugins/make_your_own.md)
|
||||
* [Using official ChatGPT Plugins](docs/features/plugins/chatgpt_plugins_openapi.md)
|
||||
|
||||
|
||||
* [Automated Moderation](docs/features/mod_system.md)
|
||||
* [Token Usage](docs/features/token_usage.md)
|
||||
* [Manage Your Database](docs/features/manage_your_database.md)
|
||||
* [PandoraNext Deployment Guide](docs/features/pandoranext.md)
|
||||
* [Third-Party Tools](docs/features/third_party.md)
|
||||
* [Proxy](docs/features/proxy.md)
|
||||
* [Bing Jailbreak](docs/features/bing_jailbreak.md)
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary><strong>Cloud Deployment</strong></summary>
|
||||
|
||||
* [DigitalOcean](docs/deployment/digitalocean.md)
|
||||
* [Azure](docs/deployment/azure-terraform.md)
|
||||
* [Linode](docs/deployment/linode.md)
|
||||
* [Cloudflare](docs/deployment/cloudflare.md)
|
||||
* [Ngrok](docs/deployment/ngrok.md)
|
||||
* [HuggingFace](docs/deployment/huggingface.md)
|
||||
* [Render](docs/deployment/render.md)
|
||||
* [Meilisearch in Render](docs/deployment/meilisearch_in_render.md)
|
||||
* [Hetzner](docs/deployment/hetzner_ubuntu.md)
|
||||
* [Heroku](docs/deployment/heroku.md)
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary><strong>Contributions</strong></summary>
|
||||
|
||||
* [Contributor Guidelines](.github/CONTRIBUTING.md)
|
||||
* [Documentation Guidelines](docs/contributions/documentation_guidelines.md)
|
||||
* [Contribute a Translation](docs/contributions/translation_contribution.md)
|
||||
* [Code Standards and Conventions](docs/contributions/coding_conventions.md)
|
||||
* [Testing](docs/contributions/testing.md)
|
||||
* [Security](.github/SECURITY.md)
|
||||
* [Project Roadmap](https://github.com/users/danny-avila/projects/2)
|
||||
</details>
|
||||
**⚠️ [Breaking Changes](docs/general_info/breaking_changes.md)**
|
||||
Please consult the breaking changes before updating.
|
||||
|
||||
---
|
||||
|
||||
## Star History
|
||||
## ⭐ Star History
|
||||
|
||||
<a href="https://star-history.com/#danny-avila/LibreChat&Date">
|
||||
<img alt="Star History Chart" src="https://api.star-history.com/svg?repos=danny-avila/LibreChat&type=Date&theme=dark" onerror="this.src='https://api.star-history.com/svg?repos=danny-avila/LibreChat&type=Date'" />
|
||||
|
|
@ -156,15 +79,14 @@ Keep up with the latest updates by visiting the releases page - [Releases](https
|
|||
|
||||
---
|
||||
|
||||
## Contributors
|
||||
Contributions and suggestions bug reports and fixes are welcome!
|
||||
Please read the documentation before you do!
|
||||
## ✨ Contributions
|
||||
Contributions, suggestions, bug reports and fixes are welcome!
|
||||
|
||||
For new features, components, or extensions, please open an issue and discuss before sending a PR.
|
||||
|
||||
- Join the [Discord community](https://discord.gg/uDyZ5Tzhct)
|
||||
---
|
||||
|
||||
This project exists in its current state thanks to all the people who contribute
|
||||
💖 This project exists in its current state thanks to all the people who contribute
|
||||
---
|
||||
<a href="https://github.com/danny-avila/LibreChat/graphs/contributors">
|
||||
<img src="https://contrib.rocks/image?repo=danny-avila/LibreChat" />
|
||||
|
|
|
|||
|
|
@ -1,3 +1,7 @@
|
|||
---
|
||||
title: 🧑💻 Code Standards and Conventions
|
||||
weight: -7
|
||||
---
|
||||
# Coding Conventions
|
||||
|
||||
## Node.js API Server
|
||||
|
|
|
|||
|
|
@ -1,28 +1,40 @@
|
|||
---
|
||||
title: 📝 Documentation Guidelines
|
||||
weight: -9
|
||||
---
|
||||
# Documentation Guidelines
|
||||
|
||||
This document explains how to write and format documentation for LibreChat.
|
||||
|
||||
## New Documents
|
||||
- Use lowercase letters and underscores to name new documents (e.g. `documentation_guidelines.md`).
|
||||
- For new features, create new documentation and place it in the relevant folder/sub-folder under [docs](../docs/).
|
||||
- If the feature adds new functionality, add it to the feature section of the main [README.md](../../README.md).
|
||||
- When you create a new document, **add it to both table of contents:**
|
||||
- [README.md](../../README.md)
|
||||
- [mkdocs.yml](../../mkdocs.yml)
|
||||
- For new features, create new documentation and place it in the relevant folder/sub-folder under `../docs`.
|
||||
- If the feature adds new functionality, add it to the feature section of the main `README.md` as well as in `../docs/index.md`.
|
||||
- When you create a new document, **you need to add it to two table of contents:**
|
||||
- in `README.md`
|
||||
- and in the `index.md` file in the folder where your doc is located
|
||||
|
||||
## Formatting
|
||||
## Markdown Formatting
|
||||
- Use `#`, `##`, and `###` for headings and subheadings.
|
||||
- Use `#` for the title of the document.
|
||||
- Use `##` for the main sections of the document.
|
||||
- Use `###` for the sub-sections within a section.
|
||||
- Use `**` to make text bold to highlight important information (not in place of a heading).
|
||||
- Use `**` to make text **bold** to highlight important information (do not use in place of a heading).
|
||||
- Use relative paths for links to other documents.
|
||||
- You can use HTML to add more features to a document.
|
||||
- By default the title indexed by mkdocs will be the first heading. You can override this by adding metadata at the top of your document:
|
||||
```bash
|
||||
---
|
||||
title: Document Title
|
||||
weight: 0
|
||||
---
|
||||
```
|
||||
- Setting the weight in the document metadata will influence its position in the table of contents. Lowest weight are placed first. Not setting it will default to `0`. When multiple docs have the same weight it sorts in alphabetical order.
|
||||
|
||||
## Important Notes
|
||||
- **⚠️Keep it organized and structured⚠️**
|
||||
- Do not add unrelated information to an existing document. Create a new one if needed.
|
||||
- All assets should be uploaded in the document from GitHub's webui:
|
||||
- All assets should be uploaded in the document from GitHub's webui
|
||||
- **Before submitting a PR, double-check on GitHub that everything is properly displayed and that all links work correctly.**
|
||||
|
||||
|
||||
|
|
|
|||
66
docs/contributions/how_to_contribute.md
Normal file
66
docs/contributions/how_to_contribute.md
Normal file
|
|
@ -0,0 +1,66 @@
|
|||
---
|
||||
title: 🙌 Beginner's Guide to Contributions
|
||||
weight: -10
|
||||
---
|
||||
# How to Contribute in a Quick and Easy Way
|
||||
|
||||
## Installation of Tools
|
||||
|
||||
1. [Git](https://git-scm.com/downloads) is essential, the first thing to download.
|
||||
2. [Git LFS](https://git-lfs.com/) can be useful for uploading files with larger sizes.
|
||||
3. [Github Desktop](https://desktop.github.com/) - I use it only for UI; I don't recommend using it for pushing or other actions.
|
||||
|
||||
## How to Use?
|
||||
|
||||
This will be a somewhat raw text, but I'll try to be as clear as possible.
|
||||
|
||||
I recommend installing the following extensions in VS Code:
|
||||
|
||||
- [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)
|
||||
- [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
|
||||
- [GitLens](https://marketplace.visualstudio.com/items?itemName=eamodio.gitlens)
|
||||
|
||||
### Example of a Pull Request (PR)
|
||||
|
||||
Let's say I want to add another page for an API Panel.
|
||||
|
||||
1. Open GitHub and select Danny's fork.
|
||||
2. First, make sure that the main branch is clean with no commits and up to date.
|
||||
|
||||
3. Open "View all my branches" and create a new branch with a descriptive name for your task. For example: "ApiPanel."
|
||||
4. In GitHub Desktop, select the branch you just created.
|
||||
|
||||
5. Start modifying the code, and when you finish a part, commit the changes.
|
||||
Example of commits:
|
||||
- commit1: Created the frontend
|
||||
- commit2: Fixed a bug in variable export
|
||||
- commit3: Removed unnecessary comments and added translation support
|
||||
- and so on...
|
||||
|
||||
## Testing
|
||||
|
||||
While testing the code, if you're working with the frontend, it might be frustrating to run `npm run frontend` and `npm run backend` every time. Instead, use `npm run frontend:dev` to see real-time changes on port 3090 (really!).
|
||||
|
||||
> Note: You must run `npm run frontend` once before you can use `npm run frontend:dev`
|
||||
|
||||
### How?
|
||||
|
||||
- `git add *` adds all files to be committed.
|
||||
- `git commit -m "name-of-your-commit"` creates a commit.
|
||||
- `git push` uploads the changes.
|
||||
|
||||
Before doing all this, I recommend using GitHub Desktop to see what you've changed.
|
||||
|
||||
|
||||
If `git commit` fails due to ESLint errors, read the error message and understand what's wrong. It could be an unused variable or other issues.
|
||||
|
||||
### Possible Various Problems
|
||||
|
||||
If you have the main branch with many commits and don't know what to do, follow this simple guide:
|
||||
|
||||
⚠️ Please do this only when you have no active PRs or when you're not working on the project:
|
||||
|
||||
1. Do a pull origin and in the terminal write `git log` to identify how many commits you are behind.
|
||||
2. Use `git rebase -i HEAD~2`, where 2 represents the number of commits you need to go back. If you need to go back 100 commits, use `git rebase -i HEAD~100`.
|
||||
3. In the editor, change the "pick" for the two commits to "drop," save with "esc," then type `:wq` and press "Enter."
|
||||
4. Finally, run `git push --force origin main`.
|
||||
14
docs/contributions/index.md
Normal file
14
docs/contributions/index.md
Normal file
|
|
@ -0,0 +1,14 @@
|
|||
---
|
||||
title: Contributing to LibreChat
|
||||
weight: 5
|
||||
---
|
||||
# Contributing to LibreChat
|
||||
|
||||
* 🙌 [Beginner's Guide to Contributions](./how_to_contribute.md)
|
||||
* 🚸 [Contributor Guidelines](https://github.com/danny-avila/LibreChat/blob/main/.github/CONTRIBUTING.md)
|
||||
* 📝 [Documentation Guidelines](documentation_guidelines.md)
|
||||
* 🌍 [Contribute a Translation](translation_contribution.md)
|
||||
* 🧑💻 [Code Standards and Conventions](coding_conventions.md)
|
||||
* 🧪 [Testing During Development](testing.md)
|
||||
* 🔐 [Security](https://github.com/danny-avila/LibreChat/blob/main/.github/SECURITY.md)
|
||||
* 🛣️ [Project Roadmap](https://github.com/users/danny-avila/projects/2)
|
||||
|
|
@ -1,60 +1,22 @@
|
|||
---
|
||||
title: 🧪 Testing During Development
|
||||
weight: -6
|
||||
---
|
||||
|
||||
# Locally test the app during development
|
||||
|
||||
### Run the app
|
||||
## WIP
|
||||
|
||||
#### Option 1: Run the app using Docker
|
||||
## Run the tests
|
||||
|
||||
For reproducibility and ease of use, you can use
|
||||
the provided docker-compose file:
|
||||
|
||||
1. Comment out the portion pointing at the already built image
|
||||
|
||||
```yaml
|
||||
image: chatgptclone/app:0.3.3
|
||||
```
|
||||
|
||||
2. Uncomment the portion pointing at the local source code
|
||||
|
||||
```yaml
|
||||
# image: node-api
|
||||
# build:
|
||||
# context: .
|
||||
# target: node-api
|
||||
```
|
||||
|
||||
3. Build your local source code for the `node-api` target
|
||||
|
||||
```shell
|
||||
docker build `
|
||||
--target=node-api `
|
||||
-t node-api `
|
||||
.
|
||||
```
|
||||
|
||||
4. Docker-compose up
|
||||
|
||||
```shell
|
||||
docker-compose up
|
||||
```
|
||||
|
||||
#### Option 2: Run the app by installing on your machine
|
||||
|
||||
1. Install the prerequisites on your machine.
|
||||
See [section above](#install-the-prerequisites-on-your-machine).
|
||||
|
||||
2. Run the app on your machine.
|
||||
See [section above](#run-the-app).
|
||||
|
||||
### Run the tests
|
||||
|
||||
1. Install the global dependencies
|
||||
#### 1. Install the global dependencies
|
||||
|
||||
```shell
|
||||
npm ci
|
||||
npx playwright install --with-deps
|
||||
```
|
||||
|
||||
2. Run tests
|
||||
#### 2. Run tests
|
||||
|
||||
```shell
|
||||
npx playwright test
|
||||
|
|
|
|||
|
|
@ -1,3 +1,7 @@
|
|||
---
|
||||
title: 🌍 Contribute a Translation
|
||||
weight: -8
|
||||
---
|
||||
# How to add a new language to LibreChat 🌍
|
||||
|
||||
## Minimum Requirements:
|
||||
|
|
|
|||
|
|
@ -1,3 +1,7 @@
|
|||
---
|
||||
title: ⚡ Azure
|
||||
weight: -6
|
||||
---
|
||||
# Azure deployment
|
||||
|
||||
There are different ways of how a deployment can be done in Azure.
|
||||
|
|
|
|||
|
|
@ -1,3 +1,7 @@
|
|||
---
|
||||
title: ☁️ Cloudflare
|
||||
weight: -7
|
||||
---
|
||||
<img src="https://github.com/danny-avila/LibreChat/assets/32828263/cfbc7ca5-b51e-4f1d-aa89-b9b4cb13eead" width="350">
|
||||
|
||||
# Cloudflare
|
||||
|
|
|
|||
|
|
@ -1,3 +1,7 @@
|
|||
---
|
||||
title: 🌊 DigitalOcean ✨(Recommended)
|
||||
weight: -10
|
||||
---
|
||||
# Digital Ocean (Ubuntu/Docker) Setup
|
||||
|
||||
>These instructions are designed for someone starting from scratch for a Docker Installation on a remote Ubuntu server. You can skip to any point that is useful for you. There are probably more efficient/scalable ways, but this guide works really great for my personal use case.
|
||||
|
|
@ -334,8 +338,8 @@ ALLOW_REGISTRATION=false
|
|||
```
|
||||
|
||||
**Resources:**
|
||||
- [Tokens/Apis/etc](../install/ai_setup.md)
|
||||
- [User/Auth System](../install/user_auth_system.md)
|
||||
- [Tokens/Apis/etc](../install/configuration/ai_setup.md)
|
||||
- [User/Auth System](../install/configuration/user_auth_system.md)
|
||||
|
||||
### **3. Start docker, and then run the installation/update script**
|
||||
|
||||
|
|
|
|||
|
|
@ -1,3 +1,7 @@
|
|||
---
|
||||
title: 🌈 Heroku
|
||||
weight: -1
|
||||
---
|
||||
# Heroku Deployment
|
||||
|
||||
*To run LibreChat on a server, you can use cloud hosting platforms like Heroku, DigitalOcean, or AWS. In this response, I'll provide instructions for deploying the project on Heroku. Other platforms will have slightly different deployment processes.*
|
||||
|
|
|
|||
|
|
@ -1,3 +1,7 @@
|
|||
---
|
||||
title: 🏗️ Hetzner
|
||||
weight: -2
|
||||
---
|
||||
# Hetzner Ubuntu Setup
|
||||
|
||||
*These instructions are designed for someone starting from scratch for a Ubuntu Installation. You can skip to any point that is useful for you.*
|
||||
|
|
@ -68,9 +72,11 @@ sudo reboot
|
|||
|
||||
## Tokens/Apis/etc:
|
||||
- Make sure you have all the needed variables for the following before moving forward
|
||||
### [Setup your AI Endpoints](../install/ai_setup.md) (Required)
|
||||
|
||||
### [Setup your AI Endpoints](../install/configuration/ai_setup.md) (Required)
|
||||
- At least one AI endpoint should be setup for use.
|
||||
### [User/Auth System](../install/user_auth_system.md) (Optional)
|
||||
### [User/Auth System](../install/configuration/user_auth_system.md) (Optional)
|
||||
|
||||
- How to set up the user/auth system and Google login.
|
||||
### [Plugins](../features/plugins/introduction.md)
|
||||
- Optional plugins available to enhance the application.
|
||||
|
|
@ -79,7 +85,7 @@ sudo reboot
|
|||
|
||||
## Using Docker to Install the Service
|
||||
|
||||
### 1. **Recommended: [Docker Install](../install/docker_compose_install.md)**
|
||||
### 1. **Recommended: [Docker Install](../install/installation/docker_compose_install.md)**
|
||||
From the *server* commandline (as your user, not root):
|
||||
|
||||
```
|
||||
|
|
|
|||
|
|
@ -1,3 +1,7 @@
|
|||
---
|
||||
title: 🤗 HuggingFace
|
||||
weight: -9
|
||||
---
|
||||
# Hugging Face Deployment 🤗
|
||||
|
||||
>#### ⚠️ Note - Some features are not supported by HuggingFace:
|
||||
|
|
@ -11,7 +15,7 @@
|
|||
|
||||
The first thing you need is to create a MongoDB Atlas Database and get your connection string.
|
||||
|
||||
Follow the instructions in this document: [Online MongoDB Database](../install/mongodb.md)
|
||||
Follow the instructions in this document: [Online MongoDB Database](../install/configuration/mongodb.md)
|
||||
|
||||
## Getting Started
|
||||
|
||||
|
|
|
|||
17
docs/deployment/index.md
Normal file
17
docs/deployment/index.md
Normal file
|
|
@ -0,0 +1,17 @@
|
|||
---
|
||||
title: Deployment
|
||||
weight: 3
|
||||
---
|
||||
|
||||
# Deployment
|
||||
|
||||
* 🌊 [DigitalOcean (✨Recommended)](digitalocean.md)
|
||||
* 🤗 [HuggingFace](huggingface.md)
|
||||
* 🐧 [Linode](linode.md)
|
||||
* ☁️ [Cloudflare](cloudflare.md)
|
||||
* ⚡ [Azure](azure-terraform.md)
|
||||
* 🪨 [Ngrok](ngrok.md)
|
||||
* ⏹️ [Render](render.md)
|
||||
* 🔎 [Meilisearch in Render](meilisearch_in_render.md)
|
||||
* 🏗️ [Hetzner](hetzner_ubuntu.md)
|
||||
* 🌈 [Heroku](heroku.md)
|
||||
|
|
@ -1,3 +1,7 @@
|
|||
---
|
||||
title: 🐧 Linode
|
||||
weight: -8
|
||||
---
|
||||
<img src="https://github.com/danny-avila/LibreChat/assets/32828263/d6e430db-518a-4779-83d3-a2d177907df1" width="250">
|
||||
|
||||
# Linode
|
||||
|
|
@ -21,7 +25,7 @@
|
|||
sudo apt update
|
||||
sudo apt install docker.io && apt install docker-compose
|
||||
```
|
||||
## [Install LibreChat](../install/docker_compose_install.md)
|
||||
## [Install LibreChat](../install/installation/docker_compose_install.md)
|
||||
|
||||
## Install and Setup NGINX Proxy Manager:
|
||||
|
||||
|
|
|
|||
|
|
@ -1,3 +1,7 @@
|
|||
---
|
||||
title: 🔎 Meilisearch in Render
|
||||
weight: -3
|
||||
---
|
||||
# Utilize Meilisearch by running LibreChat on Render
|
||||
|
||||
## Create a new account or a new project on Render
|
||||
|
|
|
|||
|
|
@ -1,3 +1,7 @@
|
|||
---
|
||||
title: 🪨 Ngrok
|
||||
weight: -5
|
||||
---
|
||||
# Ngrok Installation
|
||||
|
||||
To use Ngrok for tunneling your local server to the internet, follow these steps:
|
||||
|
|
|
|||
|
|
@ -1,3 +1,7 @@
|
|||
---
|
||||
title: ⏹️ Render
|
||||
weight: -4
|
||||
---
|
||||
# Render Deployment
|
||||
|
||||
## Note:
|
||||
|
|
@ -78,7 +82,7 @@ Also:
|
|||
|
||||
The last thing you need is to create a MongoDB Atlas Database and get your connection string.
|
||||
|
||||
Follow the instructions in this document: [Online MongoDB Database](../install/mongodb.md)
|
||||
Follow the instructions in this document: [Online MongoDB Database](../install/configuration/mongodb.md)
|
||||
|
||||
## Complete the Environment Variables configuration
|
||||
|
||||
|
|
|
|||
|
|
@ -1,13 +1,23 @@
|
|||
# Dev
|
||||
This directory contains files used for developer work
|
||||
---
|
||||
title: Dev Resources
|
||||
weight: 6
|
||||
---
|
||||
|
||||
### Dockerfile-app:
|
||||
- used to build the DockerHub image
|
||||
### eslintrc-stripped.js:
|
||||
# Dev Resources
|
||||
Please consult: [Contributing to LibreChat](../contributions/index.md) for more information on the subject.
|
||||
|
||||
This directory: [./docs/dev](https://github.com/danny-avila/LibreChat/tree/main/docs/dev), contains files used for developer work.
|
||||
|
||||
#### `Dockerfile-app`
|
||||
- used to build the DockerHub image
|
||||
|
||||
#### `eslintrc-stripped.js`
|
||||
- alternate linting rules, used in development
|
||||
### meilisearch.yml:
|
||||
|
||||
#### `meilisearch.yml`
|
||||
- Dockerfile for building meilisearch image independently from project
|
||||
### single-compose.yml:
|
||||
|
||||
#### `single-compose.yml`
|
||||
- Dockerfile for building app image without meilisearch and mongodb services
|
||||
- This is useful for deploying on Google, Azure, etc., as a single, leaner container.
|
||||
- From root dir of the project, run `docker-compose -f ./docs/dev/single-compose.yml up --build`
|
||||
|
|
@ -15,7 +25,8 @@ This directory contains files used for developer work
|
|||
- This requires you use a MongoDB Atlas connection string for the `MONGO_URI` env var
|
||||
- A URI string to a mongodb service accessible to your container is also possible.
|
||||
- Remote Meilisearch may also be possible in the same manner, but is not tested.
|
||||
### deploy-compose.yml:
|
||||
|
||||
#### `deploy-compose.yml`
|
||||
- Similar to above, but with basic configuration for deployment to a cloud provider where multi-container compose works
|
||||
- Tested and working on a $6 droplet on DigitalOcean, just by visiting the http://server-ip/9000.
|
||||
- Not a scalable solution, but ideal for quickly hosting on a remote linux server.
|
||||
|
|
|
|||
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: 😈 Bing Jailbreak
|
||||
weight: -3
|
||||
---
|
||||
|
||||
# Bing Jailbreak
|
||||
|
||||
|
||||
|
|
|
|||
31
docs/features/index.md
Normal file
31
docs/features/index.md
Normal file
|
|
@ -0,0 +1,31 @@
|
|||
---
|
||||
title: Features
|
||||
weight: 2
|
||||
---
|
||||
|
||||
# Features
|
||||
|
||||
---
|
||||
|
||||
* 🔌[Plugins](./plugins/index.md)
|
||||
* 🔌 [Introduction](./plugins/introduction.md)
|
||||
* 🛠️ [Make Your Own](./plugins/make_your_own.md)
|
||||
* 🧑💼 [Official ChatGPT Plugins](./plugins/chatgpt_plugins_openapi.md)
|
||||
* 🔎 [Google Search](./plugins/google_search.md)
|
||||
* 🖌️ [Stable Diffusion](./plugins/stable_diffusion.md)
|
||||
* 🧠 [Wolfram|Alpha](./plugins/wolfram.md)
|
||||
* ⚡ [Azure AI Search](./plugins/azure_ai_search.md)
|
||||
* 🔖 [Presets](./presets.md)
|
||||
|
||||
---
|
||||
|
||||
* 🔨 [Automated Moderation](./mod_system.md)
|
||||
* 🪙 [Token Usage](./token_usage.md)
|
||||
* 🍃 [Manage Your Database](./manage_your_database.md)
|
||||
* 🪵 [Logging System](./logging_system.md)
|
||||
* 📦 [PandoraNext](./pandoranext.md)
|
||||
* 😈 [Bing Jailbreak](./bing_jailbreak.md)
|
||||
|
||||
---
|
||||
|
||||
* ✨ [Third-Party Tools and Contributions](./third_party.md)
|
||||
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: 🪵 Logging System
|
||||
weight: -5
|
||||
---
|
||||
|
||||
### General
|
||||
|
||||
LibreChat has central logging built into its backend (api).
|
||||
|
|
|
|||
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: 🍃 Manage Your Database
|
||||
weight: -6
|
||||
---
|
||||
|
||||
<img src="https://github.com/danny-avila/LibreChat/assets/32828263/4572dd35-8489-4cb1-a968-4fb5a871d6e5" height="50">
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -1,3 +1,7 @@
|
|||
---
|
||||
title: 🔨 Automated Moderation
|
||||
weight: -8
|
||||
---
|
||||
## Automated Moderation System (optional)
|
||||
The Automated Moderation System uses a scoring mechanism to track user violations. As users commit actions like excessive logins, registrations, or messaging, they accumulate violation scores. Upon reaching a set threshold, the user and their IP are temporarily banned. This system ensures platform security by monitoring and penalizing rapid or suspicious activities.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: 📦 PandoraNext
|
||||
weight: -4
|
||||
---
|
||||
|
||||
# PandoraNext Deployment Guide
|
||||
|
||||
If you're looking to use the `ChatGPT` Endpoint in LibreChat, setting up a reverse proxy is a essential. PandoraNext offers a robust solution for this purpose. This guide will walk you through deploying PandoraNext to enable the `CHATGPT_REVERSE_PROXY` for use with LibreChat.
|
||||
|
|
@ -6,103 +11,22 @@ If you're looking to use the `ChatGPT` Endpoint in LibreChat, setting up a rever
|
|||
|
||||
You can use it locally in docker or deploy it onthe web for remote access.
|
||||
|
||||
## Deploy Online by Duplicating Hugging Face Space
|
||||
|
||||
To deploy PandoraNext online by duplicating the Hugging Face Space, follow these steps:
|
||||
|
||||
1. Get your PandoraNext license id here: [PandoraNext Dashboard](https://dash.pandoranext.com/)
|
||||
|
||||
2. **Configure `config.json`:**
|
||||
Edit the following `config.json`. Specify your `license_id` and `proxy_api_prefix`. For the `proxy_api_prefix`, use at least 8 characters, avoid characters that can't be used in a URL and make sure it's unique.
|
||||
|
||||
Here's the `config.json` for your reference:
|
||||
|
||||
```json
|
||||
{
|
||||
"bind": "0.0.0.0:8181",
|
||||
"tls": {
|
||||
"enabled": false,
|
||||
"cert_file": "",
|
||||
"key_file": ""
|
||||
},
|
||||
"timeout": 600,
|
||||
"proxy_url": "",
|
||||
"license_id": "",
|
||||
"public_share": false,
|
||||
"site_password": "",
|
||||
"setup_password": "",
|
||||
"server_tokens": true,
|
||||
"proxy_api_prefix": "",
|
||||
"isolated_conv_title": "*",
|
||||
"captcha": {
|
||||
"provider": "",
|
||||
"site_key": "",
|
||||
"site_secret": "",
|
||||
"site_login": false,
|
||||
"setup_login": false,
|
||||
"oai_username": false,
|
||||
"oai_password": false
|
||||
},
|
||||
"whitelist": null
|
||||
}
|
||||
```
|
||||
|
||||
3. **Hugging Face Space:**
|
||||
Visit the [PandoraNext LibreChat Space](https://huggingface.co/spaces/LibreChat/PandoraNext) on Hugging Face.
|
||||
|
||||
4. **Duplicate the Space:**
|
||||
Utilize the available options to duplicate or fork the space into your own Hugging Face account.
|
||||
|
||||
5. **Fill the required secrets**
|
||||
When asked for the `SECRETS`,
|
||||
- for `CONFIG_JSON` use the whole content of the `config.json` you just modified,
|
||||
- for `TOKENS_JSON` use the following default `token.json`:
|
||||
```json
|
||||
{
|
||||
"test-1": {
|
||||
"token": "access token / session token / refresh token",
|
||||
"shared": true,
|
||||
"show_user_info": false
|
||||
},
|
||||
"test-2": {
|
||||
"token": "access token / session token / refresh token",
|
||||
"shared": true,
|
||||
"show_user_info": true,
|
||||
"plus": true
|
||||
},
|
||||
"test2": {
|
||||
"token": "access token / session token / refresh token / share token",
|
||||
"password": "12345"
|
||||
}
|
||||
}
|
||||
```
|
||||
6. **Configure LibreChat:**
|
||||
In the .env file (or secrets settings if you host LibreChat on Hugging Face), set the `CHATGPT_REVERSE_PROXY` variable using the following format:
|
||||
|
||||
```bash
|
||||
CHATGPT_REVERSE_PROXY=http://your_server_domain.com/your_proxy_api_prefix_here/backend-api/conversation
|
||||
```
|
||||
|
||||
- Replace `your_server_domain.com` with the domain of your deployed space.
|
||||
- you can use this format: `https://username-pandoranext.hf.space` (replace `username` with your Huggingface username)
|
||||
- Replace `your_proxy_api_prefix_here` with the `proxy_api_prefix` you have set in your `config.json`.
|
||||
- The resulting URL should look similar to:
|
||||
`https://username-pandoranext.hf.space/your_proxy_api_prefix_here/backend-api/conversation`
|
||||
---
|
||||
|
||||
## Deploy Locally Using Docker
|
||||
|
||||
For local deployment using Docker, the steps are as follows:
|
||||
|
||||
1. **Clone or Download the Repository:**
|
||||
### 1. **Clone or Download the Repository:**
|
||||
Get the latest release from the [PandoraNext GitHub repository](https://github.com/pandora-next/deploy).
|
||||
|
||||
```bash
|
||||
git clone https://github.com/pandora-next/deploy.git
|
||||
```
|
||||
|
||||
2. Get your PandoraNext license id here: [PandoraNext Dashboard](https://dash.pandoranext.com/)
|
||||
### 2. Get your PandoraNext license id here: [PandoraNext Dashboard](https://dash.pandoranext.com/)
|
||||
|
||||
3. **Configure `config.json`:**
|
||||
### 3. **Configure `config.json`:**
|
||||
Within the cloned repository, in the `data` folder, edit `config.json`. Specify your `license_id` and `proxy_api_prefix`. For the `proxy_api_prefix`, use at least 8 characters, avoid characters that can't be used in a URL and make sure it's unique.
|
||||
|
||||
Here's the `config.json` for your reference:
|
||||
|
|
@ -137,7 +61,7 @@ For local deployment using Docker, the steps are as follows:
|
|||
}
|
||||
```
|
||||
|
||||
4. **Set Up the LibreChat `.env` Filer:**
|
||||
### 4. **Set Up the LibreChat `.env` Filer:**
|
||||
In the `.env` file within your LibreChat directory, you'll need to set the `CHATGPT_REVERSE_PROXY` variable:
|
||||
|
||||
```bash
|
||||
|
|
@ -145,13 +69,99 @@ For local deployment using Docker, the steps are as follows:
|
|||
```
|
||||
- Replace `your_proxy_api_prefix_here` with the actual proxy API prefix.
|
||||
|
||||
4. **Start Docker Containers:**
|
||||
### 5. **Start Docker Containers:**
|
||||
From the PandoraNext directory, run the following command to launch the Docker containers:
|
||||
|
||||
```bash
|
||||
docker-compose up -d
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Deploy Online on Hugging Face
|
||||
|
||||
To deploy PandoraNext online by duplicating the Hugging Face Space, follow these steps:
|
||||
|
||||
### 1. Get your PandoraNext license id here: [PandoraNext Dashboard](https://dash.pandoranext.com/)
|
||||
|
||||
### 2. **Configure `config.json`:**
|
||||
Edit the following `config.json`. Specify your `license_id` and `proxy_api_prefix`. For the `proxy_api_prefix`, use at least 8 characters, avoid characters that can't be used in a URL and make sure it's unique.
|
||||
|
||||
Here's the `config.json` for your reference:
|
||||
|
||||
```json
|
||||
{
|
||||
"bind": "0.0.0.0:8181",
|
||||
"tls": {
|
||||
"enabled": false,
|
||||
"cert_file": "",
|
||||
"key_file": ""
|
||||
},
|
||||
"timeout": 600,
|
||||
"proxy_url": "",
|
||||
"license_id": "",
|
||||
"public_share": false,
|
||||
"site_password": "",
|
||||
"setup_password": "",
|
||||
"server_tokens": true,
|
||||
"proxy_api_prefix": "",
|
||||
"isolated_conv_title": "*",
|
||||
"captcha": {
|
||||
"provider": "",
|
||||
"site_key": "",
|
||||
"site_secret": "",
|
||||
"site_login": false,
|
||||
"setup_login": false,
|
||||
"oai_username": false,
|
||||
"oai_password": false
|
||||
},
|
||||
"whitelist": null
|
||||
}
|
||||
```
|
||||
|
||||
### 3. **Hugging Face Space:**
|
||||
Visit the [PandoraNext LibreChat Space](https://huggingface.co/spaces/LibreChat/PandoraNext) on Hugging Face.
|
||||
|
||||
### 4. **Duplicate the Space:**
|
||||
Utilize the available options to duplicate or fork the space into your own Hugging Face account.
|
||||
|
||||
### 5. **Fill the required secrets**
|
||||
When asked for the `SECRETS`,
|
||||
- for `CONFIG_JSON` use the whole content of the `config.json` you just modified,
|
||||
- for `TOKENS_JSON` use the following default `token.json`:
|
||||
```json
|
||||
{
|
||||
"test-1": {
|
||||
"token": "access token / session token / refresh token",
|
||||
"shared": true,
|
||||
"show_user_info": false
|
||||
},
|
||||
"test-2": {
|
||||
"token": "access token / session token / refresh token",
|
||||
"shared": true,
|
||||
"show_user_info": true,
|
||||
"plus": true
|
||||
},
|
||||
"test2": {
|
||||
"token": "access token / session token / refresh token / share token",
|
||||
"password": "12345"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 6. **Configure LibreChat:**
|
||||
In the .env file (or secrets settings if you host LibreChat on Hugging Face), set the `CHATGPT_REVERSE_PROXY` variable using the following format:
|
||||
|
||||
```bash
|
||||
CHATGPT_REVERSE_PROXY=http://your_server_domain.com/your_proxy_api_prefix_here/backend-api/conversation
|
||||
```
|
||||
|
||||
- Replace `your_server_domain.com` with the domain of your deployed space.
|
||||
- you can use this format: `https://username-pandoranext.hf.space` (replace `username` with your Huggingface username)
|
||||
- Replace `your_proxy_api_prefix_here` with the `proxy_api_prefix` you have set in your `config.json`.
|
||||
- The resulting URL should look similar to:
|
||||
`https://username-pandoranext.hf.space/your_proxy_api_prefix_here/backend-api/conversation`
|
||||
|
||||
## Final Notes
|
||||
|
||||
- The `proxy_api_prefix` should be sufficiently random and unique to prevent errors.
|
||||
|
|
|
|||
|
|
@ -1,3 +1,7 @@
|
|||
---
|
||||
title: ⚡ Azure AI Search
|
||||
weight: -4
|
||||
---
|
||||
# Azure AI Search Plugin
|
||||
Through the plugins endpoint, you can use Azure AI Search for answers to your questions with assistance from GPT.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,3 +1,7 @@
|
|||
---
|
||||
title: 🧑💼 Official ChatGPT Plugins
|
||||
weight: -8
|
||||
---
|
||||
# Using official ChatGPT Plugins / OpenAPI specs
|
||||
|
||||
ChatGPT plugins are API integrations for OpenAI models that extend their capabilities. They are structured around three key components: an API, an **OpenAPI specification** (spec for short), and a JSON **Plugin Manifest** file.
|
||||
|
|
@ -7,15 +11,19 @@ To learn more about them, or how to make your own, read here: [ChatGPT Plugins:
|
|||
Thanks to the introduction of [OpenAI Functions](https://openai.com/blog/function-calling-and-other-api-updates) and their utilization in [Langchain](https://js.langchain.com/docs/modules/chains/openai_functions/openapi), it's now possible to directly use OpenAI Plugins through LibreChat, without building any custom langchain tools. The main use case we gain from integrating them to LibreChat is to allow use of plugins with gpt-3.5 models, and without ChatGPT Plus. They also find a great use case when you want to limit your own private API's interactions with chat.openai.com and their servers in favor of a self-hosted LibreChat instance.
|
||||
|
||||
### Table of Contents
|
||||
- [Intro](#intro)
|
||||
- [Adding a Plugin](#adding-a-plugin)
|
||||
- [Editing Manifest Files](#editing-manifest-files)
|
||||
- [Override Parameter Values](#override-parameter-values)
|
||||
- [Add Header Fields](#add-header-fields)
|
||||
- [Custom OpenAPI Spec files](#custom-openapi-spec-files)
|
||||
- [Plugins with Authentication](#plugins-with-authentication)
|
||||
- [Showcase](#showcase)
|
||||
- [Disclaimers](#disclaimers)
|
||||
- [Using official ChatGPT Plugins / OpenAPI specs](#using-official-chatgpt-plugins--openapi-specs)
|
||||
- [Table of Contents](#table-of-contents)
|
||||
- [Intro](#intro)
|
||||
- [**Plugin Manifest File:**](#plugin-manifest-file)
|
||||
- [**OpenAPI Spec**](#openapi-spec)
|
||||
- [Adding a Plugin](#adding-a-plugin)
|
||||
- [Editing Manifest Files](#editing-manifest-files)
|
||||
- [Override Parameter Values](#override-parameter-values)
|
||||
- [Add Header Fields](#add-header-fields)
|
||||
- [Custom OpenAPI Spec files](#custom-openapi-spec-files)
|
||||
- [Plugins with Authentication](#plugins-with-authentication)
|
||||
- [Showcase](#showcase)
|
||||
- [Disclaimers](#disclaimers)
|
||||
|
||||
## Intro
|
||||
|
||||
|
|
|
|||
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: 🔎 Google Search
|
||||
weight: -7
|
||||
---
|
||||
|
||||
# Google Search Plugin
|
||||
Through the plugins endpoint, you can use google search for answers to your questions with assistance from GPT! To get started, you need to get a Google Custom Search API key, and a Google Custom Search Engine ID. You can then define these as follows in your `.env` file:
|
||||
```env
|
||||
|
|
|
|||
13
docs/features/plugins/index.md
Normal file
13
docs/features/plugins/index.md
Normal file
|
|
@ -0,0 +1,13 @@
|
|||
---
|
||||
title: Plugins
|
||||
weight: -10
|
||||
---
|
||||
|
||||
# Plugins
|
||||
* 🔌 [Introduction](./introduction.md)
|
||||
* 🛠️ [Make Your Own](./make_your_own.md)
|
||||
* 🧑💼 [Official ChatGPT Plugins](./chatgpt_plugins_openapi.md)
|
||||
* 🔎 [Google Search](./google_search.md)
|
||||
* 🖌️ [Stable Diffusion](./stable_diffusion.md)
|
||||
* 🧠 [Wolfram|Alpha](./wolfram.md)
|
||||
* ⚡ [Azure AI Search](./azure_ai_search.md)
|
||||
|
|
@ -1,6 +1,11 @@
|
|||
---
|
||||
title: 🔌 Introduction
|
||||
weight: -10
|
||||
---
|
||||
# Plugins Endpoint
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
The plugins endpoint opens the door to prompting LLMs in new ways other than traditional input/output prompting.
|
||||
|
||||
|
|
@ -8,27 +13,21 @@ The first step is using chain-of-thought prompting & ["agency"](https://zapier.c
|
|||
|
||||
More than this, you can use this endpoint for changing your conversation settings mid-conversation. Unlike the official ChatGPT site and all other endpoints, you can switch models, presets, and settings mid-convo, even when you have no plugins selected. This is useful if you first want a creative response from GPT-4, and then a deterministic, lower cost response from GPT-3. Soon, you will be able to use Google, HuggingFace, local models, all in this or a similar endpoint in the same modular manner.
|
||||
|
||||
### Roadmap:
|
||||
- More plugins and advanced plugin usage (ongoing)
|
||||
- **[ChatGPT Plugins/OpenAPI Specs (complete)](./chatgpt_plugins_openapi.md)**
|
||||
- More LLMs to choose from for both Thinking and Completion Phases
|
||||
- Alternative prompting methods such as Tree-of-Thought
|
||||
|
||||
## Using Plugins
|
||||
|
||||
The LLM process when using Plugins is illustrated below.
|
||||
|
||||
|
||||
|
||||
|
||||
**When you open the settings with the Plugins endpoint selected, you will view the default settings for the Completion Phase.**
|
||||
|
||||
Clicking on **"Show Agent Settings"** will allow you to modify parameters for the thinking phase
|
||||
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
|
||||
|
||||
|
||||
- You can specify which plugins you would like to select from by installing/uninstalling them in the Plugin store
|
||||
- See this guide on how to create your own plugins (WIP)
|
||||
|
|
|
|||
|
|
@ -1,3 +1,7 @@
|
|||
---
|
||||
title: 🛠️ Make Your Own
|
||||
weight: -9
|
||||
---
|
||||
# Making your own Plugin
|
||||
|
||||
Creating custom plugins for this project involves extending the `Tool` class from the `langchain/tools` module.
|
||||
|
|
|
|||
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: 🖌️ Stable Diffusion
|
||||
weight: -6
|
||||
---
|
||||
|
||||
# Stable Diffusion Plugin
|
||||
|
||||
To use Stable Diffusion with this project, you will either need to download and install [stable-diffusion-webui](https://github.com/AUTOMATIC1111/stable-diffusion-webui) or, for a dockerized deployment, you can also use [stable-diffusion-webui-docker](https://github.com/AbdBarho/stable-diffusion-webui-docker)
|
||||
|
|
@ -58,10 +63,10 @@ With the docker deployment you can skip step 2 and step 3, use the setup instruc
|
|||
|
||||
### Select the plugins endpoint
|
||||
|
||||
|
||||
|
||||
|
||||
### Open the Plugin store and Install Stable Diffusion
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: 🧠 Wolfram|Alpha
|
||||
weight: -5
|
||||
---
|
||||
|
||||
# Wolfram Alpha Plugin
|
||||
|
||||
An AppID must be supplied in all calls to the Wolfram|Alpha API.
|
||||
|
|
@ -8,9 +13,9 @@ An AppID must be supplied in all calls to the Wolfram|Alpha API.
|
|||
## 2. Go to the <a href='https://developer.wolframalpha.com/portal/myapps/'>Developer Portal</a> click on "Get an AppID".
|
||||
## 3. Configure it in LibreChat
|
||||
### Select the plugins endpoint
|
||||
|
||||
|
||||
### Open the Plugin store
|
||||
|
||||
|
||||
### Install Wolfram and Provide your AppID
|
||||
|
||||
|
||||
|
|
|
|||
91
docs/features/presets.md
Normal file
91
docs/features/presets.md
Normal file
|
|
@ -0,0 +1,91 @@
|
|||
---
|
||||
title: 🔖 Presets
|
||||
weight: -9
|
||||
---
|
||||
# Guide to Using the "Presets" Feature
|
||||
|
||||
The "presets" feature in our app is a powerful tool that allows users to save and load predefined settings for their conversations. Users can import and export these presets as JSON files, set a default preset, and share them with others on Discord.
|
||||
|
||||
|
||||
|
||||
## Create a Preset:
|
||||
|
||||
- Go in the model settings
|
||||
|
||||
|
||||
|
||||
- Choose the model, give it a name, some custom instructions, and adjust the parameters if needed
|
||||
|
||||
|
||||
|
||||
- Test it
|
||||
|
||||
|
||||
|
||||
- Go back in the model advanced settings, and tweak it if needed. When you're happy with the result, click on `Save As Preset` (from the model advanced settings)
|
||||
|
||||
|
||||
|
||||
- Give it a proper name, and click save
|
||||
|
||||
|
||||
|
||||
- Now you can select it from the preset menu!
|
||||
|
||||
|
||||
|
||||
## Parameters Explained:
|
||||
|
||||
- **Preset Name:**
|
||||
- This is where you name your preset for easy identification.
|
||||
|
||||
- **Endpoint:**
|
||||
- Choose the endpoint, such as openAI, that you want to use for processing the conversation.
|
||||
|
||||
- **Model:**
|
||||
- Select the model like `gpt-3.5-turbo` that will be used for generating responses.
|
||||
|
||||
- **Custom Name:**
|
||||
- Optionally provide a custom name for your preset. This is the name that will be shown in the UI when using it.
|
||||
|
||||
- **Prompt Prefix:**
|
||||
- Define instructions or guidelines that will be displayed before each prompt to guide the user in providing input.
|
||||
|
||||
- **Temperature:**
|
||||
- Adjust this parameter to control the randomness of the model's output. A higher value makes the output more random, while a lower value makes it more focused and deterministic.
|
||||
|
||||
- **Top P:**
|
||||
- Control the nucleus sampling parameter to influence the diversity of generated text. Lower values make text more focused while higher values increase diversity.
|
||||
|
||||
- **Frequency Penalty:**
|
||||
- Use this setting to penalize frequently occurring tokens and promote diversity in responses.
|
||||
|
||||
- **Presence Penalty:**
|
||||
- Adjust this parameter to penalize new tokens that are introduced into responses, controlling repetition and promoting consistency.
|
||||
|
||||
## Importing/Exporting Presets
|
||||
|
||||
You can easily import or export presets as JSON files by clicking on either 'Import' or 'Export' buttons respectively. This allows you to share your customized settings with others or switch between different configurations quickly.
|
||||
|
||||
|
||||
|
||||
To export a preset, first go in the preset menu, then click on the button to edit the selected preset
|
||||
|
||||
|
||||
|
||||
Then in the bottom of the preset settings you'll have the option to export it.
|
||||
|
||||
<p align="left">
|
||||
<img src="https://github.com/danny-avila/LibreChat/assets/32828263/a624345f-e3e6-4192-8384-293ba6ce54cc" width="50%">
|
||||
</p>
|
||||
|
||||
## Setting Default Preset
|
||||
|
||||
Choose a preset as default so it loads automatically whenever you start a new conversation. This saves time if you often use specific settings.
|
||||
|
||||
|
||||
|
||||
|
||||
## Sharing on Discord
|
||||
|
||||
Join us on [discord](https://discord.librechat.ai) and see our **[#presets ](https://discord.com/channels/1086345563026489514/1093249324797935746)** channel where thousands of presets are shared by users worldwide. Check out pinned posts for popular presets!
|
||||
|
|
@ -1,32 +0,0 @@
|
|||
# Proxy
|
||||
|
||||
If your server cannot connect to the chatGPT API server by some reason, (eg in China). You can set a environment variable `PROXY`. This will be transmitted to `node-chatgpt-api` interface.
|
||||
|
||||
**Warning:** `PROXY` is not `reverseProxyUrl` in `node-chatgpt-api`
|
||||
|
||||
## Set up proxy in local environment
|
||||
|
||||
- **Option 1:** system level environment
|
||||
`export PROXY="http://127.0.0.1:7890"`
|
||||
|
||||
- **Option 2:** set in .env file
|
||||
`PROXY="http://127.0.0.1:7890"`
|
||||
|
||||
**Change `http://127.0.0.1:7890` to your proxy server**
|
||||
|
||||
|
||||
## Set up proxy in docker environment </strong></summary>
|
||||
|
||||
set in docker-compose.yml file, under services - api - environment
|
||||
|
||||
```
|
||||
api:
|
||||
...
|
||||
environment:
|
||||
...
|
||||
- "PROXY=http://127.0.0.1:7890"
|
||||
# add this line ↑
|
||||
```
|
||||
|
||||
**Change `http://127.0.0.1:7890` to your proxy server**
|
||||
|
||||
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: ✨ Third-Party Tools and Contributions
|
||||
weight: -2
|
||||
---
|
||||
|
||||
# Third-Party Tools
|
||||
|
||||
> ⚠️ Warning: The tools featured here are not officially maintained or supported by the LibreChat team
|
||||
|
|
|
|||
|
|
@ -1,3 +1,7 @@
|
|||
---
|
||||
title: 🪙 Token Usage
|
||||
weight: -7
|
||||
---
|
||||
# Token Usage
|
||||
|
||||
As of v6.0.0, LibreChat accurately tracks token usage for the OpenAI/Plugins endpoints.
|
||||
|
|
|
|||
|
|
@ -1,4 +1,8 @@
|
|||
# ⚠️ **Breaking Changes** ⚠️
|
||||
---
|
||||
title: ⚠️ Breaking Changes
|
||||
weight: -10
|
||||
---
|
||||
# ⚠️ Breaking Changes
|
||||
|
||||
> **Note:**
|
||||
**If you experience any issues after updating, we recommend clearing your browser cache and cookies.**
|
||||
|
|
@ -20,7 +24,7 @@ Certain changes in the updates may impact cookies, leading to unexpected behavio
|
|||
|
||||
## v0.5.8
|
||||
|
||||
- It's now required to name manifest JSON files (for [ChatGPT Plugins](..\features\plugins\chatgpt_plugins_openapi.md)) in the `api\app\clients\tools\.well-known` directory after their `name_for_model` property should you add one yourself.
|
||||
- It's now required to name manifest JSON files (for [ChatGPT Plugins](../features/plugins/chatgpt_plugins_openapi.md)) in the `api\app\clients\tools\.well-known` directory after their `name_for_model` property should you add one yourself.
|
||||
- This was a recommended convention before, but is now required.
|
||||
|
||||
## v0.5.7
|
||||
|
|
@ -120,7 +124,7 @@ I had to change the environment variable from AZURE_OPENAI_API_KEY to AZURE_API_
|
|||
---
|
||||
|
||||
### Docker
|
||||
- The docker-compose file had some change. Review the [new docker instructions](../install/docker_compose_install.md) to make sure you are setup properly. This is still the simplest and most effective method.
|
||||
- The docker-compose file had some change. Review the [new docker instructions](../install/installation/docker_compose_install.md) to make sure you are setup properly. This is still the simplest and most effective method.
|
||||
|
||||
---
|
||||
|
||||
|
|
|
|||
12
docs/general_info/index.md
Normal file
12
docs/general_info/index.md
Normal file
|
|
@ -0,0 +1,12 @@
|
|||
---
|
||||
title: General Information
|
||||
weight: 4
|
||||
---
|
||||
|
||||
# General Information
|
||||
|
||||
* ⚠️ [Breaking Changes](./breaking_changes.md)
|
||||
* 👮 [Code of Conduct](https://github.com/danny-avila/LibreChat/blob/main/.github/CODE_OF_CONDUCT.md)
|
||||
* 🌍 [Multilingual Information](multilingual_information.md)
|
||||
* 🧭 [Origin](project_origin.md)
|
||||
* 🧑💻 [Tech Stack](tech_stack.md)
|
||||
|
|
@ -1,3 +1,7 @@
|
|||
---
|
||||
title: 🌍 Multilingual Information
|
||||
weight: -9
|
||||
---
|
||||
# Multilingual Information
|
||||
To set up the project, please follow the instructions in the documentation. The documentation is in English only, so you may need to use a translation tool or an AI assistant (e.g. ChatGPT) if you have difficulty understanding it.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,3 +1,7 @@
|
|||
---
|
||||
title: 🧭 Origin
|
||||
weight: -8
|
||||
---
|
||||
# Origin
|
||||
|
||||
This project was started early in Feb '23, anticipating the release of the official ChatGPT API from OpenAI, which is now used. It was originally created as a Minimum Viable Product (or MVP) for the [@HackReactor](https://github.com/hackreactor/) Bootcamp. It was built with OpenAI response streaming and most of the UI completed in under 20 hours. During the end of that time, I had most of the UI and basic functionality done. This was created without using any boilerplates or templates, including create-react-app and other toolchains. I didn't follow any 'un-official chatgpt' video tutorials, and simply referenced the official site for the UI. The purpose of the exercise was to learn setting up a full stack project from scratch.
|
||||
|
|
|
|||
|
|
@ -1,9 +1,36 @@
|
|||
---
|
||||
title: 🧑💻 Tech Stack
|
||||
weight: -8
|
||||
---
|
||||
# Tech Stack
|
||||
|
||||
## This project uses:
|
||||
|
||||
- [node-chatgpt-api](https://github.com/waylaidwanderer/node-chatgpt-api)
|
||||
- No React boilerplate/toolchain/clone tutorials, created from scratch with react@latest
|
||||
- Use of Tailwind CSS and [shadcn/ui](https://github.com/shadcn/ui) components
|
||||
- Docker, useSWR, Redux, Express, MongoDB, [Keyv](https://www.npmjs.com/package/keyv)
|
||||
- JavaScript/TypeScript: The project was initially developed entirely in JavaScript (JS). The frontend is in the process of transitioning from JS to TypeScript (TS). The backend is currently in JS, and there are considerations for transitioning it to TS in the future.
|
||||
|
||||
- React: The frontend UI is built using React.
|
||||
|
||||
- Express.js: The backend server is built using Express.js.
|
||||
|
||||
- OpenAI API: The project uses the official ChatGPT API from OpenAI.
|
||||
|
||||
- Docker: Docker is used for containerization of the application.
|
||||
|
||||
- MongoDB: MongoDB is used as the database for the application.
|
||||
|
||||
- npm: npm is used as the package manager.
|
||||
|
||||
- Git: Git is used for version control, following a GitFlow workflow.
|
||||
|
||||
- ESLint: ESLint is used for linting the codebase.
|
||||
|
||||
- Husky: Husky is used for pre-commit checks.
|
||||
|
||||
- Playwright: Playwright is used for running integration tests.
|
||||
|
||||
- GitHub: GitHub is used for hosting the codebase and managing contributions.
|
||||
|
||||
- Discord: Discord is used for community engagement and discussions.
|
||||
|
||||
- Various Cloud Deployment Options: The project supports deployment on multiple cloud platforms including DigitalOcean, Azure, Linode, Cloudflare, Ngrok, HuggingFace, and Render.
|
||||
|
||||
|
|
|
|||
|
|
@ -28,7 +28,8 @@
|
|||
</a>
|
||||
</p>
|
||||
|
||||
# Features
|
||||
|
||||
## 🪶 Features
|
||||
- 🖥️ UI matching ChatGPT, including Dark mode, Streaming, and 11-2023 updates
|
||||
- 💬 Multimodal Chat:
|
||||
- Upload and analyze images with GPT-4 and Gemini Vision 📸
|
||||
|
|
@ -45,9 +46,7 @@
|
|||
- 👥 Multi-User, Secure Authentication with Moderation and Token spend tools
|
||||
- ⚙️ Configure Proxy, Reverse Proxy, Docker, many Deployment options, and completely Open-Source
|
||||
|
||||
[For a thorough review of our features, see our docs here](https://docs.librechat.ai/features/plugins/introduction.html) 📚
|
||||
|
||||
## All-In-One AI Conversations with LibreChat ##
|
||||
## 📃 All-In-One AI Conversations with LibreChat
|
||||
LibreChat brings together the future of assistant AIs with the revolutionary technology of OpenAI's ChatGPT. Celebrating the original styling, LibreChat gives you the ability to integrate multiple AI models. It also integrates and enhances original client features such as conversation and message search, prompt templates and plugins.
|
||||
|
||||
With LibreChat, you no longer need to opt for ChatGPT Plus and can instead use free or pay-per-call APIs. We welcome contributions, cloning, and forking to enhance the capabilities of this advanced chatbot platform.
|
||||
|
|
@ -64,13 +63,9 @@ With LibreChat, you no longer need to opt for ChatGPT Plus and can instead use f
|
|||
</iframe>
|
||||
</p>
|
||||
|
||||
## ⚠️ [Breaking Changes](general_info/breaking_changes.md) ⚠️
|
||||
|
||||
**Please read this before updating from a previous version**
|
||||
|
||||
---
|
||||
|
||||
## Star History
|
||||
## ⭐ Star History
|
||||
|
||||
<a href="https://star-history.com/#danny-avila/LibreChat&Date">
|
||||
<img alt="Star History Chart" src="https://api.star-history.com/svg?repos=danny-avila/LibreChat&type=Date&theme=dark" onerror="this.src='https://api.star-history.com/svg?repos=danny-avila/LibreChat&type=Date'" />
|
||||
|
|
@ -78,7 +73,7 @@ With LibreChat, you no longer need to opt for ChatGPT Plus and can instead use f
|
|||
|
||||
---
|
||||
|
||||
## Contributors
|
||||
## ✨ Contributors
|
||||
Contributions and suggestions bug reports and fixes are welcome!
|
||||
Please read the documentation before you do!
|
||||
|
||||
|
|
@ -86,7 +81,7 @@ For new features, components, or extensions, please open an issue and discuss be
|
|||
|
||||
- Join the [Discord community](https://discord.gg/uDyZ5Tzhct)
|
||||
|
||||
This project exists in its current state thanks to all the people who contribute
|
||||
## 💖 This project exists in its current state thanks to all the people who contribute
|
||||
---
|
||||
<a href="https://github.com/danny-avila/LibreChat/graphs/contributors">
|
||||
<img src="https://contrib.rocks/image?repo=danny-avila/LibreChat" />
|
||||
|
|
|
|||
|
|
@ -1,28 +1,37 @@
|
|||
# Table of Contents
|
||||
---
|
||||
title: 🤖 AI Setup
|
||||
weight: -8
|
||||
---
|
||||
|
||||
1. [AI Setup](#ai-setup)
|
||||
- [General Information](#general)
|
||||
- [Free AI APIs](#free-ai-apis)
|
||||
- [Setting a Default Endpoint](#setting-a-default-endpoint)
|
||||
- [Setting a Default Preset](#setting-a-default-preset)
|
||||
- [OpenAI](#openai)
|
||||
- [Anthropic](#anthropic)
|
||||
- [Google](#google)
|
||||
- [Generative Language API (Gemini)](#generative-language-api-gemini)
|
||||
- [Vertex AI (PaLM 2 & Codey)](#vertex-ai-palm-2--codey)
|
||||
- [Azure OpenAI](#azure-openai)
|
||||
- [Required Variables](#required-variables)
|
||||
- [Model Deployments](#model-deployments)
|
||||
- [Setting a Default Model for Azure](#setting-a-default-model-for-azure)
|
||||
- [Enabling Auto-Generated Titles with Azure](#enabling-auto-generated-titles-with-azure)
|
||||
- [Using GPT-4 Vision with Azure](#using-gpt-4-vision-with-azure)
|
||||
- [Setting Azure OpenAI as the Default Endpoint](#setting-azure-openai-as-the-default-endpoint)
|
||||
- [Optional Variables](#optional-variables)
|
||||
- [Using Plugins with Azure](#using-plugins-with-azure)
|
||||
- [Unofficial APIs](#unofficial-apis)
|
||||
- [ChatGPTBrowser](#chatgptbrowser)
|
||||
- [BingAI](#bingai)
|
||||
2. [Conclusion](#conclusion)
|
||||
<!-- # Table of Contents
|
||||
|
||||
- [Table of Contents](#table-of-contents)
|
||||
- [AI Setup](#ai-setup)
|
||||
- [General](#general)
|
||||
- [Free AI APIs](#free-ai-apis)
|
||||
- [Setting a Default Endpoint](#setting-a-default-endpoint)
|
||||
- [Setting a Default Preset](#setting-a-default-preset)
|
||||
- [OpenAI](#openai)
|
||||
- [Anthropic](#anthropic)
|
||||
- [Google](#google)
|
||||
- [Generative Language API (Gemini)](#generative-language-api-gemini)
|
||||
- [Vertex AI (PaLM 2 \& Codey)](#vertex-ai-palm-2--codey)
|
||||
- [1. Once signed up, Enable the Vertex AI API on Google Cloud:](#1-once-signed-up-enable-the-vertex-ai-api-on-google-cloud)
|
||||
- [2. Create a Service Account with Vertex AI role:](#2-create-a-service-account-with-vertex-ai-role)
|
||||
- [3. Create a JSON key to Save in your Project Directory:](#3-create-a-json-key-to-save-in-your-project-directory)
|
||||
- [Azure OpenAI](#azure-openai)
|
||||
- [Required Variables](#required-variables)
|
||||
- [Model Deployments](#model-deployments)
|
||||
- [Setting a Default Model for Azure](#setting-a-default-model-for-azure)
|
||||
- [Enabling Auto-Generated Titles with Azure](#enabling-auto-generated-titles-with-azure)
|
||||
- [Using GPT-4 Vision with Azure](#using-gpt-4-vision-with-azure)
|
||||
- [Optional Variables](#optional-variables)
|
||||
- [Using Plugins with Azure](#using-plugins-with-azure)
|
||||
- [OpenRouter](#openrouter)
|
||||
- [Unofficial APIs](#unofficial-apis)
|
||||
- [ChatGPTBrowser](#chatgptbrowser)
|
||||
- [BingAI](#bingai)
|
||||
- [Conclusion](#conclusion) -->
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -310,6 +319,35 @@ To use Azure with the Plugins endpoint, make sure the following environment vari
|
|||
|
||||
---
|
||||
|
||||
## [OpenRouter](https://openrouter.ai/)
|
||||
|
||||
[OpenRouter](https://openrouter.ai/) is a legitimate proxy service to a multitude of LLMs, both closed and open source, including:
|
||||
- OpenAI models (great if you are barred from their API for whatever reason)
|
||||
- Anthropic Claude models (same as above)
|
||||
- Meta's Llama models
|
||||
- pygmalionai/mythalion-13b
|
||||
- and many more open source models. Newer integrations are usually discounted, too!
|
||||
|
||||
> See their available models and pricing here: [Supported Models](https://openrouter.ai/docs#models)
|
||||
|
||||
OpenRouter is so great, I decided to integrate it to the project as a standalone feature.
|
||||
|
||||
**Setup:**
|
||||
- Signup to [OpenRouter](https://openrouter.ai/) and create a key. You should name it and set a limit as well.
|
||||
- Set the environment variable `OPENROUTER_API_KEY` in your .env file to the key you just created.
|
||||
- Set something in the `OPENAI_API_KEY`, it can be anyting, but **do not** leave it blank or set to `user_provided`
|
||||
- Restart your LibreChat server and use the OpenAI or Plugins endpoints.
|
||||
|
||||
**Notes:**
|
||||
- [TODO] **In the future, you will be able to set up OpenRouter from the frontend as well.**
|
||||
- This will override the official OpenAI API or your reverse proxy settings for both Plugins and OpenAI.
|
||||
- On initial setup, you may need to refresh your page twice to see all their supported models populate automatically.
|
||||
- Plugins: Functions Agent works with OpenRouter when using OpenAI models.
|
||||
- Plugins: Turn functions off to try plugins with non-OpenAI models (ChatGPT plugins will not work and others may not work as expected).
|
||||
- Plugins: Make sure `PLUGINS_USE_AZURE` is not set in your .env file when wanting to use OpenRouter and you have Azure configured.
|
||||
|
||||
---
|
||||
|
||||
## Unofficial APIs
|
||||
|
||||
**Important:** Stability for Unofficial APIs are not guaranteed. Access methods to these APIs are hacky, prone to errors, and patching, and are marked lowest in priority in LibreChat's development.
|
||||
|
|
@ -322,7 +360,7 @@ This is not to be confused with [OpenAI's Official API](#openai)!
|
|||
|
||||
> Note that this is disabled by default and requires additional configuration to work.
|
||||
> Also, using this may have your data exposed to 3rd parties if using a proxy, and OpenAI may flag your account.
|
||||
> See: [ChatGPT Reverse Proxy](../features/pandoranext.md)
|
||||
> See: [ChatGPT Reverse Proxy](../../features/pandoranext.md)
|
||||
|
||||
To get your Access token for ChatGPT Browser Access, you need to:
|
||||
|
||||
|
|
@ -336,19 +374,20 @@ Warning: There may be a chance of your account being banned if you deploy the ap
|
|||
---
|
||||
|
||||
### BingAI
|
||||
I recommend using Microsoft Edge for this:
|
||||
|
||||
To get your Bing Access Token, you have a few options:
|
||||
- Navigate to **[Bing Chat](https://www.bing.com/chat)**
|
||||
- **Login** if you haven't already
|
||||
- Initiate a conversation with Bing
|
||||
- Open `Dev Tools`, usually with `F12` or `Ctrl + Shift + C`
|
||||
- Navigate to the `Network` tab
|
||||
- Look for `lsp.asx` (if it's not there look into the other entries for one with a **very long** cookie)
|
||||
- Copy the whole cookie value. (Yes it's very long 😉)
|
||||
- Use this **"full cookie string"** for your "BingAI Token"
|
||||
|
||||
- You can try leaving it blank and see if it works (fingers crossed 🤞)
|
||||
|
||||
- You can follow these [new instructions](https://github.com/danny-avila/LibreChat/issues/370#issuecomment-1560382302) (thanks @danny-avila for sharing 🙌)
|
||||
|
||||
- You can use MS Edge, navigate to bing.com, and do the following:
|
||||
- Make sure you are logged in
|
||||
- Open the DevTools by pressing F12 on your keyboard
|
||||
- Click on the tab "Application" (On the left of the DevTools)
|
||||
- Expand the "Cookies" (Under "Storage")
|
||||
- Copy the value of the "\_U" cookie and save it in ./.env as BING_ACCESS_TOKEN
|
||||
<p align="left">
|
||||
<img src="https://github.com/danny-avila/LibreChat/assets/32828263/d4dfd370-eddc-4694-ab16-076f913ff430" width="50%">
|
||||
</p>
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: 🌍 Default Language
|
||||
weight: -3
|
||||
---
|
||||
|
||||
# Default Language 🌍
|
||||
|
||||
## How to change the default language
|
||||
|
|
@ -33,4 +38,4 @@ export default { lang };
|
|||
```
|
||||
---
|
||||
|
||||
> **❗If you wish to contribute your own translation to LibreChat, please refer to this document for instructions: [Contribute a Translation](../contributions/translation_contribution.md)**
|
||||
> **❗If you wish to contribute your own translation to LibreChat, please refer to this document for instructions: [Contribute a Translation](../../contributions/translation_contribution.md)**
|
||||
76
docs/install/configuration/docker_override.md
Normal file
76
docs/install/configuration/docker_override.md
Normal file
|
|
@ -0,0 +1,76 @@
|
|||
---
|
||||
title: 🐋 Docker Compose Override
|
||||
weight: -9
|
||||
---
|
||||
|
||||
# How to Use the Docker Compose Override File
|
||||
|
||||
In Docker Compose, an override file is a powerful feature that allows you to modify the default configuration provided by the main `docker-compose.yml` without the need to directly edit or duplicate the whole file. The primary use of the override file is for local development customizations, and Docker Compose merges the configurations of the `docker-compose.yml` and the `docker-compose.override.yml` files when you run `docker-compose up`.
|
||||
|
||||
Here's a quick guide on how to use the `docker-compose.override.yml`:
|
||||
|
||||
> Note: Please consult the `docker-compose.override.yml.example` for more examples
|
||||
|
||||
See the the official docker documentation for more info:
|
||||
|
||||
- **[docker docs - understanding-multiple-compose-files](https://docs.docker.com/compose/multiple-compose-files/extends/#understanding-multiple-compose-files)**
|
||||
- **[docker docs - merge-compose-files](https://docs.docker.com/compose/multiple-compose-files/merge/#merge-compose-files)**
|
||||
- **[docker docs - specifying-multiple-compose-files](https://docs.docker.com/compose/reference/#specifying-multiple-compose-files)**
|
||||
|
||||
## Step 1: Create a `docker-compose.override.yml` file
|
||||
|
||||
If you don't already have a `docker-compose.override.yml` file, you can create one by copying the example override content:
|
||||
|
||||
```bash
|
||||
cp docker-compose.override.yml.example docker-compose.override.yml
|
||||
```
|
||||
|
||||
This file will be picked up by Docker Compose automatically when you run docker-compose commands.
|
||||
|
||||
## Step 2: Edit the override file
|
||||
|
||||
Open your `docker-compose.override.yml` file with vscode or any text editor.
|
||||
|
||||
Make your desired changes by uncommenting the relevant sections and customizing them as needed.
|
||||
|
||||
For example, if you want to use a prebuilt image for the `api` service and expose MongoDB's port, your `docker-compose.override.yml` might look like this:
|
||||
|
||||
```yaml
|
||||
version: '3.4'
|
||||
|
||||
services:
|
||||
api:
|
||||
image: ghcr.io/danny-avila/librechat:latest
|
||||
|
||||
mongodb:
|
||||
ports:
|
||||
- 27018:27017
|
||||
```
|
||||
|
||||
> Note: Be cautious with exposing ports like MongoDB to the public, as it can make your database vulnerable to attacks.
|
||||
|
||||
## Step 3: Apply the changes
|
||||
|
||||
To apply your configuration changes, simply run Docker Compose as usual. Docker Compose automatically takes into account both the `docker-compose.yml` and the `docker-compose.override.yml` files:
|
||||
|
||||
```bash
|
||||
docker-compose up -d
|
||||
```
|
||||
|
||||
If you want to invoke a build with the changes before starting containers:
|
||||
|
||||
```bash
|
||||
docker-compose build
|
||||
docker-compose up -d
|
||||
```
|
||||
|
||||
## Step 4: Verify the changes
|
||||
|
||||
After starting your services with the modified configuration, you can verify that the changes have been applied using the `docker ps` command to list the running containers and their properties, such as ports.
|
||||
|
||||
## Important Considerations
|
||||
|
||||
- **Order of Precedence**: Values defined in the override file take precedence over those specified in the original `docker-compose.yml` file.
|
||||
- **Security**: When customizing ports and publicly exposing services, always be conscious of the security implications. Avoid using defaults for production or sensitive environments.
|
||||
|
||||
By following these steps and considerations, you can easily and safely modify your Docker Compose configuration without altering the original `docker-compose.yml` file, making it simpler to manage and maintain different environments or local customizations.
|
||||
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: ⚙️ Environment Variables
|
||||
weight: -10
|
||||
---
|
||||
|
||||
# .env File Configuration
|
||||
Welcome to the comprehensive guide for configuring your application's environment with the `.env` file. This document is your one-stop resource for understanding and customizing the environment variables that will shape your application's behavior in different contexts.
|
||||
|
||||
|
|
@ -13,7 +18,20 @@ npm run update:docker
|
|||
docker-compose build --no-cache
|
||||
```
|
||||
|
||||
Alternatively, you can create a new file named `docker-compose.override.yml` in the same directory as your main `docker-compose.yml` file for LibreChat, where you can set your .env variables as needed under `environment`. See the [docker docs](https://docs.docker.com/compose/multiple-compose-files/extends/#understanding-multiple-compose-files) for more info, and you can also view an example of an override file for LibreChat in the ["Manage Your Database" section](https://docs.librechat.ai/features/manage_your_database.html)
|
||||
Alternatively, you can create a new file named `docker-compose.override.yml` in the same directory as your main `docker-compose.yml` file for LibreChat, where you can set your .env variables as needed under `environment`, or modify the default configuration provided by the main `docker-compose.yml`, without the need to directly edit or duplicate the whole file.
|
||||
|
||||
For more info see:
|
||||
|
||||
- Our quick guide:
|
||||
- **[Docker Override](../configuration/docker_override.md)**
|
||||
|
||||
- The official docker documentation:
|
||||
- **[docker docs - understanding-multiple-compose-files](https://docs.docker.com/compose/multiple-compose-files/extends/#understanding-multiple-compose-files)**
|
||||
- **[docker docs - merge-compose-files](https://docs.docker.com/compose/multiple-compose-files/merge/#merge-compose-files)**
|
||||
- **[docker docs - specifying-multiple-compose-files](https://docs.docker.com/compose/reference/#specifying-multiple-compose-files)**
|
||||
|
||||
- You can also view an example of an override file for LibreChat in your LibreChat folder and on GitHub:
|
||||
- **[docker-compose.override.example](https://github.com/danny-avila/LibreChat/blob/main/docker-compose.override.yaml.example)**
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -29,29 +47,6 @@ APP_TITLE=LibreChat
|
|||
CUSTOM_FOOTER="My custom footer"
|
||||
```
|
||||
|
||||
### Logging
|
||||
|
||||
LibreChat has built-in central logging.
|
||||
|
||||
- Debug logging is enabled by default and crucial for development.
|
||||
- To report issues, reproduce the error and submit logs from `./api/logs/debug-%DATE%.log` at [LibreChat GitHub Issues](https://github.com/danny-avila/LibreChat/issues).
|
||||
- Error logs are stored in the same location.
|
||||
- Keep debug logs active by default or disable them by setting `DEBUG_LOGGING=FALSE` in the environment variable.
|
||||
- For more information about this feature, read our docs: https://docs.librechat.ai/features/logging_system.html
|
||||
|
||||
```bash
|
||||
DEBUG_LOGGING=TRUE
|
||||
```
|
||||
|
||||
- Enable verbose server output in the console with `DEBUG_CONSOLE=TRUE`, though it's not recommended due to high verbosity.
|
||||
|
||||
```bash
|
||||
DEBUG_CONSOLE=TRUE
|
||||
```
|
||||
|
||||
This is not recommend, however, as the outputs can be quite verbose, and so it's disabled by default.
|
||||
|
||||
|
||||
### Port
|
||||
|
||||
- The server will listen to localhost:3080 by default. You can change the target IP as you want. If you want to make this server available externally, for example to share the server with others or expose this from a Docker container, set host to 0.0.0.0 or your external IP interface.
|
||||
|
|
@ -73,7 +68,7 @@ PORT=3080
|
|||
- Instruction on how to create an online MongoDB database (useful for use without docker):
|
||||
- [Online MongoDB](./mongodb.md)
|
||||
- Securely access your docker MongoDB database:
|
||||
- [Manage your database](../features/manage_your_database.md)
|
||||
- [Manage your database](../../features/manage_your_database.md)
|
||||
|
||||
```bash
|
||||
MONGO_URI=mongodb://127.0.0.1:27018/LibreChat
|
||||
|
|
@ -89,6 +84,37 @@ DOMAIN_CLIENT=http://localhost:3080
|
|||
DOMAIN_SERVER=http://localhost:3080
|
||||
```
|
||||
|
||||
### Prevent Public Search Engines Indexing
|
||||
By default, your website will not be indexed by public search engines (e.g. Google, Bing, …). This means that people will not be able to find your website through these search engines. If you want to make your website more visible and searchable, you can change the following setting to `false`
|
||||
|
||||
```bash
|
||||
NO_INDEX=true
|
||||
```
|
||||
|
||||
> ❗**Note:** This method is not guaranteed to work for all search engines, and some search engines may still index your website or web page for other purposes, such as caching or archiving. Therefore, you should not rely solely on this method to protect sensitive or confidential information on your website or web page.
|
||||
|
||||
### Logging
|
||||
|
||||
LibreChat has built-in central logging, see [Logging System](../../features/logging_system.md) for more info.
|
||||
|
||||
- Debug logging is enabled by default and crucial for development.
|
||||
- To report issues, reproduce the error and submit logs from `./api/logs/debug-%DATE%.log` at [LibreChat GitHub Issues](https://github.com/danny-avila/LibreChat/issues).
|
||||
- Error logs are stored in the same location.
|
||||
- Keep debug logs active by default or disable them by setting `DEBUG_LOGGING=false` in the environment variable.
|
||||
- For more information about this feature, read our docs: https://docs.librechat.ai/features/logging_system.html
|
||||
|
||||
```bash
|
||||
DEBUG_LOGGING=true
|
||||
```
|
||||
|
||||
- Enable verbose server output in the console with `DEBUG_CONSOLE=TRUE`, though it's not recommended due to high verbosity.
|
||||
|
||||
```bash
|
||||
DEBUG_CONSOLE=false
|
||||
```
|
||||
|
||||
This is not recommend, however, as the outputs can be quite verbose, and so it's disabled by default.
|
||||
|
||||
### Permission
|
||||
> UID and GID are numbers assigned by Linux to each user and group on the system. If you have permission problems, set here the UID and GID of the user running the docker compose command. The applications in the container will run with these uid/gid.
|
||||
|
||||
|
|
@ -169,7 +195,7 @@ PLUGINS_USE_AZURE="true"
|
|||
```
|
||||
|
||||
### BingAI
|
||||
Bing, also used for Sydney, jailbreak, and Bing Image Creator, see: [Bing Access token](./ai_setup.md#bingai) and [Bing Jailbreak](../features/bing_jailbreak.md)
|
||||
Bing, also used for Sydney, jailbreak, and Bing Image Creator, see: [Bing Access token](./ai_setup.md#bingai) and [Bing Jailbreak](../../features/bing_jailbreak.md)
|
||||
|
||||
- Follow these instructions to get your bing access token (it's best to use the full cookie string for that purpose): [Bing Access Token](https://github.com/danny-avila/LibreChat/issues/370#issuecomment-1560382302)
|
||||
- Leave `BINGAI_TOKEN=` blank to disable this endpoint
|
||||
|
|
@ -187,7 +213,7 @@ BINGAI_HOST=
|
|||
### ChatGPT
|
||||
see: [ChatGPT Free Access token](./ai_setup.md#chatgptbrowser)
|
||||
|
||||
> **Warning**: To use this endpoint you'll have to set up your own reverse proxy. Here is the installation guide to deploy your own (based on [PandoraNext](https://github.com/pandora-next/deploy)): **[PandoraNext Deployment Guide](../features/pandoranext.md)**
|
||||
> **Warning**: To use this endpoint you'll have to set up your own reverse proxy. Here is the installation guide to deploy your own (based on [PandoraNext](https://github.com/pandora-next/deploy)): **[PandoraNext Deployment Guide](../../features/pandoranext.md)**
|
||||
|
||||
```bash
|
||||
CHATGPT_REVERSE_PROXY=<YOUR-REVERSE-PROXY>
|
||||
|
|
@ -304,9 +330,9 @@ OPENROUTER_API_KEY=
|
|||
### Plugins
|
||||
Here are some useful documentation about plugins:
|
||||
|
||||
- [Introduction](../features/plugins/introduction.md)
|
||||
- [Make Your Own](../features/plugins/make_your_own.md)
|
||||
- [Using official ChatGPT Plugins](../features/plugins/chatgpt_plugins_openapi.md)
|
||||
- [Introduction](../../features/plugins/introduction.md)
|
||||
- [Make Your Own](../../features/plugins/make_your_own.md)
|
||||
- [Using official ChatGPT Plugins](../../features/plugins/chatgpt_plugins_openapi.md)
|
||||
|
||||
#### General Configuration:
|
||||
- Identify the available models, separated by commas **without spaces**. The first model in the list will be set as default. Leave it blank or commented out to use internal settings.
|
||||
|
|
@ -332,7 +358,7 @@ CREDS_IV=e2341419ec3dd3d19b13a1a87fafcbfb
|
|||
```
|
||||
|
||||
#### Azure AI Search
|
||||
This plugin supports searching Azure AI Search for answers to your questions. See: [Azure AI Search](../features/plugins/azure_ai_search.md)
|
||||
This plugin supports searching Azure AI Search for answers to your questions. See: [Azure AI Search](../../features/plugins/azure_ai_search.md)
|
||||
|
||||
```bash
|
||||
AZURE_AI_SEARCH_SERVICE_ENDPOINT=
|
||||
|
|
@ -377,7 +403,7 @@ DALLE_REVERSE_PROXY=
|
|||
> Note: if you have PROXY set, it will be used for DALL-E calls also, which is universal for the app
|
||||
|
||||
#### Google Search
|
||||
See detailed instructions here: [Google Search](../features/plugins/google_search.md)
|
||||
See detailed instructions here: [Google Search](../../features/plugins/google_search.md)
|
||||
|
||||
```bash
|
||||
GOOGLE_API_KEY=
|
||||
|
|
@ -392,7 +418,7 @@ SERPAPI_API_KEY=
|
|||
```
|
||||
|
||||
#### Stable Diffusion (Automatic1111)
|
||||
See detailed instructions here: [Stable Diffusion](../features/plugins/stable_diffusion.md)
|
||||
See detailed instructions here: [Stable Diffusion](../../features/plugins/stable_diffusion.md)
|
||||
|
||||
- Use "http://127.0.0.1:7860" with local install and "http://host.docker.internal:7860" for docker
|
||||
|
||||
|
|
@ -401,7 +427,7 @@ SD_WEBUI_URL=http://host.docker.internal:7860
|
|||
```
|
||||
|
||||
#### WolframAlpha
|
||||
See detailed instructions here: [Wolfram Alpha](../features/plugins/wolfram.md)
|
||||
See detailed instructions here: [Wolfram Alpha](../../features/plugins/wolfram.md)
|
||||
|
||||
```bash
|
||||
WOLFRAM_APP_ID=
|
||||
|
|
@ -462,13 +488,23 @@ This section contains the configuration for:
|
|||
### Moderation
|
||||
The Automated Moderation System uses a scoring mechanism to track user violations. As users commit actions like excessive logins, registrations, or messaging, they accumulate violation scores. Upon reaching a set threshold, the user and their IP are temporarily banned. This system ensures platform security by monitoring and penalizing rapid or suspicious activities.
|
||||
|
||||
see: [Automated Moderation](../features/mod_system.md)
|
||||
see: [Automated Moderation](../../features/mod_system.md)
|
||||
|
||||
#### Basic Moderation Settings
|
||||
|
||||
- `OPENAI_MODERATION`: Set to true or false, Whether or not to enable OpenAI moderation on the **OpenAI** and **Plugins** endpoints
|
||||
- `OPENAI_MODERATION_API_KEY`: Your OpenAI API key
|
||||
- `OPENAI_MODERATION_REVERSE_PROXY`: Note: Commented out by default, this is not working with all reverse proxys
|
||||
|
||||
```bash
|
||||
OPENAI_MODERATION=false
|
||||
OPENAI_MODERATION_API_KEY=
|
||||
OPENAI_MODERATION_REVERSE_PROXY=
|
||||
```
|
||||
|
||||
- `BAN_VIOLATIONS`: Whether or not to enable banning users for violations (they will still be logged)
|
||||
- `BAN_DURATION`: How long the user and associated IP are banned for (in milliseconds)
|
||||
- `BAN_INTERVAL` The user will be banned everytime their score reaches/crosses over the interval threshold
|
||||
- `BAN_INTERVAL`: The user will be banned everytime their score reaches/crosses over the interval threshold
|
||||
|
||||
```bash
|
||||
BAN_VIOLATIONS=true
|
||||
|
|
@ -539,7 +575,7 @@ MESSAGE_USER_WINDOW=1
|
|||
### Balance
|
||||
The following enables user balances for the OpenAI/Plugins endpoints, which you can add manually or you will need to build out a balance accruing system for users.
|
||||
|
||||
see: [Token Usage](../features/token_usage.md)
|
||||
see: [Token Usage](../../features/token_usage.md)
|
||||
|
||||
- To manually add balances, run the following command:`npm run add-balance`
|
||||
- You can also specify the email and token credit amount to add, e.g.:`npm run add-balance example@example.com 1000`
|
||||
|
|
@ -553,7 +589,7 @@ CHECK_BALANCE=false
|
|||
```
|
||||
|
||||
### Registration and Login
|
||||
see: [User/Auth System](../install/user_auth_system.md)
|
||||
see: [User/Auth System](../configuration/user_auth_system.md)
|
||||
|
||||
|
||||
|
||||
|
|
@ -566,6 +602,7 @@ see: [User/Auth System](../install/user_auth_system.md)
|
|||
> **Quick Tip:** Even with registration disabled, add users directly to the database using `npm run create-user`.
|
||||
|
||||
```bash
|
||||
ALLOW_EMAIL_LOGIN=true
|
||||
ALLOW_REGISTRATION=true
|
||||
ALLOW_SOCIAL_LOGIN=false
|
||||
ALLOW_SOCIAL_REGISTRATION=false
|
||||
|
|
@ -589,9 +626,9 @@ JWT_REFRESH_SECRET=eaa5191f2914e30b9387fd84e254e4ba6fc51b4654968a9b0803b456a54b8
|
|||
|
||||
### Social Logins
|
||||
|
||||
#### [Discord](../install/user_auth_system.md#discord-authentication)
|
||||
#### [Discord](../configuration/user_auth_system.md#discord-authentication)
|
||||
|
||||
for more information: [Discord](../install/user_auth_system.md#discord-authentication)
|
||||
for more information: [Discord](../configuration/user_auth_system.md#discord-authentication)
|
||||
|
||||
```bash
|
||||
# Discord
|
||||
|
|
@ -600,9 +637,9 @@ DISCORD_CLIENT_SECRET=your_client_secret
|
|||
DISCORD_CALLBACK_URL=/oauth/discord/callback
|
||||
```
|
||||
|
||||
#### [Facebook](../install/user_auth_system.md#facebook-authentication)
|
||||
#### [Facebook](../configuration/user_auth_system.md#facebook-authentication)
|
||||
|
||||
for more information: [Facebook](../install/user_auth_system.md#facebook-authentication)
|
||||
for more information: [Facebook](../configuration/user_auth_system.md#facebook-authentication)
|
||||
|
||||
```bash
|
||||
# Facebook
|
||||
|
|
@ -611,9 +648,9 @@ FACEBOOK_CLIENT_SECRET=
|
|||
FACEBOOK_CALLBACK_URL=/oauth/facebook/callback
|
||||
|
||||
```
|
||||
#### [GitHub](../install/user_auth_system.md#github-authentication)
|
||||
#### [GitHub](../configuration/user_auth_system.md#github-authentication)
|
||||
|
||||
for more information: [GitHub](../install/user_auth_system.md#github-authentication)
|
||||
for more information: [GitHub](../configuration/user_auth_system.md#github-authentication)
|
||||
|
||||
```bash
|
||||
# GitHub
|
||||
|
|
@ -622,9 +659,9 @@ GITHUB_CLIENT_SECRET=your_client_secret
|
|||
GITHUB_CALLBACK_URL=/oauth/github/callback
|
||||
```
|
||||
|
||||
#### [Google](../install/user_auth_system.md#google-authentication)
|
||||
#### [Google](../configuration/user_auth_system.md#google-authentication)
|
||||
|
||||
for more information: [Google](../install/user_auth_system.md#google-authentication)
|
||||
for more information: [Google](../configuration/user_auth_system.md#google-authentication)
|
||||
|
||||
```bash
|
||||
# Google
|
||||
|
|
@ -633,9 +670,9 @@ GOOGLE_CLIENT_SECRET=
|
|||
GOOGLE_CALLBACK_URL=/oauth/google/callback
|
||||
```
|
||||
|
||||
#### [OpenID](../install/user_auth_system.md#openid-authentication-with-azure-ad)
|
||||
#### [OpenID](../configuration/user_auth_system.md#openid-authentication-with-azure-ad)
|
||||
|
||||
for more information: [Azure OpenID](../install/user_auth_system.md#openid-authentication-with-azure-ad) or [AWS Cognito OpenID](../install/user_auth_system.md#openid-authentication-with-aws-cognito)
|
||||
for more information: [Azure OpenID](../configuration/user_auth_system.md#openid-authentication-with-azure-ad) or [AWS Cognito OpenID](../configuration/user_auth_system.md#openid-authentication-with-aws-cognito)
|
||||
|
||||
```bash
|
||||
# OpenID
|
||||
|
|
@ -651,7 +688,7 @@ OPENID_IMAGE_URL=
|
|||
```
|
||||
|
||||
### Email Password Reset
|
||||
Email is used for password reset. See: [Email Password Reset](../install/user_auth_system.md#email-and-password-reset)
|
||||
Email is used for password reset. See: [Email Password Reset](../configuration/user_auth_system.md#email-and-password-reset)
|
||||
|
||||
- Note that all either service or host, username and password and the From address must be set for email to work.
|
||||
|
||||
|
|
@ -1,34 +1,15 @@
|
|||
---
|
||||
title: 💸 Free AI APIs
|
||||
weight: -6
|
||||
---
|
||||
|
||||
# Free AI APIs
|
||||
|
||||
There are APIs offering free/free-trial access to AI APIs via reverse proxy.
|
||||
|
||||
Here is a well-maintained public list of [Free AI APIs](https://github.com/zukixa/cool-ai-stuff) that may or may not be compatible with LibreChat
|
||||
|
||||
### [OpenRouter](https://openrouter.ai/) ⇆ (preferred)
|
||||
|
||||
While not completely free, you get free trial credits when you [sign up to OpenRouter](https://openrouter.ai/), a legitimate proxy service to a multitude of LLMs, both closed and open source, including:
|
||||
- OpenAI models (great if you are barred from their API for whatever reason)
|
||||
- Anthropic Claude models (same as above)
|
||||
- Meta's Llama models
|
||||
- pygmalionai/mythalion-13b
|
||||
- and many more open source models. Newer integrations are usually discounted, too!
|
||||
|
||||
OpenRouter is so great, I decided to integrate it to the project as a standalone feature.
|
||||
|
||||
**Setup:**
|
||||
- Signup to [OpenRouter](https://openrouter.ai/) and create a key. You should name it and set a limit as well.
|
||||
- Set the environment variable `OPENROUTER_API_KEY` in your .env file to the key you just created.
|
||||
- Restart your LibreChat server and use the OpenAI or Plugins endpoints.
|
||||
|
||||
**Notes:**
|
||||
- [TODO] **In the future, you will be able to set up OpenRouter from the frontend as well.**
|
||||
- This will override the official OpenAI API or your reverse proxy settings for both Plugins and OpenAI.
|
||||
- On initial setup, you may need to refresh your page twice to see all their supported models populate automatically.
|
||||
- Plugins: Functions Agent works with OpenRouter when using OpenAI models.
|
||||
- Plugins: Turn functions off to try plugins with non-OpenAI models (ChatGPT plugins will not work and others may not work as expected).
|
||||
- Plugins: Make sure `PLUGINS_USE_AZURE` is not set in your .env file when wanting to use OpenRouter and you have Azure configured.
|
||||
|
||||
> ⚠️ OpenRouter is in a category of its own, and is highly recommended over the "free" services below. NagaAI and other 'free' API proxies tend to have intermittent issues, data leaks, and/or problems with the guidelines of the platforms they advertise on. Use the below at your own risk.
|
||||
> ⚠️ [OpenRouter](./ai_setup.md#openrouter) is in a category of its own, and is highly recommended over the "free" services below. NagaAI and other 'free' API proxies tend to have intermittent issues, data leaks, and/or problems with the guidelines of the platforms they advertise on. Use the below at your own risk.
|
||||
|
||||
### NagaAI
|
||||
|
||||
18
docs/install/configuration/index.md
Normal file
18
docs/install/configuration/index.md
Normal file
|
|
@ -0,0 +1,18 @@
|
|||
---
|
||||
title: Configuration
|
||||
weight: 2
|
||||
---
|
||||
|
||||
# Configuration
|
||||
|
||||
* ⚙️ [Environment Variables](./dotenv.md)
|
||||
* 🐋 [Docker Compose Override](./docker_override.md)
|
||||
---
|
||||
* 🤖 [AI Setup](./ai_setup.md)
|
||||
* 🚅 [LiteLLM](./litellm.md)
|
||||
* 💸 [Free AI APIs](./free_ai_apis.md)
|
||||
---
|
||||
* 🛂 [Authentication System](./user_auth_system.md)
|
||||
* 🍃 [Online MongoDB](./mongodb.md)
|
||||
* 🌍 [Default Language](./default_language.md)
|
||||
* 🌀 [Miscellaneous](./misc.md)
|
||||
|
|
@ -1,9 +1,16 @@
|
|||
---
|
||||
title: 🚅 LiteLLM
|
||||
weight: -7
|
||||
---
|
||||
|
||||
# Using LibreChat with LiteLLM Proxy
|
||||
Use LiteLLM Proxy for:
|
||||
Use [LiteLLM Proxy](https://docs.litellm.ai/docs/simple_proxy) for:
|
||||
* Calling 100+ LLMs Huggingface/Bedrock/TogetherAI/etc. in the OpenAI ChatCompletions & Completions format
|
||||
* Load balancing - between Multiple Models + Deployments of the same model LiteLLM proxy can handle 1k+ requests/second during load tests
|
||||
* Authentication & Spend Tracking Virtual Keys
|
||||
|
||||
https://docs.litellm.ai/docs/simple_proxy
|
||||
|
||||
## Start LiteLLM Proxy Server
|
||||
### Pip install litellm
|
||||
```shell
|
||||
|
|
@ -1,3 +1,9 @@
|
|||
---
|
||||
title: 🌀 Miscellaneous
|
||||
weight: -2
|
||||
author: danny-avila and jerkstorecaller
|
||||
---
|
||||
|
||||
As LibreChat has varying use cases and environment possibilities, this page will host niche setup/configurations, as contributed by the community, that are not better delegated to any of the other guides.
|
||||
|
||||
# Using LibreChat behind a reverse proxy with Basic Authentication
|
||||
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: 🍃 Online MongoDB
|
||||
weight: -4
|
||||
---
|
||||
|
||||
# Set Up an Online MongoDB Database
|
||||
|
||||
## Create an account
|
||||
576
docs/install/configuration/user_auth_system.md
Normal file
576
docs/install/configuration/user_auth_system.md
Normal file
|
|
@ -0,0 +1,576 @@
|
|||
---
|
||||
title: 🛂 Authentication System
|
||||
weight: -5
|
||||
---
|
||||
|
||||
# User Authentication System
|
||||
|
||||
LibreChat has a user authentication system that allows users to sign up and log in securely and easily. The system is scalable and can handle a large number of concurrent users without compromising performance or security.
|
||||
|
||||
By default, we have email signup and login enabled, which means users can create an account using their email address and a password. They can also reset their password if they forget it.
|
||||
|
||||
Additionally, our system can integrate social logins from various platforms such as Google, GitHub, Discord, OpenID, and more. This means users can log in using their existing accounts on these platforms, without having to create a new account or remember another password.
|
||||
|
||||
>❗**Important:** When you run the app for the first time, you need to create a new account by clicking on "Sign up" on the login page. The first account you make will be the admin account. The admin account doesn't have any special features right now, but it might be useful if you want to make an admin dashboard to manage other users later.
|
||||
|
||||
>> **Note:** The first account created should ideally be a local account (email and password).
|
||||
|
||||
## Basic Configuration:
|
||||
|
||||
### General
|
||||
|
||||
Here's an overview of the general configuration, located in the `.env` file at the root of the LibreChat folder.
|
||||
|
||||
- `ALLOW_EMAIL_LOGIN`: Email login. Set to `true` or `false` to enable or disable ONLY email login.
|
||||
- `ALLOW_REGISTRATION`: Email registration of new users. Set to `true` or `false` to enable or disable Email registration.
|
||||
- `ALLOW_SOCIAL_LOGIN`: Allow users to connect to LibreChat with various social networks, see below. Set to `true` or `false` to enable or disable.
|
||||
- `ALLOW_SOCIAL_REGISTRATION`: Enable or disable registration of new user using various social network. Set to `true` or `false` to enable or disable.
|
||||
|
||||
> **Note:** OpenID does not support the ability to disable only registration.
|
||||
|
||||
>> **Quick Tip:** Even with registration disabled, add users directly to the database using `npm run create-user`. If you can't get npm to work, try `sudo docker exec -ti LibreChat sh` first to "ssh" into the container.
|
||||
|
||||
|
||||
|
||||
```bash
|
||||
ALLOW_EMAIL_LOGIN=true
|
||||
ALLOW_REGISTRATION=true
|
||||
ALLOW_SOCIAL_LOGIN=false
|
||||
ALLOW_SOCIAL_REGISTRATION=false
|
||||
```
|
||||
|
||||
### Session Expiry and Refresh Token
|
||||
|
||||
- Default values: session expiry: 15 minutes, refresh token expiry: 7 days
|
||||
- For more information: [Refresh Token](https://github.com/danny-avila/LibreChat/pull/927)
|
||||
|
||||
```bash
|
||||
SESSION_EXPIRY=1000 * 60 * 15
|
||||
REFRESH_TOKEN_EXPIRY=(1000 * 60 * 60 * 24) * 7
|
||||
```
|
||||
|
||||
``` mermaid
|
||||
sequenceDiagram
|
||||
Client->>Server: Login request with credentials
|
||||
Server->>Passport: Use authentication strategy (e.g., 'local', 'google', etc.)
|
||||
Passport-->>Server: User object or false/error
|
||||
Note over Server: If valid user...
|
||||
Server->>Server: Generate access and refresh tokens
|
||||
Server->>Database: Store hashed refresh token
|
||||
Server-->>Client: Access token and refresh token
|
||||
Client->>Client: Store access token in HTTP Header and refresh token in HttpOnly cookie
|
||||
Client->>Server: Request with access token from HTTP Header
|
||||
Server-->>Client: Requested data
|
||||
Note over Client,Server: Access token expires
|
||||
Client->>Server: Request with expired access token
|
||||
Server-->>Client: Unauthorized
|
||||
Client->>Server: Request with refresh token from HttpOnly cookie
|
||||
Server->>Database: Retrieve hashed refresh token
|
||||
Server->>Server: Compare hash of provided refresh token with stored hash
|
||||
Note over Server: If hashes match...
|
||||
Server-->>Client: New access token and refresh token
|
||||
Client->>Server: Retry request with new access token
|
||||
Server-->>Client: Requested data
|
||||
```
|
||||
|
||||
### JWT Secret and Refresh Secret
|
||||
|
||||
- You should use new secure values. The examples given are 32-byte keys (64 characters in hex).
|
||||
- Use this replit to generate some quickly: [JWT Keys](https://replit.com/@daavila/crypto#index.js)
|
||||
|
||||
```bash
|
||||
JWT_SECRET=16f8c0ef4a5d391b26034086c628469d3f9f497f08163ab9b40137092f2909ef
|
||||
JWT_REFRESH_SECRET=eaa5191f2914e30b9387fd84e254e4ba6fc51b4654968a9b0803b456a54b8418
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Automated Moderation System (optional)
|
||||
|
||||
The Automated Moderation System is enabled by default. It uses a scoring mechanism to track user violations. As users commit actions like excessive logins, registrations, or messaging, they accumulate violation scores. Upon reaching a set threshold, the user and their IP are temporarily banned. This system ensures platform security by monitoring and penalizing rapid or suspicious activities.
|
||||
|
||||
To set up the mod system, review [the setup guide](../../features/mod_system.md).
|
||||
|
||||
> *Please Note: If you want this to work in development mode, you will need to create a file called `.env.development` in the root directory and set `DOMAIN_CLIENT` to `http://localhost:3090` or whatever port is provided by vite when runnning `npm run frontend-dev`*
|
||||
|
||||
---
|
||||
|
||||
## **Email and Password Reset**
|
||||
|
||||
### General setup
|
||||
|
||||
in the .env file modify these variables:
|
||||
|
||||
```
|
||||
EMAIL_SERVICE= # eg. gmail - see https://community.nodemailer.com/2-0-0-beta/setup-smtp/well-known-services/
|
||||
EMAIL_HOST= # eg. example.com - if EMAIL_SERVICE is not set, connect to this server.
|
||||
EMAIL_PORT=25 # eg. 25 - mail server port to connect to with EMAIL_HOST (usually 25, 465, 587)
|
||||
EMAIL_ENCRYPTION= # eg. starttls - valid values: starttls (force STARTTLS), tls (obligatory TLS), anything else (use STARTTLS if available)
|
||||
EMAIL_ENCRYPTION_HOSTNAME= # eg. example.com - check the name in the certificate against this instead of EMAIL_HOST
|
||||
EMAIL_ALLOW_SELFSIGNED= # eg. true - valid values: true (allow self-signed), anything else (disallow self-signed)
|
||||
EMAIL_USERNAME= # eg. me@gmail.com - the username used for authentication. For consumer services, this MUST usually match EMAIL_FROM.
|
||||
EMAIL_PASSWORD= # eg. password - the password used for authentication
|
||||
EMAIL_FROM_NAME= # eg. LibreChat - the human-readable address in the From is constructed as "EMAIL_FROM_NAME <EMAIL_FROM>". Defaults to APP_TITLE.
|
||||
```
|
||||
|
||||
If you want to use one of the predefined services, configure only these variables:
|
||||
|
||||
EMAIL\_SERVICE is the name of the email service you are using (Gmail, Outlook, Yahoo Mail, ProtonMail, iCloud Mail, etc.) as defined in the NodeMailer well-known services linked above.
|
||||
EMAIL\_USERNAME is the username of the email service (usually, it will be the email address, but in some cases, it can be an actual username used to access the account).
|
||||
EMAIL\_PASSWORD is the password used to access the email service. This is not the password to access the email account directly, but a password specifically generated for this service.
|
||||
EMAIL\_FROM is the email address that will appear in the "from" field when a user receives an email.
|
||||
EMAIL\_FROM\_NAME is the name that will appear in the "from" field when a user receives an email. If left unset, it defaults to the app title.
|
||||
|
||||
If you want to use a generic SMTP service or need advanced configuration for one of the predefined providers, configure these variables:
|
||||
|
||||
EMAIL\_HOST is the hostname to connect to, or an IP address.
|
||||
EMAIL\_PORT is the port to connect to. Be aware that different ports usually come with different requirements - 25 is for mailserver-to-mailserver, 465 requires encryption at the start of the connection, and 587 allows submission of mail as a user.
|
||||
EMAIL\_ENCRYPTION defines if encryption is required at the start (`tls`) or started after the connection is set up (`starttls`). If either of these values are set, they are enforced. If they are not set, an encrypted connection is started if available.
|
||||
EMAIL\_ENCRYPTION\_HOSTNAME allows specification of a hostname against which the certificate is validated. Use this if the mail server does have a valid certificate, but you are connecting with an IP or a different name for some reason.
|
||||
EMAIL\_ALLOW\_SELFSIGNED defines whether self-signed certificates can be accepted from the server. As the mails being sent contain sensitive information, ONLY use this for testing.
|
||||
|
||||
NOTE: ⚠️ **Failing to perform either of the below setups will result in LibreChat using the unsecured password reset! This allows anyone to reset any password on your server immediately, without mail being sent at all!** The variable EMAIL\_FROM does not support all email providers **but is still required**. To stay updated, check the bug fixes [here](https://github.com/danny-avila/LibreChat/tags).
|
||||
|
||||
### Setup with Gmail
|
||||
|
||||
1. Create a Google Account and enable 2-step verification.
|
||||
2. In the [Google Account settings](https://myaccount.google.com/), click on the "Security" tab and open "2-step verification."
|
||||
3. Scroll down and open "App passwords." Choose "Mail" for the app and select "Other" for the device, then give it a random name.
|
||||
4. Click on "Generate" to create a password, and copy the generated password.
|
||||
5. In the .env file, modify the variables as follows:
|
||||
|
||||
```
|
||||
EMAIL_SERVICE=gmail
|
||||
EMAIL_USERNAME=your-email
|
||||
EMAIL_PASSWORD=your-app-password
|
||||
EMAIL_FROM=email address for the from field, e.g., noreply@librechat.ai
|
||||
EMAIL_FROM_NAME="My LibreChat Server"
|
||||
```
|
||||
|
||||
### Setup with custom mail server
|
||||
|
||||
1. Gather your SMTP login data from your provider. The steps are different for each, but they will usually list values for all variables.
|
||||
2. In the .env file, modify the variables as follows, assuming some sensible example values:
|
||||
|
||||
```
|
||||
EMAIL_HOST=mail.example.com
|
||||
EMAIL_PORT=587
|
||||
EMAIL_ENCRYPTION=starttls
|
||||
EMAIL_USERNAME=your-email
|
||||
EMAIL_PASSWORD=your-app-password
|
||||
EMAIL_FROM=email address for the from field, e.g., noreply@librechat.ai
|
||||
EMAIL_FROM_NAME="My LibreChat Server"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Social Authentication - Setup and Configuration
|
||||
|
||||
|
||||
|
||||
### Discord
|
||||
|
||||
#### Create a new Discord Application
|
||||
|
||||
- Go to **[Discord Developer Portal](https://discord.com/developers)**
|
||||
|
||||
- Create a new Application and give it a name
|
||||
|
||||
|
||||
|
||||
#### Discord Application Configuration
|
||||
|
||||
- In the OAuth2 general settings add a valid redirect URL:
|
||||
- Example for localhost: `http://localhost:3080/oauth/discord/callback`
|
||||
- Example for a domain: `https://example.com/oauth/discord/callback`
|
||||
|
||||
|
||||
|
||||
- In `Default Authorization Link`, select `In-app Authorization` and set the scopes to `applications.commands`
|
||||
|
||||
|
||||
|
||||
- Save changes and reset the Client Secret
|
||||
|
||||
|
||||
|
||||
|
||||
#### .env Configuration
|
||||
|
||||
- Paste your `Client ID` and `Client Secret` in the `.env` file:
|
||||
|
||||
```bash
|
||||
DISCORD_CLIENT_ID=your_client_id
|
||||
DISCORD_CLIENT_SECRET=your_client_secret
|
||||
DISCORD_CALLBACK_URL=/oauth/discord/callback
|
||||
```
|
||||
|
||||
- Save the `.env` file
|
||||
|
||||
> Note: If using docker, run `docker-compose up -d` to apply the .env configuration changes
|
||||
|
||||
---
|
||||
|
||||
### Facebook - WIP
|
||||
|
||||
> ⚠️ **Warning: Work in progress, not currently functional**
|
||||
|
||||
> ❗ Note: Facebook Authentication will not work from `localhost`
|
||||
|
||||
#### Create a Facebook Application
|
||||
|
||||
- Go to the **[Facebook Developer Portal](https://developers.facebook.com/)**
|
||||
|
||||
- Click on "My Apps" in the header menu
|
||||
|
||||
|
||||
|
||||
- Create a new application
|
||||
|
||||
|
||||
|
||||
- Select "Authenticate and request data from users with Facebook Login"
|
||||
|
||||
|
||||
|
||||
- Choose "No, I'm not creating a game"
|
||||
|
||||
|
||||
|
||||
- Provide an `app name` and `App contact email` and click `Create app`
|
||||
|
||||
|
||||
|
||||
#### Facebook Application Configuration
|
||||
|
||||
- In the side menu, select "Use cases" and click "Customize" under "Authentication and account creation."
|
||||
|
||||
|
||||
|
||||
- Add the `email permission`
|
||||
|
||||
|
||||
|
||||
- Now click `Go to settings`
|
||||
|
||||
|
||||
|
||||
- Ensure that `Client OAuth login`, `Web OAuth login` and `Enforce HTTPS` are **enabled**.
|
||||
|
||||
|
||||
|
||||
- Add a `Valid OAuth Redirect URIs` and "Save changes"
|
||||
- Example for a domain: `https://example.com/oauth/facebook/callback`
|
||||
|
||||
|
||||
|
||||
- Click `Go back` and select `Basic` in the `App settings` tab
|
||||
|
||||
|
||||
|
||||
- Click "Show" next to the App secret.
|
||||
|
||||
|
||||
|
||||
#### .env Configuration
|
||||
|
||||
- Copy the `App ID` and `App Secret` and paste them into the `.env` file as follows:
|
||||
|
||||
```bash
|
||||
FACEBOOK_CLIENT_ID=your_app_id
|
||||
FACEBOOK_CLIENT_SECRET=your_app_secret
|
||||
FACEBOOK_CALLBACK_URL=/oauth/facebook/callback
|
||||
```
|
||||
|
||||
- Save the `.env` file.
|
||||
|
||||
> Note: If using docker, run `docker-compose up -d` to apply the .env configuration changes
|
||||
|
||||
---
|
||||
|
||||
### GitHub
|
||||
|
||||
#### Create a GitHub Application
|
||||
|
||||
- Go to your **[Github Developer settings](https://github.com/settings/apps)**
|
||||
- Create a new Github app
|
||||
|
||||
|
||||
|
||||
#### GitHub Application Configuration
|
||||
|
||||
- Give it a `GitHub App name` and set your `Homepage URL`
|
||||
- Example for localhost: `http://localhost:3080`
|
||||
- Example for a domain: `https://example.com`
|
||||
|
||||
|
||||
|
||||
- Add a valid `Callback URL`:
|
||||
- Example for localhost: `http://localhost:3080/oauth/github/callback`
|
||||
- Example for a domain: `https://example.com/oauth/github/callback`
|
||||
|
||||
|
||||
|
||||
- Uncheck the box labeled `Active` in the `Webhook` section
|
||||
|
||||
|
||||
|
||||
- Scroll down to `Account permissions` and set `Email addresses` to `Access: Read-only`
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
- Click on `Create GitHub App`
|
||||
|
||||
|
||||
|
||||
#### .env Configuration
|
||||
|
||||
- Click `Generate a new client secret`
|
||||
|
||||
|
||||
|
||||
- Copy the `Client ID` and `Client Secret` in the `.env` file
|
||||
|
||||
|
||||
|
||||
```bash
|
||||
GITHUB_CLIENT_ID=your_client_id
|
||||
GITHUB_CLIENT_SECRET=your_client_secret
|
||||
GITHUB_CALLBACK_URL=/oauth/github/callback
|
||||
```
|
||||
|
||||
- Save the `.env` file
|
||||
|
||||
> Note: If using docker, run `docker-compose up -d` to apply the .env configuration changes
|
||||
|
||||
---
|
||||
|
||||
### Google
|
||||
|
||||
#### Create a Google Application
|
||||
|
||||
- Visit: **[Google Cloud Console](https://cloud.google.com)** and open the `Console`
|
||||
|
||||
|
||||
|
||||
- Create a New Project and give it a name
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
#### Google Application Configuration
|
||||
|
||||
- Select the project you just created and go to `APIs and Services`
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
- Select `Credentials` and click `CONFIGURE CONSENT SCREEN`
|
||||
|
||||
|
||||
|
||||
- Select `External` then click `CREATE`
|
||||
|
||||
|
||||
|
||||
- Fill in your App information
|
||||
|
||||
> Note: You can get a logo from your LibreChat folder here: `docs\assets\favicon_package\android-chrome-192x192.png`
|
||||
|
||||
|
||||
|
||||
- Configure your `App domain` and add your `Developer contact information` then click `SAVE AND CONTINUE`
|
||||
|
||||
|
||||
|
||||
- Configure the `Sopes`
|
||||
- Add `email`,`profile` and `openid`
|
||||
- Click `UPDATE` and `SAVE AND CONTINUE`
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
- Click `SAVE AND CONTINUE`
|
||||
- Review your app and go back to dashboard
|
||||
|
||||
- Go back to the `Credentials` tab, click on `+ CREATE CREDENTIALS` and select `OAuth client ID`
|
||||
|
||||
|
||||
|
||||
- Select `Web application` and give it a name
|
||||
|
||||
|
||||
|
||||
- Configure the `Authorized JavaScript origins`, you can add both your domain and localhost if you desire
|
||||
- Example for localhost: `http://localhost:3080`
|
||||
- Example for a domain: `https://example.com`
|
||||
|
||||
|
||||
|
||||
- Add a valid `Authorized redirect URIs`
|
||||
- Example for localhost: `http://localhost:3080/oauth/google/callback`
|
||||
- Example for a domain: `https://example.com/oauth/google/callback`
|
||||
|
||||
|
||||
|
||||
#### .env Configuration
|
||||
|
||||
- Click `CREATE` and copy your `Client ID` and `Client secret`
|
||||
|
||||
|
||||
|
||||
- Add them to your `.env` file:
|
||||
|
||||
```bash
|
||||
GOOGLE_CLIENT_ID=your_client_id
|
||||
GOOGLE_CLIENT_SECRET=your_client_secret
|
||||
GOOGLE_CALLBACK_URL=/oauth/github/callback
|
||||
```
|
||||
|
||||
- Save the `.env` file
|
||||
|
||||
> Note: If using docker, run `docker-compose up -d` to apply the .env configuration changes
|
||||
|
||||
---
|
||||
|
||||
### OpenID with AWS Cognito
|
||||
|
||||
#### Create a new User Pool in Cognito
|
||||
|
||||
- Visit: **[https://console.aws.amazon.com/cognito/](https://console.aws.amazon.com/cognito/)**
|
||||
- Sign in as Root User
|
||||
- Click on `Create user pool`
|
||||
|
||||
|
||||
|
||||
#### Configure sign-in experience
|
||||
|
||||
Your Cognito user pool sign-in options should include `User Name` and `Email`.
|
||||
|
||||
|
||||
|
||||
#### Configure Security Requirements
|
||||
|
||||
You can configure the password requirements now if you desire
|
||||
|
||||
|
||||
|
||||
#### Configure sign-up experience
|
||||
|
||||
Choose the attributes required at signup. The minimum required is `name`. If you want to require users to use their full name at sign up use: `given_name` and `family_name` as required attributes.
|
||||
|
||||
|
||||
|
||||
#### Configure message delivery
|
||||
|
||||
Send email with Cognito can be used for free for up to 50 emails a day
|
||||
|
||||
|
||||
|
||||
#### Integrate your app
|
||||
|
||||
Select `Use Cognitio Hosted UI` and chose a domain name
|
||||
|
||||
|
||||
|
||||
Set the app type to `Confidential client`
|
||||
Make sure `Generate a client secret` is set.
|
||||
Set the `Allowed callback URLs` to `https://YOUR_DOMAIN/oauth/openid/callback`
|
||||
|
||||
|
||||
|
||||
Under `Advanced app client settings` make sure `Profile` is included in the `OpenID Connect scopes` (in the bottom)
|
||||
|
||||
|
||||
|
||||
#### Review and create
|
||||
You can now make last minute changes, click on `Create user pool` when you're done reviewing the configuration
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
#### Get your environment variables
|
||||
|
||||
1. Open your User Pool
|
||||
|
||||
|
||||
|
||||
2. The `User Pool ID` and your AWS region will be used to construct the `OPENID_ISSUER` (see below)
|
||||
|
||||
|
||||
|
||||
|
||||
3. Go to the `App Integrations` tab
|
||||
|
||||
|
||||
|
||||
4. Open the app client
|
||||
|
||||
|
||||
|
||||
5. Toggle `Show Client Secret`
|
||||
|
||||
|
||||
|
||||
- Use the `Client ID` for `OPENID_CLIENT_ID`
|
||||
|
||||
- Use the `Client secret` for `OPENID_CLIENT_SECRET`
|
||||
|
||||
- Generate a random string for the `OPENID_SESSION_SECRET`
|
||||
|
||||
> The `OPENID_SCOPE` and `OPENID_CALLBACK_URL` are pre-configured with the correct values
|
||||
|
||||
6. Open the `.env` file at the root of your LibreChat folder and add the following variables with the values you copied:
|
||||
|
||||
```bash
|
||||
OPENID_CLIENT_ID=Your client ID
|
||||
OPENID_CLIENT_SECRET=Your client secret
|
||||
OPENID_ISSUER=https://cognito-idp.[AWS REGION].amazonaws.com/[USER POOL ID]/.well-known/openid-configuration
|
||||
OPENID_SESSION_SECRET=Any random string
|
||||
OPENID_SCOPE=openid profile email
|
||||
OPENID_CALLBACK_URL=/oauth/openid/callback
|
||||
```
|
||||
7. Save the .env file
|
||||
|
||||
> Note: If using docker, run `docker-compose up -d` to apply the .env configuration changes
|
||||
|
||||
|
||||
---
|
||||
|
||||
### OpenID with Azure AD
|
||||
|
||||
1. Go to the [Azure Portal](https://portal.azure.com/) and sign in with your account.
|
||||
2. In the search box, type "Azure Active Directory" and click on it.
|
||||
3. On the left menu, click on App registrations and then on New registration.
|
||||
4. Give your app a name and select Web as the platform type.
|
||||
5. In the Redirect URI field, enter `http://localhost:3080/oauth/openid/callback` and click on Register.
|
||||
6. You will see an Overview page with some information about your app. Copy the Application (client) ID and the Directory (tenant) ID and save them somewhere.
|
||||
7. On the left menu, click on Authentication and check the boxes for Access tokens and ID tokens under Implicit grant and hybrid flows.
|
||||
8. On the left menu, click on Certificates & Secrets and then on New client secret. Give your secret a name and an expiration date and click on Add.
|
||||
9. You will see a Value column with your secret. Copy it and save it somewhere. Don't share it with anyone!
|
||||
10. Open the .env file in your project folder and add the following variables with the values you copied:
|
||||
|
||||
```bash
|
||||
OPENID_CLIENT_ID=Your Application (client) ID
|
||||
OPENID_CLIENT_SECRET=Your client secret
|
||||
OPENID_ISSUER=https://login.microsoftonline.com/Your Directory (tenant ID)/v2.0/
|
||||
OPENID_SESSION_SECRET=Any random string
|
||||
OPENID_SCOPE=openid profile email #DO NOT CHANGE THIS
|
||||
OPENID_CALLBACK_URL=/oauth/openid/callback # this should be the same for everyone
|
||||
```
|
||||
11. Save the .env file
|
||||
|
||||
> Note: If using docker, run `docker-compose up -d` to apply the .env configuration changes
|
||||
|
||||
|
||||
---
|
||||
26
docs/install/index.md
Normal file
26
docs/install/index.md
Normal file
|
|
@ -0,0 +1,26 @@
|
|||
---
|
||||
title: Installation and Configuration
|
||||
weight: 1
|
||||
---
|
||||
|
||||
# Installation and Configuration
|
||||
|
||||
## **[Installation](./installation/index.md)**
|
||||
|
||||
* 🐳 [Docker Compose (✨ Recommended)](./installation/docker_compose_install.md)
|
||||
* 🦦 [Container (podman)](./installation/container_install.md)
|
||||
* 🐧 [Linux](./installation/linux_install.md)
|
||||
* 🍎 [Mac](./installation/mac_install.md)
|
||||
* 🪟 [Windows](./installation/windows_install.md)
|
||||
|
||||
## **[Configuration](./configuration/index.md)**
|
||||
|
||||
* ⚙️ [Environment Variables](./configuration/dotenv.md)
|
||||
* 🐋 [Docker Compose Override](./configuration/docker_override.md)
|
||||
* 🤖 [AI Setup](./configuration/ai_setup.md)
|
||||
* 🚅 [LiteLLM](./configuration/litellm.md)
|
||||
* 💸 [Free AI APIs](./configuration/free_ai_apis.md)
|
||||
* 🛂 [Authentication System](./configuration/user_auth_system.md)
|
||||
* 🍃 [Online MongoDB](./configuration/mongodb.md)
|
||||
* 🌍 [Default Language](./configuration/default_language.md)
|
||||
* 🌀 [Miscellaneous](./configuration/misc.md)
|
||||
|
|
@ -1,12 +1,15 @@
|
|||
---
|
||||
title: 🦦 Container (podman)
|
||||
weight: 0
|
||||
---
|
||||
|
||||
# Container installation guide
|
||||
# Container Installation Guide (podman)
|
||||
|
||||
If you don't like docker compose, don't want a bare-metal installation, but still want to leverage the benefits from the isolation and modularity of containers - this is the guide you should use.
|
||||
|
||||
> Likewise, If you are actively developing LibreChat, aren't using the service productively (i.e production environments), you should avoid this guide and look to something easier to work with such as docker compose.
|
||||
|
||||
**Important:** `docker` and `podman` commands are for the most part, interoperable and interchangeable. Since podman should be the better "Libre" choice, code instructions below will use (and heavily favor) `podman` - and some commands will need to be tweaked to compensate for this.
|
||||
|
||||
**Important:** `docker` and `podman` commands are for the most part, interoperable and interchangeable. The code instructions below will use (and heavily favor) `podman`.
|
||||
|
||||
## Creating the base image
|
||||
|
||||
|
|
@ -45,7 +48,7 @@ cp ./LibreChat/.env.example .env
|
|||
|
||||
This will add the env file to the top level directory that we will create the containers, allowing us to pass it easily as via the `--env-file` command argument.
|
||||
|
||||
Follow [this guide](https://docs.librechat.ai/install/free_ai_apis.html) to populate the containers with the correct env values for various apis. There are other env values of interest that might be worth changing, documented within the env itself. Afterwords, edit the following lines in the `.env` file.
|
||||
Follow [this guide](../configuration/ai_setup.md) to populate the containers with the correct env values for various apis. There are other env values of interest that might be worth changing, documented within the env itself. Afterwords, edit the following lines in the `.env` file.
|
||||
|
||||
```
|
||||
HOST=0.0.0.0
|
||||
|
|
@ -1,8 +1,14 @@
|
|||
---
|
||||
title: 🐳 Docker Compose ✨(Recommended)
|
||||
weight: -10
|
||||
---
|
||||
|
||||
# Docker Compose Installation Guide
|
||||
|
||||
Docker Compose installation is recommended for most use cases. It's the easiest, simplest, and most reliable method to get started.
|
||||
|
||||
See the video guide for [Windows](windows_install.md#recommended) or [Ubuntu 22.04 LTS](linux_install.md#recommended)
|
||||
If you prefer to watch a video, we have video guides for [Windows](./windows_install.md#recommended) and [Ubuntu 22.04 LTS](./linux_install.md#recommended)
|
||||
|
||||
## Installation and Configuration
|
||||
|
||||
### Preparation
|
||||
|
|
@ -23,13 +29,13 @@ Before running LibreChat with Docker, you need to configure some settings:
|
|||
- Provide all necessary credentials in the `.env` file before the next step.
|
||||
- Docker will read this env file. See the `.env.example` file for reference.
|
||||
|
||||
#### [AI Setup](ai_setup.md) (Required)
|
||||
#### [AI Setup](../configuration/ai_setup.md) (Required)
|
||||
At least one AI endpoint should be setup for use.
|
||||
|
||||
#### [Manage Your MongoDB Database](../features/manage_your_database.md) (Optional)
|
||||
#### [Manage Your MongoDB Database](../../features/manage_your_database.md) (Optional)
|
||||
Safely access and manage your MongoDB database using Mongo Express
|
||||
|
||||
#### [User Authentication System Setup](../install/user_auth_system.md) (Optional)
|
||||
#### [User Authentication System Setup](../configuration/user_auth_system.md) (Optional)
|
||||
How to set up the user/auth system and Google login.
|
||||
|
||||
### Running LibreChat
|
||||
|
|
@ -75,7 +81,23 @@ docker-compose up
|
|||
|
||||
### Config notes for docker-compose.yml file
|
||||
|
||||
Modification to the `docker-compose.yml` should be made with `docker-compose.override.yml` whenever possible to prevent conflicts when updating. You can create a new file named `docker-compose.override.yml` in the same directory as your main `docker-compose.yml` file for LibreChat, where you can set your .env variables as needed under `environment`, or modify the default configuration provided by the main `docker-compose.yml`, without the need to directly edit or duplicate the whole file.
|
||||
|
||||
For more info see:
|
||||
|
||||
- Our quick guide:
|
||||
- **[Docker Override](../configuration/docker_override.md)**
|
||||
|
||||
- The official docker documentation:
|
||||
- **[docker docs - understanding-multiple-compose-files](https://docs.docker.com/compose/multiple-compose-files/extends/#understanding-multiple-compose-files)**
|
||||
- **[docker docs - merge-compose-files](https://docs.docker.com/compose/multiple-compose-files/merge/#merge-compose-files)**
|
||||
- **[docker docs - specifying-multiple-compose-files](https://docs.docker.com/compose/reference/#specifying-multiple-compose-files)**
|
||||
|
||||
- You can also view an example of an override file for LibreChat in your LibreChat folder and on GitHub:
|
||||
- **[docker-compose.override.example](https://github.com/danny-avila/LibreChat/blob/main/docker-compose.override.yaml.example)**
|
||||
|
||||
- Any environment variables set in your compose file will override variables with the same name in your .env file. Note that the following variables are necessary to include in the compose file so they work in the docker environment, so they are included for you.
|
||||
|
||||
```yaml
|
||||
env_file:
|
||||
- .env
|
||||
|
|
@ -91,55 +113,27 @@ docker-compose up
|
|||
environment:
|
||||
- MEILI_HOST=http://meilisearch:7700
|
||||
- MEILI_HTTP_ADDR=meilisearch:7700
|
||||
```
|
||||
- If you'd like to change the app title, edit the following lines (the ones in your .env file are not read during building)
|
||||
```yaml
|
||||
args:
|
||||
APP_TITLE: LibreChat # default, change to your desired app name
|
||||
```
|
||||
|
||||
- If for some reason you're not able to build the app image, you can pull the latest image from **Dockerhub**.
|
||||
- Comment out the following lines (CTRL+/ on most IDEs, or put a `#` in front each line)
|
||||
|
||||
- Create a new file named `docker-compose.override.yml` in the same directory as your main `docker-compose.yml` with this content:
|
||||
|
||||
```yaml
|
||||
image: node # Comment this & uncomment below to build from docker hub image
|
||||
build:
|
||||
context: .
|
||||
target: node
|
||||
args:
|
||||
APP_TITLE: LibreChat # default, change to your desired app name
|
||||
version: '3.4'
|
||||
|
||||
services:
|
||||
api:
|
||||
image: ghcr.io/danny-avila/librechat-dev:latest
|
||||
```
|
||||
|
||||
- Comment this line in (remove the `#` key)
|
||||
- Then use `docker-compose build` as you would normally
|
||||
|
||||
- **Note:** There are different Dockerhub images. the `librechat:latest` image is only updated with new release tags, so it may not have the latest changes to the main branch. To get the latest changes you can use `librechat-dev:latest` instead
|
||||
|
||||
```yaml
|
||||
# image: ghcr.io/danny-avila/librechat:latest # Uncomment this & comment above to build from docker hub image
|
||||
```
|
||||
- **Note:** The latest Dockerhub image is only updated with new release tags, so it may not have the latest changes to the main branch
|
||||
- You also can't edit the title or toggle google login off as shown above, as these variables are set during build time.
|
||||
- If you are running APIs in other docker containers that you need access to, you will need to uncomment the following lines
|
||||
|
||||
```yaml
|
||||
# extra_hosts: # if you are running APIs on docker you need access to, you will need to uncomment this line and next
|
||||
# - "host.docker.internal:host-gateway"
|
||||
```
|
||||
|
||||
- Usually, these are reverse proxies, which you can set as shown below under `environment:`
|
||||
|
||||
|
||||
```yaml
|
||||
environment:
|
||||
- HOST=0.0.0.0
|
||||
- MONGO_URI=mongodb://mongodb:27017/LibreChat
|
||||
- CHATGPT_REVERSE_PROXY=http://host.docker.internal:8080/api/conversation # if you are hosting your own chatgpt reverse proxy with docker
|
||||
- OPENAI_REVERSE_PROXY=http://host.docker.internal:8070/v1/chat/completions # if you are hosting your own chatgpt reverse proxy with docker
|
||||
```
|
||||
|
||||
### **[LibreChat on Docker Hub](https://hub.docker.com/r/chatgptclone/app/tags)**
|
||||
|
||||
### **[Create a MongoDB database](mongodb.md)** (Not required if you'd like to use the local database installed by Docker)
|
||||
### **[Create a MongoDB database](../configuration/mongodb.md)** (Not required if you'd like to use the local database installed by Docker)
|
||||
|
||||
---
|
||||
|
||||
11
docs/install/installation/index.md
Normal file
11
docs/install/installation/index.md
Normal file
|
|
@ -0,0 +1,11 @@
|
|||
---
|
||||
title: Installation
|
||||
weight: 1
|
||||
---
|
||||
|
||||
# Installation
|
||||
* 🐳 [Docker Compose (✨ Recommended)](docker_compose_install.md)
|
||||
* 🦦 [Container (podman)](container_install.md)
|
||||
* 🐧 [Linux](linux_install.md)
|
||||
* 🍎 [Mac](mac_install.md)
|
||||
* 🪟 [Windows](windows_install.md)
|
||||
|
|
@ -1,3 +1,7 @@
|
|||
---
|
||||
title: 🐧 Linux
|
||||
weight: 0
|
||||
---
|
||||
# Linux Installation Guide
|
||||
## **Recommended:**
|
||||
|
||||
|
|
@ -32,13 +36,14 @@ Here are the steps to follow:
|
|||
|
||||
Note: If you run the command on the same computer and want to access it, navigate to `localhost:3080`. You should see a login page where you can create or sign in to your account. Then you can choose an AI model and start chatting.
|
||||
|
||||
- [Manage Your MongoDB Database (optional)](../features/manage_your_database.md)
|
||||
- [Manage Your MongoDB Database (optional)](../../features/manage_your_database.md)
|
||||
Safely access and manage your MongoDB database using Mongo Express
|
||||
|
||||
Have fun!
|
||||
|
||||
---
|
||||
## **[Docker Install](docker_compose_install.md)** (General documentation)
|
||||
> Note: See the [Docker Compose Install Guide](./docker_compose_install.md) for more details
|
||||
- 👆 Docker Compose installation is recommended for most use cases. It's the easiest, simplest, and most reliable method to get started.
|
||||
|
||||
---
|
||||
|
||||
## **Manual Installation:**
|
||||
|
|
@ -89,12 +94,12 @@ curl -fsSL https://deb.nodesource.com/setup_lts.x | sudo -E bash -
|
|||
sudo apt-get install -y nodejs
|
||||
```
|
||||
|
||||
## [Create a MongoDB database](mongodb.md) (Required)
|
||||
## [Create a MongoDB database](../configuration/mongodb.md) (Required)
|
||||
|
||||
## [Setup your AI Endpoints](ai_setup.md) (Required)
|
||||
## [Setup your AI Endpoints](../configuration/ai_setup.md) (Required)
|
||||
- At least one AI endpoint should be setup for use.
|
||||
|
||||
## [User/Auth System](../install/user_auth_system.md) (Optional)
|
||||
## [User/Auth System](../configuration/user_auth_system.md) (Optional)
|
||||
- How to set up the user/auth system and Google login.
|
||||
|
||||
## Run the project
|
||||
|
|
@ -137,28 +142,6 @@ If you're having issues running this command, you can try running what the scrip
|
|||
|
||||
Prefix commands with `sudo` according to your environment permissions.
|
||||
|
||||
### Docker
|
||||
|
||||
```bash
|
||||
# Fetch the latest changes from Github
|
||||
git fetch origin
|
||||
# Switch to the repo's main branch
|
||||
git checkout main
|
||||
# Pull the latest changes to the main branch from Github
|
||||
git pull origin main
|
||||
# Prune all LibreChat Docker images
|
||||
docker rmi librechat:latest
|
||||
# Remove all unused dangling Docker images
|
||||
docker image prune -f
|
||||
# Building a new LibreChat image
|
||||
docker-compose build
|
||||
|
||||
# Start LibreChat
|
||||
docker-compose up
|
||||
```
|
||||
|
||||
### Local (npm)
|
||||
|
||||
```bash
|
||||
# Bash Terminal
|
||||
|
||||
|
|
@ -1,5 +1,11 @@
|
|||
---
|
||||
title: 🍎 Mac
|
||||
weight: 0
|
||||
---
|
||||
|
||||
# Mac Installation Guide
|
||||
## **Recommended : [Docker Install](docker_compose_install.md)**
|
||||
- 👆 Docker Compose installation is recommended for most use cases. It's the easiest, simplest, and most reliable method to get started.
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -12,22 +18,22 @@
|
|||
### Download LibreChat (Required)
|
||||
- Open Terminal and clone the repository by running `git clone https://github.com/danny-avila/LibreChat.git`
|
||||
- Change into the cloned directory by running `cd LibreChat`
|
||||
- Create a .env file in the api directory by running `cp .env.example .env`
|
||||
- Create a .env file by running `cp .env.example .env`
|
||||
- Install dependencies by running: `npm ci`
|
||||
- Build the client by running: `npm run frontend`
|
||||
|
||||
> You will only need to add your `MONGO_URI` (next step) for LibreChat to work. Make sure LibreChat works with the basic configuration first, you can always come back to the `.env` later for advanced configurations. See: [.env configuration](dotenv.md)
|
||||
> You will only need to add your `MONGO_URI` (next step) for LibreChat to work. Make sure LibreChat works with the basic configuration first, you can always come back to the `.env` later for advanced configurations. See: [.env configuration](../configuration/dotenv.md)
|
||||
|
||||
### Create a MongoDB database (Required)
|
||||
- [Create an online MongoDB database](mongodb.md) **or** Install MongoDB by running `brew tap mongodb/brew` and `brew install mongodb-community`
|
||||
- [Create an online MongoDB database](../configuration/mongodb.md) **or** Install MongoDB by running `brew tap mongodb/brew` and `brew install mongodb-community`
|
||||
- add your `MONGO_URI` in the .env file (use vscode or any text editor)
|
||||
|
||||
> Choose only one option, online or brew. Both have pros and cons
|
||||
|
||||
### [Setup your AI Endpoints](ai_setup.md) (Required)
|
||||
### [Setup your AI Endpoints](../configuration/ai_setup.md) (Required)
|
||||
- At least one AI endpoint should be setup for use.
|
||||
|
||||
### [User/Auth System](../install/user_auth_system.md) (Optional)
|
||||
### [User/Auth System](../configuration/user_auth_system.md) (Optional)
|
||||
- Set up the user/auth system and various social logins.
|
||||
|
||||
### **Download MeiliSearch for macOS (Optional):**
|
||||
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: 🪟 Windows
|
||||
weight: 0
|
||||
---
|
||||
|
||||
# Windows Installation Guide
|
||||
|
||||
## **Recommended:**
|
||||
|
|
@ -31,26 +36,30 @@ In this video we're going to install LibreChat on Windows 11 using Docker and Gi
|
|||
- `docker-compose up`
|
||||
- Visit http://localhost:3080/ to access LibreChat. Create an account and start chatting.
|
||||
|
||||
- [Manage Your MongoDB Database (optional)](../features/manage_your_database.md)
|
||||
- [Manage Your MongoDB Database (optional)](../../features/manage_your_database.md)
|
||||
Safely access and manage your MongoDB database using Mongo Express
|
||||
|
||||
Have fun!
|
||||
|
||||
> Note: See the [Docker Compose Install Guide](./docker_compose_install.md) for more details
|
||||
|
||||
- 👆 Docker Compose installation is recommended for most use cases. It's the easiest, simplest, and most reliable method to get started.
|
||||
|
||||
---
|
||||
## **Manual Installation**
|
||||
|
||||
- Install the prerequisites on your machine 👇
|
||||
|
||||
### Download and Install Node.js (Required)
|
||||
|
||||
|
||||
- Navigate to https://nodejs.org/en/download and to download the latest Node.js version for your OS (The Node.js installer includes the NPM package manager.)
|
||||
|
||||
### Download and Install Git (Recommended)
|
||||
- Git: https://git-scm.com/download/win
|
||||
|
||||
### [Create a MongoDB database](mongodb.md) (Required)
|
||||
|
||||
### [Setup your AI Endpoints](ai_setup.md) (Required)
|
||||
### [Create a MongoDB database](../configuration/mongodb.md) (Required)
|
||||
|
||||
### [Setup your AI Endpoints](../configuration/ai_setup.md) (Required)
|
||||
- At least one AI endpoint should be setup for use.
|
||||
|
||||
### Download LibreChat (Required)
|
||||
|
|
@ -61,15 +70,14 @@ Have fun!
|
|||
- **IMPORTANT : If you install the files somewhere else modify the instructions accordingly**
|
||||
|
||||
### Enable the Conversation search feature: (optional)
|
||||
|
||||
|
||||
- Download MeiliSearch latest release from : https://github.com/meilisearch/meilisearch/releases
|
||||
- Copy it to "C:/LibreChat/"
|
||||
- Rename the file to "meilisearch.exe"
|
||||
- Open it by double clicking on it
|
||||
- Copy the generated Master Key and save it somewhere (You will need it later)
|
||||
|
||||
|
||||
### [User/Auth System](../install/user_auth_system.md) (Optional)
|
||||
### [User/Auth System](../configuration/user_auth_system.md) (Optional)
|
||||
- How to set up the user/auth system and Google login.
|
||||
|
||||
## Setup and Run LibreChat
|
||||
|
|
@ -109,28 +117,6 @@ Using the command line (in the root directory)
|
|||
|
||||
If you're having issues running this command, you can try running what the script does manually:
|
||||
|
||||
### Docker
|
||||
|
||||
```bash
|
||||
# Fetch the latest changes from Github
|
||||
git fetch origin
|
||||
# Switch to the repo's main branch
|
||||
git checkout main
|
||||
# Pull the latest changes to the main branch from Github
|
||||
git pull origin main
|
||||
# Prune all LibreChat Docker images
|
||||
docker rmi librechat:latest
|
||||
# Remove all unused dangling Docker images
|
||||
docker image prune -f
|
||||
# Building a new LibreChat image
|
||||
docker-compose build
|
||||
|
||||
# Start LibreChat
|
||||
docker-compose up
|
||||
```
|
||||
|
||||
### Local (npm)
|
||||
|
||||
```powershell
|
||||
# Windows PowerShell terminal
|
||||
|
||||
|
|
@ -1,262 +0,0 @@
|
|||
# User/Auth System
|
||||
|
||||
|
||||
>⚠️ Note: If you're having trouble, before creating a new issue, please search for similar ones on our [#issues thread on our discord](https://discord.gg/weqZFtD9C4) or our [troubleshooting discussion](https://github.com/danny-avila/LibreChat/discussions/categories/troubleshooting) on our Discussions page. If you don't find a relevant issue, feel free to create a new one and provide as much detail as possible.
|
||||
|
||||
## **First Time Setup**
|
||||
|
||||
In order for the auth system to function properly, there are some environment variables that are needed. Note that this information is also included in the [/.env.example](/.env.example) file.
|
||||
|
||||
In /.env, you will need to set the following variables:
|
||||
```bash
|
||||
# Change the secrets to a secure, random string
|
||||
JWT_SECRET=secret
|
||||
JWT_REFRESH_SECRET=refresh_secret
|
||||
|
||||
# Set the expiration delay for the secure cookie with the JWT token
|
||||
# Delay is in milliseconds e.g. 7 days is 1000*60*60*24*7
|
||||
|
||||
# Recommended session expiry is 15 minutes. Make it longer if you want the user to be able to revist the page without logging in for a longer duration of time.
|
||||
|
||||
# Recommended refresh token expiry is 7 days
|
||||
SESSION_EXPIRY=1000 * 60 * 15
|
||||
REFRESH_TOKEN_EXPIRY=(1000 * 60 * 60 * 24) * 7
|
||||
|
||||
DOMAIN_SERVER=http://localhost:3080
|
||||
DOMAIN_CLIENT=http://localhost:3080
|
||||
```
|
||||
|
||||
## Automated Moderation System (optional)
|
||||
|
||||
The Automated Moderation System uses a scoring mechanism to track user violations. As users commit actions like excessive logins, registrations, or messaging, they accumulate violation scores. Upon reaching a set threshold, the user and their IP are temporarily banned. This system ensures platform security by monitoring and penalizing rapid or suspicious activities.
|
||||
|
||||
To set up the mod system, review [the setup guide](../features/mod_system.md).
|
||||
|
||||
*Please Note: If you are wanting this to work in development mode, you will need to create a file called `.env.development` in the root directory and set `DOMAIN_CLIENT` to `http://localhost:3090` or whatever port is provided by vite when runnning `npm run frontend-dev`*
|
||||
|
||||
Important: When you run the app for the first time, you need to create a new account by clicking on "Sign up" on the login page. The first account you make will be the admin account. The admin account doesn't have any special features right now, but it might be useful if you want to make an admin dashboard to manage other users later.
|
||||
|
||||
⚠️ **__For the first time, you should use a local account (email and password) to sign up and log in.__**
|
||||
|
||||
---
|
||||
|
||||
## **OAuth2/Social Login**
|
||||
|
||||
## Before enabling Social Authentication, set ALLOW_SOCIAL_LOGIN=true in the .env file
|
||||
|
||||
## Google Authentication
|
||||
|
||||
To enable Google login, you must create an application in the [Google Cloud Console](https://cloud.google.com) and provide the client ID and client secret in the `/.env` file.
|
||||
|
||||
1. Go to "APIs and Services" in your Google Cloud account and click on "Credentials".
|
||||
2. Click on "Configure consent screen" and select "External" as the user type.
|
||||
3. Add "profile", "email" and "openid" as the scopes for your app. These are the first three checkboxes when you click on "Add or remove scopes".
|
||||
4. Click on "Save and continue" and then "Back to dashboard".
|
||||
5. Click on "Create Credentials" and then "OAuth client ID".
|
||||
6. Select "Web application" as the application type and give it a name.
|
||||
7. Add `https://yourdomain`, `http://localhost:3080` and `http://localhost:3090` to the authorized JavaScript origins.
|
||||
8. Add `https://your-domain/oauth/google/callback` to the authorized redirect URIs. (if you use localhost then use this `http://localhost:3080/oauth/google/callback`)
|
||||
9. Click on "Create" and copy your client ID and client secret.
|
||||
10. Paste them into your `/.env` file.
|
||||
11. Enable the feature in the `/.env` file
|
||||
|
||||
---
|
||||
|
||||
## Facebook Authentication
|
||||
### (It only works with a domain, not with localhost)
|
||||
|
||||
1. Go to the [Facebook Developer Portal](https://developers.facebook.com/).
|
||||
2. Create a new application and select "Authenticate and request data from users with Facebook Login."
|
||||
3. Choose "No, I'm not creating a game" and provide a name for your application.
|
||||
4. In the Dashboard tab, go to "Use cases" and click "Customize" under "Authentication and account creation." Add the email permission by clicking "add" under email's permission.
|
||||
5. In the settings section, click "go to settings." Ensure that "Client OAuth login," "Web OAuth login," and "Enforce HTTPS" are **enabled**.
|
||||
6. Add `your-domain/oauth/facebook/callback` to the Valid OAuth Redirect URIs (e.g., https://example.com/oauth/facebook/callback).
|
||||
7. Save changes. In the "App settings" tab, click "show" next to the App secret.
|
||||
8. Copy the Client ID and Client Secret and paste them into the .env file as follows: (`App ID=Client ID` & `App secret=Client Secret`)
|
||||
|
||||
```bash
|
||||
FACEBOOK_CLIENT_ID=your_client_id
|
||||
FACEBOOK_CLIENT_SECRET=your_client_secret
|
||||
FACEBOOK_CALLBACK_URL=/oauth/facebook/callback # this should be the same for everyone
|
||||
```
|
||||
9. Save the .env file.
|
||||
|
||||
Make sure to replace "your_client_id" and "your_client_secret" with the actual values from your Facebook Developer Portal
|
||||
|
||||
---
|
||||
|
||||
## OpenID Authentication with Azure AD
|
||||
|
||||
1. Go to the [Azure Portal](https://portal.azure.com/) and sign in with your account.
|
||||
2. In the search box, type "Azure Active Directory" and click on it.
|
||||
3. On the left menu, click on App registrations and then on New registration.
|
||||
4. Give your app a name and select Web as the platform type.
|
||||
5. In the Redirect URI field, enter `http://localhost:3080/oauth/openid/callback` and click on Register.
|
||||
6. You will see an Overview page with some information about your app. Copy the Application (client) ID and the Directory (tenant) ID and save them somewhere.
|
||||
7. On the left menu, click on Authentication and check the boxes for Access tokens and ID tokens under Implicit grant and hybrid flows.
|
||||
8. On the left menu, click on Certificates & Secrets and then on New client secret. Give your secret a name and an expiration date and click on Add.
|
||||
9. You will see a Value column with your secret. Copy it and save it somewhere. Don't share it with anyone!
|
||||
10. Open the .env file in your project folder and add the following variables with the values you copied:
|
||||
|
||||
```
|
||||
OPENID_CLIENT_ID=Your Application (client) ID
|
||||
OPENID_CLIENT_SECRET=Your client secret
|
||||
OPENID_ISSUER=https://login.microsoftonline.com/Your Directory (tenant ID)/v2.0/
|
||||
OPENID_SESSION_SECRET=Any random string
|
||||
OPENID_SCOPE=openid profile email #DO NOT CHANGE THIS
|
||||
OPENID_CALLBACK_URL=/oauth/openid/callback # this should be the same for everyone
|
||||
```
|
||||
11. Save the .env file and you're done! You have successfully set up OpenID authentication with Azure AD for your app.
|
||||
|
||||
## OpenID Authentication with AWS Cognito
|
||||
|
||||
1. Create a new User Pool in Cognito:
|
||||
1. Ensure your Cognito user pool sign-in options include `User Name` and `Email`.
|
||||
2. Ensure that `given_name` and `family_name` are required attributes.
|
||||
3. Add an initial app client:
|
||||
1. Set the app type to `Confidential client`
|
||||
2. Select `Use Cognitio Hosted UI` and chose a domain name
|
||||
3. Make sure `Generate a client secret` is set.
|
||||
4. Set the `Allowed callback URLs` to `https://YOUR_DOMAIN/oauth/openid/callback`
|
||||
5. Under advanced settings make sure `Profile` is included in the `OpenID Connect scopes`
|
||||
2. Open your User Pool
|
||||
3. Go to the `App Integrations` tab
|
||||
4. Open the app client we created above.
|
||||
5. Use the `User Pool ID`and your AWS region to construct the OPENID_ISSUER (see below)
|
||||
6. Toggle `Show Client Secret`
|
||||
6. Use the `Client ID` for `OPENID_CLIENT_ID`
|
||||
7. Use the `Client secret` for `OPENID_CLIENT_SECRET`
|
||||
8. Open the .env file in your project folder and add the following variables with the values you copied:
|
||||
|
||||
```
|
||||
OPENID_CLIENT_ID=Your client ID
|
||||
OPENID_CLIENT_SECRET=Your client secret
|
||||
OPENID_ISSUER=https://cognito-idp.[AWS REGION].amazonaws.com/[USER POOL ID]/.well-known/openid-configuration
|
||||
OPENID_SESSION_SECRET=Any random string
|
||||
OPENID_SCOPE=openid profile email
|
||||
OPENID_CALLBACK_URL=/oauth/openid/callback
|
||||
```
|
||||
9. Save the .env file and you're done! You have successfully set up OpenID authentication with Cognito for your app.
|
||||
|
||||
---
|
||||
|
||||
## GitHub Authentication
|
||||
|
||||
1. Go to your [Github Developer settings](https://github.com/settings/apps)
|
||||
2. Create a new Github app
|
||||
3. Give it a GitHub App name and set in the Homepage URL "your-domain") (example: http://localhost:3080)
|
||||
4. Add a callback URL and set it as "your-domain/oauth/github/callback" (example: http://localhost:3080/oauth/github/callback)
|
||||
5. Remove the Active checkbox in the Webhook section
|
||||
6. Save changes and generate a Client Secret
|
||||
7. In the Permissions & events tab select, open the Account Permissions and set Email addresses to Read-only
|
||||
8. Put the Client ID and Client Secret in the .env file:
|
||||
```
|
||||
GITHUB_CLIENT_ID=your_client_id
|
||||
GITHUB_CLIENT_SECRET=your_client_secret
|
||||
GITHUB_CALLBACK_URL=/oauth/github/callback # this should be the same for everyone
|
||||
```
|
||||
9. Save the .env file
|
||||
---
|
||||
|
||||
## Discord Authentication
|
||||
|
||||
1. Go to [Discord Developer Portal](https://discord.com/developers)
|
||||
2. Create a new Application and give it a name
|
||||
4. In the OAuth2 general settings add a redirect URL and set it as "your-domain/oauth/discord/callback" (example: http://localhost:3080/oauth/discord/callback)
|
||||
5. in the Default Authorization Link set applications.commands
|
||||
6. Save changes and reset the Client Secret
|
||||
7. Put the Client ID and Client Secret in the .env file:
|
||||
```
|
||||
DISCORD_CLIENT_ID=your_client_id
|
||||
DISCORD_CLIENT_SECRET=your_client_secret
|
||||
DISCORD_CALLBACK_URL=/oauth/discord/callback # this should be the same for everyone
|
||||
```
|
||||
8. Save the .env file
|
||||
|
||||
---
|
||||
## **Email and Password Reset**
|
||||
|
||||
### General setup
|
||||
|
||||
in the .env file modify these variables:
|
||||
|
||||
```
|
||||
EMAIL_SERVICE= # eg. gmail - see https://community.nodemailer.com/2-0-0-beta/setup-smtp/well-known-services/
|
||||
EMAIL_HOST= # eg. example.com - if EMAIL_SERVICE is not set, connect to this server.
|
||||
EMAIL_PORT=25 # eg. 25 - mail server port to connect to with EMAIL_HOST (usually 25, 465, 587)
|
||||
EMAIL_ENCRYPTION= # eg. starttls - valid values: starttls (force STARTTLS), tls (obligatory TLS), anything else (use STARTTLS if available)
|
||||
EMAIL_ENCRYPTION_HOSTNAME= # eg. example.com - check the name in the certificate against this instead of EMAIL_HOST
|
||||
EMAIL_ALLOW_SELFSIGNED= # eg. true - valid values: true (allow self-signed), anything else (disallow self-signed)
|
||||
EMAIL_USERNAME= # eg. me@gmail.com - the username used for authentication. For consumer services, this MUST usually match EMAIL_FROM.
|
||||
EMAIL_PASSWORD= # eg. password - the password used for authentication
|
||||
EMAIL_FROM_NAME= # eg. LibreChat - the human-readable address in the From is constructed as "EMAIL_FROM_NAME <EMAIL_FROM>". Defaults to APP_TITLE.
|
||||
```
|
||||
|
||||
If you want to use one of the predefined services, configure only these variables:
|
||||
|
||||
EMAIL\_SERVICE is the name of the email service you are using (Gmail, Outlook, Yahoo Mail, ProtonMail, iCloud Mail, etc.) as defined in the NodeMailer well-known services linked above.
|
||||
EMAIL\_USERNAME is the username of the email service (usually, it will be the email address, but in some cases, it can be an actual username used to access the account).
|
||||
EMAIL\_PASSWORD is the password used to access the email service. This is not the password to access the email account directly, but a password specifically generated for this service.
|
||||
EMAIL\_FROM is the email address that will appear in the "from" field when a user receives an email.
|
||||
EMAIL\_FROM\_NAME is the name that will appear in the "from" field when a user receives an email. If left unset, it defaults to the app title.
|
||||
|
||||
If you want to use a generic SMTP service or need advanced configuration for one of the predefined providers, configure these variables:
|
||||
|
||||
EMAIL\_HOST is the hostname to connect to, or an IP address.
|
||||
EMAIL\_PORT is the port to connect to. Be aware that different ports usually come with different requirements - 25 is for mailserver-to-mailserver, 465 requires encryption at the start of the connection, and 587 allows submission of mail as a user.
|
||||
EMAIL\_ENCRYPTION defines if encryption is required at the start (`tls`) or started after the connection is set up (`starttls`). If either of these values are set, they are enforced. If they are not set, an encrypted connection is started if available.
|
||||
EMAIL\_ENCRYPTION\_HOSTNAME allows specification of a hostname against which the certificate is validated. Use this if the mail server does have a valid certificate, but you are connecting with an IP or a different name for some reason.
|
||||
EMAIL\_ALLOW\_SELFSIGNED defines whether self-signed certificates can be accepted from the server. As the mails being sent contain sensitive information, ONLY use this for testing.
|
||||
|
||||
NOTE: ⚠️ **Failing to perform either of the below setups will result in LibreChat using the unsecured password reset! This allows anyone to reset any password on your server immediately, without mail being sent at all!** The variable EMAIL\_FROM does not support all email providers **but is still required**. To stay updated, check the bug fixes [here](https://github.com/danny-avila/LibreChat/tags).
|
||||
|
||||
### Setup with Gmail
|
||||
|
||||
1. Create a Google Account and enable 2-step verification.
|
||||
2. In the [Google Account settings](https://myaccount.google.com/), click on the "Security" tab and open "2-step verification."
|
||||
3. Scroll down and open "App passwords." Choose "Mail" for the app and select "Other" for the device, then give it a random name.
|
||||
4. Click on "Generate" to create a password, and copy the generated password.
|
||||
5. In the .env file, modify the variables as follows:
|
||||
|
||||
```
|
||||
EMAIL_SERVICE=gmail
|
||||
EMAIL_USERNAME=your-email
|
||||
EMAIL_PASSWORD=your-app-password
|
||||
EMAIL_FROM=email address for the from field, e.g., noreply@librechat.ai
|
||||
EMAIL_FROM_NAME="My LibreChat Server"
|
||||
```
|
||||
|
||||
### Setup with custom mail server
|
||||
|
||||
1. Gather your SMTP login data from your provider. The steps are different for each, but they will usually list values for all variables.
|
||||
2. In the .env file, modify the variables as follows, assuming some sensible example values:
|
||||
|
||||
```
|
||||
EMAIL_HOST=mail.example.com
|
||||
EMAIL_PORT=587
|
||||
EMAIL_ENCRYPTION=starttls
|
||||
EMAIL_USERNAME=your-email
|
||||
EMAIL_PASSWORD=your-app-password
|
||||
EMAIL_FROM=email address for the from field, e.g., noreply@librechat.ai
|
||||
EMAIL_FROM_NAME="My LibreChat Server"
|
||||
```
|
||||
|
||||
## **Disable User Registration**
|
||||
|
||||
To disable or re-enable registration, open up the root `.env` file and set `ALLOW_REGISTRATION=true` or `ALLOW_REGISTRATION=false` depending on if you want registration open or closed.
|
||||
|
||||
To disable or re-enable social registration, open up the root `.env` file and set `ALLOW_SOCIAL_REGISTRATION=true` or `ALLOW_SOCIAL_REGISTRATION=false` depending on if you want social registration open or closed.
|
||||
|
||||
**NOTE: OpenID does not support the ability to disable only registration.**
|
||||
|
||||
### ⚠️***Warning***
|
||||
|
||||
If you previously implemented your own user system using the original scaffolding that was provided, you will no longer see conversations and presets by switching to the new user system. This is because of a design flaw in the scaffolding implementation that was problematic for the inclusion of social login.
|
||||
|
||||
### For user updating from an older version of the app:
|
||||
|
||||
When the first account is registered, the application will automatically migrate any conversations and presets that you created before the user system was implemented to that account.
|
||||
if you use login for the first time with a social login account (eg. Google, facebook, etc.), the conversations and presets that you created before the user system was implemented will NOT be migrated to that account.
|
||||
|
||||
## **Manual User Registration**
|
||||
You can use `npm run create-user` to create a user. If you can't get npm to work, try `sudo docker exec -ti LibreChat sh` first to "ssh" into the container.
|
||||
98
mkdocs.yml
98
mkdocs.yml
|
|
@ -45,9 +45,13 @@ theme:
|
|||
- content.action.edit
|
||||
- content.code.copy
|
||||
- navigation.instant
|
||||
- navigation.instant.progress
|
||||
- navigation.tracking
|
||||
- navigation.expand
|
||||
# - navigation.sections
|
||||
- navigation.prune
|
||||
- navigation.indexes
|
||||
- navigation.top
|
||||
|
||||
|
||||
# For more Styling options (not in use)
|
||||
extra_css:
|
||||
|
|
@ -68,76 +72,42 @@ markdown_extensions:
|
|||
- pymdownx.superfences
|
||||
- pymdownx.mark
|
||||
- attr_list
|
||||
- pymdownx.emoji:
|
||||
emoji_index: !!python/name:materialx.emoji.twemoji
|
||||
emoji_generator: !!python/name:materialx.emoji.to_svg
|
||||
- pymdownx.superfences:
|
||||
custom_fences:
|
||||
- name: mermaid
|
||||
class: mermaid
|
||||
|
||||
# Page tree
|
||||
nav:
|
||||
- Home:
|
||||
- 'index.md'
|
||||
- v0.5.0 Breaking Changes: 'general_info/breaking_changes.md'
|
||||
- Project Origin: 'general_info/project_origin.md'
|
||||
- Tech Stack: 'general_info/tech_stack.md'
|
||||
- Multilingual Information: 'general_info/multilingual_information.md'
|
||||
- Installation Guides:
|
||||
- Installation:
|
||||
- Docker (Compose) Install: 'install/docker_compose_install.md'
|
||||
- Container Install: 'install/container_install.md'
|
||||
- Linux Install: 'install/linux_install.md'
|
||||
- Mac Install: 'install/mac_install.md'
|
||||
- Windows Install: 'install/windows_install.md'
|
||||
- Configuration:
|
||||
- .env Configuration: 'install/dotenv.md'
|
||||
- Free AI APIs: 'install/free_ai_apis.md'
|
||||
- AI Setup: 'install/ai_setup.md'
|
||||
- User Auth System: 'install/user_auth_system.md'
|
||||
- Online MongoDB Database: 'install/mongodb.md'
|
||||
- Languages: 'install/default_language.md'
|
||||
- LiteLLM Proxy: 'install/litellm.md'
|
||||
- Miscellaneous: 'install/misc.md'
|
||||
- Features:
|
||||
- Plugins:
|
||||
- Introduction: 'features/plugins/introduction.md'
|
||||
- Google: 'features/plugins/google_search.md'
|
||||
- Stable Diffusion: 'features/plugins/stable_diffusion.md'
|
||||
- Wolfram: 'features/plugins/wolfram.md'
|
||||
- Azure AI Search: 'features/plugins/azure_ai_search.md'
|
||||
- Make Your Own Plugin: 'features/plugins/make_your_own.md'
|
||||
- Using official ChatGPT Plugins: 'features/plugins/chatgpt_plugins_openapi.md'
|
||||
- Automated Moderation: 'features/mod_system.md'
|
||||
- Token Usage: 'features/token_usage.md'
|
||||
- Manage Your Database: 'features/manage_your_database.md'
|
||||
- Logging System: 'features/logging_system.md'
|
||||
- PandoraNext Deployment Guide: 'features/pandoranext.md'
|
||||
- Third-Party Tools: 'features/third_party.md'
|
||||
- Proxy: 'features/proxy.md'
|
||||
- Bing Jailbreak: 'features/bing_jailbreak.md'
|
||||
- Cloud Deployment:
|
||||
- DigitalOcean (preferred): 'deployment/digitalocean.md'
|
||||
- Cloudflare: 'deployment/cloudflare.md'
|
||||
- Hetzner: 'deployment/hetzner_ubuntu.md'
|
||||
- Heroku: 'deployment/heroku.md'
|
||||
- Linode: 'deployment/linode.md'
|
||||
- Ngrok: 'deployment/ngrok.md'
|
||||
- Render: 'deployment/render.md'
|
||||
- Meilisearch on Render: 'deployment/meilisearch_in_render.md'
|
||||
- Azure (Terraform): 'deployment/azure-terraform.md'
|
||||
- HuggingFace: 'deployment/huggingface.md'
|
||||
- Contributions:
|
||||
- Documentation Guidelines: 'contributions/documentation_guidelines.md'
|
||||
- Contribute a Translation: 'contributions/translation_contribution.md'
|
||||
- Code Standards and Conventions: 'contributions/coding_conventions.md'
|
||||
- Testing: 'contributions/testing.md'
|
||||
|
||||
plugins:
|
||||
- search
|
||||
- mkdocs-nav-weight:
|
||||
section_renamed: true # If true, section name will use the title of its index instead of the folder name.
|
||||
index_weight: -10
|
||||
warning: true # Controls whether to send a Warning when invalid values are detected in markdown metadata
|
||||
reverse: false # If true, sort nav by weight from largest to smallest.
|
||||
headless_included: false
|
||||
# for more info: https://github.com/shu307/mkdocs-nav-weight?tab=readme-ov-file
|
||||
|
||||
extra:
|
||||
social:
|
||||
- icon: fontawesome/brands/discord
|
||||
link: https://discord.gg/CEe6vDg9Ky
|
||||
link: https://discord.librechat.ai
|
||||
name: Discord
|
||||
- icon: fontawesome/brands/github
|
||||
link: https://github.com/danny-avila/LibreChat
|
||||
link: https://librechat.ai
|
||||
name: GitHub
|
||||
- icon: fontawesome/brands/youtube
|
||||
link: https://www.youtube.com/@LibreChat
|
||||
link: https://yt.librechat.ai
|
||||
name: YouTube
|
||||
- icon: fontawesome/brands/linkedin
|
||||
link: https://linkedin.librechat.ai
|
||||
name: LinkedIn
|
||||
- icon: fontawesome/solid/feather
|
||||
link: https://demo.librechat.cfd
|
||||
name: Demo
|
||||
- icon: fontawesome/solid/face-grin-beam
|
||||
link: https://hf.librechat.ai
|
||||
name: Hugging Face
|
||||
|
||||
copyright:
|
||||
© 2023 <a href="https://github.com/danny-avila/LibreChat" target="_blank" rel="noopener">LibreChat</a>
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue