mirror of
https://github.com/danny-avila/LibreChat.git
synced 2025-12-18 01:10:14 +01:00
Docs: updates & enhancements for MKDocs (#555)
* Update documents for mkdocs compatibility * documents update * documents update * Update README.md * Update README.md add link to "https://docs.librechat.ai" on the logo * document updates * docs - badge updates * docs - badge updates * docs - badge updates * Update docker_install.md * Update .env.example update default MONGO_URI to port 27018 so local install can communicate with the docker db * Update windows_install.md fix typo
This commit is contained in:
Fuegovic
GitHub
parent
d7270a1676
commit
df2a68e1e7
75 changed files with 1129 additions and 209 deletions
|
|
@ -21,15 +21,14 @@ Then you can get the API key, click the "Get a key" button on this page: https:/
|
|||
|
||||
Click to sign in(make a Google acct if you do not have one):
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## 3\. Register yourself a new account/Login to the Control Panel
|
||||
|
||||
|
||||
After logging in, you will be redirected to the Control Panel to create a new search engine:
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## 4\. Create a new search engine
|
||||
|
|
@ -37,13 +36,13 @@ After logging in, you will be redirected to the Control Panel to create a new se
|
|||
|
||||
Fill in a name, select to "Search the entire web" and hit "Create":
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## 5\. Copy your Search engine ID to your .env file
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## 6\. Go to [custom-search docs](https://developers.google.com/custom-search/v1/introduction) to get a Google search API key
|
||||
|
|
@ -51,16 +50,16 @@ Fill in a name, select to "Search the entire web" and hit "Create":
|
|||
|
||||
## 7\. Click "Get a Key":
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## 8\. Name your project and agree to the Terms of Service
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## 9\. Copy your Google search API key to your .env file
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# Plugins Endpoint
|
||||
|
||||
|
||||
|
||||
|
||||
The plugins endpoint opens the door to prompting LLMs in new ways other than traditional input/output prompting.
|
||||
|
||||
|
|
@ -17,17 +17,17 @@ More than this, you can use this endpoint for changing your conversation setting
|
|||
|
||||
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)
|
||||
|
|
@ -68,8 +68,8 @@ Clicking on **"Show Agent Settings"** will allow you to modify parameters for th
|
|||
|
||||
### Showcase
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -55,11 +55,14 @@ With the docker deployment you can skip step 2 and step 3, use the setup instruc
|
|||
- Use `SD_WEBUI_URL=http://127.0.0.1:7860` in the `.env` file
|
||||
- Or `http://127.0.0.1:7860` from the webui
|
||||
|
||||
|
||||
|
||||
|
||||
### Select the plugins endpoint
|
||||
|
||||
|
||||
### Open the Plugin store and Install Stable Diffusion
|
||||
|
||||
|
||||
|
||||
|
||||
## 5. Select the plugin and enjoy!
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
@ -6,16 +6,16 @@ An AppID must be supplied in all calls to the Wolfram|Alpha API.
|
|||
|
||||
## 1. Make an account at <a href='http://products.wolframalpha.com/api/'>Wolfram|Alpha</a>
|
||||
## 2. Go to the <a href='https://developer.wolframalpha.com/portal/myapps/'>Developer Portal</a> click on "Get an AppID".
|
||||
## 3. In the app, select the plugins endpoint, open the plugins store, and install Wolfram
|
||||
- You will be prompted for your AppID
|
||||
- Alternatively: you (the admin) can set the value in `\.env` to bypass the prompt
|
||||
- `WOLFRAM_APP_ID=your_app_id`
|
||||
|
||||
|
||||
|
||||
## 3. Configure it in LibreChat
|
||||
### Select the plugins endpoint
|
||||
|
||||
### Open the Plugin store
|
||||
|
||||
### Install Wolfram and Provide your AppID
|
||||
|
||||
|
||||
- Alternatively: you (the admin) can set the value in `\.env` to bypass the prompt: `WOLFRAM_APP_ID=your_app_id`
|
||||
|
||||
## 5. Select the plugin and enjoy!
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue