mirror of
https://github.com/danny-avila/LibreChat.git
synced 2026-01-16 15:35:31 +01:00
🖋️ docs: Formatting Fix (#1726)
* 🍃 docs: Formatting Fix * 🖋️ docs: Formatting Fix * 🖋️ docs: Formatting Fix
This commit is contained in:
parent
d1cf02b5a8
commit
b5c2fb93c1
6 changed files with 63 additions and 47 deletions
|
|
@ -410,6 +410,7 @@ 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
|
||||
|
|
@ -422,18 +423,19 @@ OpenRouter is integrated to the LibreChat by overriding the OpenAI endpoint.
|
|||
|
||||
**Important**: As of v0.6.6, you can use OpenRouter as its own standalone endpoint:
|
||||
|
||||

|
||||
|
||||
### [Review the Custom Config Guide (click here)](./custom_config.md) to add an `OpenRouter` Endpoint
|
||||
|
||||
**Setup (legacy):**
|
||||

|
||||
|
||||
#### Setup (legacy):
|
||||
|
||||
- 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.**
|
||||
#### Notes (legacy):
|
||||
|
||||
- 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.
|
||||
|
|
|
|||
|
|
@ -100,6 +100,7 @@ Use of the `docker-compose.override.yml` file allows us to enable explicit authe
|
|||
- While the steps outlined may also be applicable to Docker Desktop environments, or with non-Docker, local MongoDB, or other container setups, details specific to those scenarios are not provided.
|
||||
|
||||
**There are 3 basic steps:**
|
||||
|
||||
- Create an admin user within your mongodb container
|
||||
- Enable authentication and create a "readWrite" user for "LibreChat"
|
||||
- Configure the MONGO_URI with newly created user
|
||||
|
|
|
|||
|
|
@ -422,45 +422,45 @@ AZURE_AI_SEARCH_SEARCH_OPTION_SELECT=
|
|||
- `DALLE_API_KEY`: This environment variable is intended for storing the OpenAI API key that grants access to both DALL-E 2 and DALL-E 3 services. Typically, this key should be kept private. If you are distributing a plugin or software that integrates with DALL-E, you may choose to leave this commented out, requiring the end user to input their own API key. If you have a shared API key you want to distribute with your software (not recommended for security reasons), you can uncomment this and provide the key.
|
||||
|
||||
```bash
|
||||
# DALLE_API_KEY=
|
||||
DALLE_API_KEY=
|
||||
```
|
||||
|
||||
- `DALLE3_API_KEY` and `DALLE2_API_KEY`: These are similar to the above but are specific to each version of DALL-E. They allow for separate keys for DALL-E 2 and DALL-E 3, providing flexibility if you have different access credentials or subscription levels for each service.
|
||||
|
||||
```bash
|
||||
# DALLE3_API_KEY=
|
||||
# DALLE2_API_KEY=
|
||||
DALLE3_API_KEY=
|
||||
DALLE2_API_KEY=
|
||||
```
|
||||
|
||||
**System Prompts:**
|
||||
- `DALLE3_SYSTEM_PROMPT` and `DALLE2_SYSTEM_PROMPT`: These variables allow users to set system prompts that can preconfigure or guide the image generation process for DALL-E 3 and DALL-E 2, respectively. Use these to set default prompts or special instructions that affect how the AI interprets the user's input prompts.
|
||||
|
||||
```bash
|
||||
# DALLE3_SYSTEM_PROMPT="Your DALL-E-3 System Prompt here"
|
||||
# DALLE2_SYSTEM_PROMPT="Your DALL-E-2 System Prompt here"
|
||||
DALLE3_SYSTEM_PROMPT="Your DALL-E-3 System Prompt here"
|
||||
DALLE2_SYSTEM_PROMPT="Your DALL-E-2 System Prompt here"
|
||||
```
|
||||
|
||||
**Reverse Proxy Settings:**
|
||||
- `DALLE_REVERSE_PROXY`: This setting enables the specification of a reverse proxy for DALL-E API requests. This can be useful for routing traffic through a specific server, potentially for purposes like caching, logging, or adding additional layers of security. Ensure that the URL follows the required pattern and is appropriately configured to handle DALL-E requests.
|
||||
|
||||
```bash
|
||||
# DALLE_REVERSE_PROXY=
|
||||
DALLE_REVERSE_PROXY=
|
||||
```
|
||||
|
||||
**Base URLs:**
|
||||
- `DALLE3_BASEURL` and `DALLE2_BASEURL`: These variables define the base URLs for DALL-E 3 and DALL-E 2 API endpoints, respectively. These might need to be set if you are using a custom proxy or a specific regional endpoint provided by OpenAI.
|
||||
|
||||
```bash
|
||||
# DALLE3_BASEURL=
|
||||
# DALLE2_BASEURL=
|
||||
DALLE3_BASEURL=
|
||||
DALLE2_BASEURL=
|
||||
```
|
||||
|
||||
**Azure OpenAI Integration (Optional):**
|
||||
- `DALLE3_AZURE_API_VERSION` and `DALLE2_AZURE_API_VERSION`: If you are using Azure's OpenAI service to access DALL-E, these environment variables specify the API version for DALL-E 3 and DALL-E 2, respectively. Azure may have specific API version strings that need to be set to ensure compatibility with their services.
|
||||
|
||||
```bash
|
||||
# DALLE3_AZURE_API_VERSION=
|
||||
# DALLE2_AZURE_API_VERSION=
|
||||
DALLE3_AZURE_API_VERSION=
|
||||
DALLE2_AZURE_API_VERSION=
|
||||
```
|
||||
|
||||
---
|
||||
|
|
|
|||
|
|
@ -202,6 +202,9 @@ EMAIL_FROM_NAME="My LibreChat Server"
|
|||
- Paste your `Client ID` and `Client Secret` in the `.env` file:
|
||||
|
||||
```bash
|
||||
DOMAIN_CLIENT=https://your-domain.com #use http://localhost:3080 if not using a custom domain
|
||||
DOMAIN_SERVER=https://your-domain.com #use http://localhost:3080 if not using a custom domain
|
||||
|
||||
DISCORD_CLIENT_ID=your_client_id
|
||||
DISCORD_CLIENT_SECRET=your_client_secret
|
||||
DISCORD_CALLBACK_URL=/oauth/discord/callback
|
||||
|
|
@ -279,6 +282,9 @@ DISCORD_CALLBACK_URL=/oauth/discord/callback
|
|||
- Copy the `App ID` and `App Secret` and paste them into the `.env` file as follows:
|
||||
|
||||
```bash
|
||||
DOMAIN_CLIENT=https://your-domain.com #use http://localhost:3080 if not using a custom domain
|
||||
DOMAIN_SERVER=https://your-domain.com #use http://localhost:3080 if not using a custom domain
|
||||
|
||||
FACEBOOK_CLIENT_ID=your_app_id
|
||||
FACEBOOK_CLIENT_SECRET=your_app_secret
|
||||
FACEBOOK_CALLBACK_URL=/oauth/facebook/callback
|
||||
|
|
@ -338,6 +344,9 @@ FACEBOOK_CALLBACK_URL=/oauth/facebook/callback
|
|||

|
||||
|
||||
```bash
|
||||
DOMAIN_CLIENT=https://your-domain.com #use http://localhost:3080 if not using a custom domain
|
||||
DOMAIN_SERVER=https://your-domain.com #use http://localhost:3080 if not using a custom domain
|
||||
|
||||
GITHUB_CLIENT_ID=your_client_id
|
||||
GITHUB_CLIENT_SECRET=your_client_secret
|
||||
GITHUB_CALLBACK_URL=/oauth/github/callback
|
||||
|
|
@ -429,6 +438,9 @@ GITHUB_CALLBACK_URL=/oauth/github/callback
|
|||
- Add them to your `.env` file:
|
||||
|
||||
```bash
|
||||
DOMAIN_CLIENT=https://your-domain.com #use http://localhost:3080 if not using a custom domain
|
||||
DOMAIN_SERVER=https://your-domain.com #use http://localhost:3080 if not using a custom domain
|
||||
|
||||
GOOGLE_CLIENT_ID=your_client_id
|
||||
GOOGLE_CLIENT_SECRET=your_client_secret
|
||||
GOOGLE_CALLBACK_URL=/oauth/github/callback
|
||||
|
|
@ -535,6 +547,9 @@ You can now make last minute changes, click on `Create user pool` when you're do
|
|||
6. Open the `.env` file at the root of your LibreChat folder and add the following variables with the values you copied:
|
||||
|
||||
```bash
|
||||
DOMAIN_CLIENT=https://your-domain.com #use http://localhost:3080 if not using a custom domain
|
||||
DOMAIN_SERVER=https://your-domain.com #use http://localhost:3080 if not using a custom domain
|
||||
|
||||
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
|
||||
|
|
@ -563,6 +578,9 @@ OPENID_CALLBACK_URL=/oauth/openid/callback
|
|||
10. Open the .env file in your project folder and add the following variables with the values you copied:
|
||||
|
||||
```bash
|
||||
DOMAIN_CLIENT=https://your-domain.com #use http://localhost:3080 if not using a custom domain
|
||||
DOMAIN_SERVER=https://your-domain.com #use http://localhost:3080 if not using a custom domain
|
||||
|
||||
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/
|
||||
|
|
|
|||
|
|
@ -106,13 +106,14 @@ sudo apt-get install -y nodejs
|
|||
|
||||
### Using the command line (in the root directory)
|
||||
Setup the app:
|
||||
|
||||
1. Run `npm ci`
|
||||
2. Run `npm run frontend`
|
||||
|
||||
## Start the app:
|
||||
1. Run `npm run backend`
|
||||
2. Run `meilisearch --master-key put_your_meilesearch_Master_Key_here` (Only if SEARCH=TRUE)
|
||||
3. Visit http://localhost:3080 (default port) & enjoy
|
||||
3. Visit [http://localhost:3080](http://localhost:3080) (default port) & enjoy
|
||||
|
||||
### Using a shell script
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue