mirror of
https://github.com/danny-avila/LibreChat.git
synced 2025-12-26 21:28:50 +01:00
📝 docs update: remove ChatGPTbrowser and other small fixes (#1686)
* 🧼 docs: remove references to ChatGPTbrowser and PandoraNext * docs: clean up .env file Update OpenAI models with the list of automatically fetched models, update Plugin models with the list of models supporting functions, comment out ToC in custom_config.md since it conflicts with mkdock right sidebar ToC * 🖋️ docs: fix formatting in linux_install.md * docs: update example model lists in dotenv.md * docs: update breaking_changesv.md
This commit is contained in:
Fuegovic
GitHub
parent
972402e029
commit
b37f55cd3a
8 changed files with 54 additions and 257 deletions
|
|
@ -30,7 +30,6 @@ weight: -8
|
|||
- [Using Plugins with Azure](#using-plugins-with-azure)
|
||||
- [OpenRouter](#openrouter)
|
||||
- [Unofficial APIs](#unofficial-apis)
|
||||
- [ChatGPTBrowser](#chatgptbrowser)
|
||||
- [BingAI](#bingai)
|
||||
- [Conclusion](#conclusion) -->
|
||||
|
||||
|
|
@ -447,27 +446,6 @@ OpenRouter is integrated to the LibreChat by overriding the OpenAI endpoint.
|
|||
|
||||
**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.
|
||||
|
||||
### ChatGPTBrowser
|
||||
|
||||
**Backend Access to https://chat.openai.com/api**
|
||||
|
||||
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)
|
||||
|
||||
To get your Access token for ChatGPT Browser Access, you need to:
|
||||
|
||||
- Go to **[https://chat.openai.com](https://chat.openai.com)**
|
||||
- Create an account or log in with your existing one
|
||||
- Visit **[https://chat.openai.com/api/auth/session](https://chat.openai.com/api/auth/session)**
|
||||
- Copy the value of the "accessToken" field and save it in ./.env as CHATGPT_ACCESS_TOKEN
|
||||
|
||||
Warning: There may be a chance of your account being banned if you deploy the app to multiple users with this method. Use at your own risk.
|
||||
|
||||
---
|
||||
|
||||
### BingAI
|
||||
I recommend using Microsoft Edge for this:
|
||||
|
||||
|
|
|
|||
|
|
@ -33,20 +33,37 @@ Future updates will streamline configuration further by migrating some settings
|
|||
|
||||
Stay tuned for ongoing enhancements to customize your LibreChat instance!
|
||||
|
||||
# Table of Contents
|
||||
<!-- # Table of Contents
|
||||
|
||||
1. [Intro](#librechat-configuration-guide)
|
||||
- [Setup](#setup)
|
||||
- [Docker Setup](#docker-setup)
|
||||
- [Config Structure](#config-structure)
|
||||
- [1. Version](#1-version)
|
||||
- [2. Cache Settings](#2-cache-settings)
|
||||
- [3. Endpoints](#3-endpoints)
|
||||
- [Endpoint Object Structure](#endpoint-object-structure)
|
||||
- [Additional Notes](#additional-notes)
|
||||
- [Default Parameters](#default-parameters)
|
||||
- [Breakdown of Default Params](#breakdown-of-default-params)
|
||||
- [Example Config](#example-config)
|
||||
- [LibreChat Configuration Guide](#librechat-configuration-guide)
|
||||
- [Table of Contents](#table-of-contents)
|
||||
- [Setup](#setup)
|
||||
- [Docker Setup](#docker-setup)
|
||||
- [Config Structure](#config-structure)
|
||||
- [Version](#version)
|
||||
- [Cache Settings](#cache-settings)
|
||||
- [File Strategy](#file-strategy)
|
||||
- [Endpoints](#endpoints)
|
||||
- [Endpoint Object Structure](#endpoint-object-structure)
|
||||
- [**name**:](#name)
|
||||
- [**apiKey**:](#apikey)
|
||||
- [**baseURL**:](#baseurl)
|
||||
- [**iconURL**:](#iconurl)
|
||||
- [**models**:](#models)
|
||||
- [**titleConvo**:](#titleconvo)
|
||||
- [**titleMethod**:](#titlemethod)
|
||||
- [**titleModel**:](#titlemodel)
|
||||
- [**summarize**:](#summarize)
|
||||
- [**summaryModel**:](#summarymodel)
|
||||
- [**forcePrompt**:](#forceprompt)
|
||||
- [**modelDisplayLabel**:](#modeldisplaylabel)
|
||||
- [**addParams**:](#addparams)
|
||||
- [**dropParams**:](#dropparams)
|
||||
- [**headers**:](#headers)
|
||||
- [Additional Notes](#additional-notes)
|
||||
- [Default Parameters](#default-parameters)
|
||||
- [Breakdown of Default Params](#breakdown-of-default-params)
|
||||
- [Example Config](#example-config) -->
|
||||
|
||||
## Setup
|
||||
|
||||
|
|
@ -58,7 +75,7 @@ The example config file has some options ready to go for Mistral AI and Openrout
|
|||
|
||||
## Docker Setup
|
||||
|
||||
For Docker, you need to make use of an [override file](./docker_override), named `docker-compose.override.yml`, to ensure the config file works for you.
|
||||
For Docker, you need to make use of an [override file](./docker_override.md), named `docker-compose.override.yml`, to ensure the config file works for you.
|
||||
|
||||
- First, make sure your containers stop running with `docker-compose down`
|
||||
- Create or edit existing `docker-compose.override.yml` at the root of the project:
|
||||
|
|
|
|||
|
|
@ -135,7 +135,7 @@ In this section you can configure the endpoints and models selection, their API
|
|||
- `PROXY` is to be used by all endpoints (leave blank by default)
|
||||
|
||||
```bash
|
||||
ENDPOINTS=openAI,azureOpenAI,bingAI,chatGPTBrowser,google,gptPlugins,anthropic
|
||||
ENDPOINTS=openAI,azureOpenAI,bingAI,google,gptPlugins,anthropic
|
||||
PROXY=
|
||||
```
|
||||
|
||||
|
|
@ -245,28 +245,6 @@ BINGAI_TOKEN=user_provided
|
|||
BINGAI_HOST=
|
||||
```
|
||||
|
||||
### ChatGPT
|
||||
see: [ChatGPT Free Access token](../configuration/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)**
|
||||
|
||||
```bash
|
||||
CHATGPT_REVERSE_PROXY=<YOUR-REVERSE-PROXY>
|
||||
```
|
||||
|
||||
> **Note:** If you're a GPT plus user you can try adding `gpt-4`, `gpt-4-plugins`, `gpt-4-code-interpreter`, and `gpt-4-browsing` to the list above and use the models for these features; **however, the view/display portion of these features are not supported**, but you can use the underlying models, which have higher token context
|
||||
|
||||
> This method **might only works** with `text-davinci-002-render-sha` and **might stop working** at any moment.
|
||||
|
||||
- Leave `CHATGPT_TOKEN=` blank to disable this endpoint
|
||||
- Set `CHATGPT_TOKEN=` to "user_provided" to allow users to provide their own API key from the WebUI
|
||||
- It is not recommended to provide your token in the `.env` file since it expires often and sharing it could get you banned.
|
||||
|
||||
```bash
|
||||
CHATGPT_TOKEN=
|
||||
CHATGPT_MODELS=text-davinci-002-render-sha
|
||||
```
|
||||
|
||||
### Google
|
||||
Follow these instructions to setup the [Google Endpoint](./ai_setup.md#google)
|
||||
|
||||
|
|
@ -317,7 +295,7 @@ DEBUG_OPENAI=false
|
|||
- Leave it blank or commented out to use internal settings.
|
||||
|
||||
```bash
|
||||
OPENAI_MODELS=gpt-3.5-turbo-1106,gpt-4-turbo-preview,gpt-4-1106-preview,gpt-3.5-turbo,gpt-3.5-turbo-16k,gpt-3.5-turbo-0301,gpt-4,gpt-4-0314,gpt-4-0613
|
||||
OPENAI_MODELS=gpt-3.5-turbo-0301,gpt-3.5-turbo,gpt-4,gpt-4-0613,gpt-4-vision-preview,gpt-3.5-turbo-0613,gpt-3.5-turbo-16k-0613,gpt-4-0125-preview,gpt-4-turbo-preview,gpt-4-1106-preview,gpt-3.5-turbo-1106,gpt-3.5-turbo-instruct,gpt-3.5-turbo-instruct-0914,gpt-3.5-turbo-16k
|
||||
```
|
||||
|
||||
- Titling is enabled by default when initiating a conversation.
|
||||
|
|
@ -383,7 +361,7 @@ Here are some useful documentation about plugins:
|
|||
- 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.
|
||||
|
||||
```bash
|
||||
PLUGIN_MODELS=gpt-3.5-turbo,gpt-3.5-turbo-16k,gpt-3.5-turbo-0301,gpt-4,gpt-4-0314,gpt-4-0613
|
||||
PLUGIN_MODELS=gpt-4,gpt-4-turbo-preview,gpt-4-0125-preview,gpt-4-1106-preview,gpt-4-0613,gpt-3.5-turbo,gpt-3.5-turbo-1106,gpt-3.5-turbo-0613
|
||||
```
|
||||
|
||||
- Set to false or comment out to disable debug mode for plugins
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue