mirror of
https://github.com/danny-avila/LibreChat.git
synced 2025-12-27 21:58:51 +01:00
docs: fix outdated references (#480)
* Update .env.example * Update README.md * Update bing_jailbreak_info.md * Update heroku.md * Update SECURITY.md * Update CONTRIBUTING.md * Update CODE_OF_CONDUCT.md * Update LICENSE.md * Update SECURITY.md * Update coding_conventions.md * Update documentation_guidelines.md * Update testing.md * Update heroku.md * Update google_search.md * Update introduction.md * Update make_your_own.md * Update stable_diffusion.md * Update wolfram.md * Update proxy.md * Update user_auth_system.md * Update bing_jailbreak_info.md * Update multilingual_information.md * Update project_origin.md * Update tech_stack.md * Update apis_and_tokens.md * Update docker_install.md * Update linux_install.md * Update mac_install.md * Update windows_install.md * Update install.js
This commit is contained in:
Fuegovic
GitHub
parent
3dadedaf69
commit
5e3809f22c
27 changed files with 172 additions and 248 deletions
|
|
@ -1,4 +1,4 @@
|
|||
# Google Search Plugin
|
||||
# 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
|
||||
GOOGLE_API_KEY="...."
|
||||
|
|
@ -49,7 +49,7 @@ Fill in a name, select to "Search the entire web" and hit "Create":
|
|||
## 6\. Go to [custom-search docs](https://developers.google.com/custom-search/v1/introduction) to get a Google search API key
|
||||
|
||||
|
||||
Click "Get a Key":
|
||||
## 7\. Click "Get a Key":
|
||||
|
||||
|
||||
|
||||
|
|
@ -64,6 +64,7 @@ Click "Get a Key":
|
|||
|
||||
|
||||
|
||||
##
|
||||
|
||||
---
|
||||
|
||||
## [Go Back to ReadMe](../../../README.md)
|
||||
|
|
|
|||
|
|
@ -72,6 +72,7 @@ Clicking on **"Show Agent Settings"** will allow you to modify parameters for th
|
|||
|
||||
|
||||
|
||||
##
|
||||
|
||||
---
|
||||
|
||||
## [Go Back to ReadMe](../../../README.md)
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
## Making your own Plugin
|
||||
# Making your own Plugin
|
||||
|
||||
Creating custom plugins for this project involves extending the `Tool` class from the `langchain/tools` module.
|
||||
|
||||
|
|
@ -17,17 +17,17 @@ The most common implementation is to make an API call based on the natural langu
|
|||
|
||||
Here are the key takeaways for creating your own plugin:
|
||||
|
||||
1. [**Import Required Modules:**](make_your_own.md#step-1-import-required-modules) Import the necessary modules for your plugin, including the `Tool` class from `langchain/tools` and any other modules your plugin might need.
|
||||
**1.** [**Import Required Modules:**](make_your_own.md#step-1-import-required-modules) Import the necessary modules for your plugin, including the `Tool` class from `langchain/tools` and any other modules your plugin might need.
|
||||
|
||||
2. [**Define Your Plugin Class:**](make_your_own.md#step-2-define-your-tool-class) Define a class for your plugin that extends the `Tool` class. Set the `name` and `description` properties in the constructor. If your plugin requires credentials or other variables, set them from the fields parameter or from a method that retrieves them from your process environment.
|
||||
**2.** [**Define Your Plugin Class:**](make_your_own.md#step-2-define-your-tool-class) Define a class for your plugin that extends the `Tool` class. Set the `name` and `description` properties in the constructor. If your plugin requires credentials or other variables, set them from the fields parameter or from a method that retrieves them from your process environment.
|
||||
|
||||
3. [**Define Helper Methods:**](make_your_own.md#step-3-define-helper-methods) Define helper methods within your class to handle specific tasks if needed.
|
||||
**3.** [**Define Helper Methods:**](make_your_own.md#step-3-define-helper-methods) Define helper methods within your class to handle specific tasks if needed.
|
||||
|
||||
4. [**Implement the `_call` Method:**](make_your_own.md#step-4-implement-the-_call-method) Implement the `_call` method where the main functionality of your plugin is defined. This method is called when the language model decides to use your plugin. It should take an `input` parameter and return a result. If an error occurs, the function should return a string representing an error, rather than throwing an error.
|
||||
**4.** [**Implement the `_call` Method:**](make_your_own.md#step-4-implement-the-_call-method) Implement the `_call` method where the main functionality of your plugin is defined. This method is called when the language model decides to use your plugin. It should take an `input` parameter and return a result. If an error occurs, the function should return a string representing an error, rather than throwing an error.
|
||||
|
||||
5. [**Export Your Plugin and Import into handleTools.js:**](make_your_own.md#step-5-export-your-plugin-and-import-into-handletoolsjs) Export your plugin and import it into `handleTools.js`. Add your plugin to the `toolConstructors` object in the `loadTools` function. If your plugin requires more advanced initialization, add it to the `customConstructors` object.
|
||||
**5.** [**Export Your Plugin and Import into handleTools.js:**](make_your_own.md#step-5-export-your-plugin-and-import-into-handletoolsjs) Export your plugin and import it into `handleTools.js`. Add your plugin to the `toolConstructors` object in the `loadTools` function. If your plugin requires more advanced initialization, add it to the `customConstructors` object.
|
||||
|
||||
6. [**Add Your Plugin to manifest.json:**](make_your_own.md#step-6-add-your-plugin-to-manifestjson) Add your plugin to `manifest.json`. Follow the strict format for each of the fields of the "plugin" object. If your plugin requires authentication, add those details under `authConfig` as an array. The `pluginKey` should match the class `name` of the Tool class you made, and the `authField` prop must match the process.env variable name.
|
||||
**6.** [**Add Your Plugin to manifest.json:**](make_your_own.md#step-6-add-your-plugin-to-manifestjson) Add your plugin to `manifest.json`. Follow the strict format for each of the fields of the "plugin" object. If your plugin requires authentication, add those details under `authConfig` as an array. The `pluginKey` should match the class `name` of the Tool class you made, and the `authField` prop must match the process.env variable name.
|
||||
|
||||
Remember, the key to creating a custom plugin is to extend the `Tool` class and implement the `_call` method. The `_call` method is where you define what your plugin does. You can also define helper methods and properties in your class to support the functionality of your plugin.
|
||||
|
||||
|
|
@ -284,6 +284,6 @@ module.exports = WolframAlphaAPI;
|
|||
|
||||
In this example, the `WolframAlphaAPI` class has helper methods like `fetchRawText`, `getAppId`, and `createWolframAlphaURL` to handle specific tasks. The `_call` method makes an HTTP request to the Wolfram Alpha API and returns the response.
|
||||
|
||||
##
|
||||
---
|
||||
|
||||
## [Go Back to ReadMe](../../../README.md)
|
||||
|
|
|
|||
|
|
@ -4,9 +4,9 @@ To use Stable Diffusion with this project, you will need to download and install
|
|||
|
||||
- Note: you need a compatible GPU. Nvidia is recommended, but there is no clear resource on incompatible GPUs. Any decent GPU should work.
|
||||
|
||||
1. Follow download and installation instructions from [stable-diffusion-webui readme](https://github.com/AUTOMATIC1111/stable-diffusion-webui)
|
||||
## 1. Follow download and installation instructions from [stable-diffusion-webui readme](https://github.com/AUTOMATIC1111/stable-diffusion-webui)
|
||||
|
||||
2. Edit your run script settings
|
||||
## 2. Edit your run script settings
|
||||
|
||||
### Windows
|
||||
|
||||
|
|
@ -42,9 +42,9 @@ To use Stable Diffusion with this project, you will need to download and install
|
|||
# ...rest
|
||||
```
|
||||
|
||||
3. Run Stable Diffusion (either .sh or .bat file according to your operating system)
|
||||
## 3. Run Stable Diffusion (either .sh or .bat file according to your operating system)
|
||||
|
||||
4. In the app, select the plugins endpoint, open the plugins store, and install Stable Diffusion
|
||||
## 4. In the app, select the plugins endpoint, open the plugins store, and install Stable Diffusion
|
||||
- You will need the stable diffusion webui API URL, which should be `http://127.0.0.1:7860`
|
||||
- Alternatively: you (the admin) can set the value in `\.env` to bypass the prompt
|
||||
- `SD_WEBUI_URL=http://127.0.0.1:7860`
|
||||
|
|
@ -53,9 +53,10 @@ To use Stable Diffusion with this project, you will need to download and install
|
|||
|
||||
|
||||
|
||||
5. Select the plugin and enjoy!
|
||||
## 5. Select the plugin and enjoy!
|
||||
|
||||
|
||||
##
|
||||
|
||||
---
|
||||
|
||||
## [Go Back to ReadMe](../../../README.md)
|
||||
|
|
|
|||
|
|
@ -4,21 +4,21 @@ An AppID must be supplied in all calls to the Wolfram|Alpha API.
|
|||
|
||||
- Note: Wolfram API calls are limited to 100 calls/day and 2000/month for regular users.
|
||||
|
||||
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
|
||||
## 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`
|
||||
- `WOLFRAM_APP_ID=your_app_id`
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
5. Select the plugin and enjoy!
|
||||
## 5. Select the plugin and enjoy!
|
||||
|
||||
|
||||
|
||||
##
|
||||
---
|
||||
|
||||
## [Go Back to ReadMe](../../../README.md)
|
||||
|
|
|
|||
|
|
@ -4,19 +4,18 @@ If your server cannot connect to the chatGPT API server by some reason, (eg in C
|
|||
|
||||
**Warning:** `PROXY` is not `reverseProxyUrl` in `node-chatgpt-api`
|
||||
|
||||
<details>
|
||||
<summary><strong>Set up proxy in local environment </strong></summary>
|
||||
## 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**
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary><strong>Set up proxy in docker environment </strong></summary>
|
||||
|
||||
## Set up proxy in docker environment </strong></summary>
|
||||
|
||||
set in docker-compose.yml file, under services - api - environment
|
||||
|
||||
|
|
@ -31,8 +30,8 @@ set in docker-compose.yml file, under services - api - environment
|
|||
|
||||
**Change `http://127.0.0.1:7890` to your proxy server**
|
||||
|
||||
</details>
|
||||
|
||||
##
|
||||
|
||||
---
|
||||
|
||||
## [Go Back to ReadMe](../../README.md)
|
||||
|
|
|
|||
|
|
@ -1,8 +1,8 @@
|
|||
# User/Auth System
|
||||
# User/Auth System
|
||||
|
||||
## **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](https://github.com/danny-avila/chatgpt-clone/blob/main/.env.example) file.
|
||||
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
|
||||
|
|
@ -29,7 +29,7 @@ When the first account is registered, the application will automatically migrate
|
|||
|
||||
The application is setup to support OAuth2/Social Login with Google. All of the code is in place for Facebook login as well, but this has not been tested because the setup process with Facebook was honestly just too painful for me to deal with. I plan to add support for other OAuth2 providers including Github and Discord at a later time.
|
||||
|
||||
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](https://github.com/danny-avila/chatgpt-clone/blob/main/.env.example) file, then set `VITE_SHOW_GOOGLE_LOGIN_OPTION=true`.
|
||||
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, then set `VITE_SHOW_GOOGLE_LOGIN_OPTION=true`.
|
||||
|
||||
### *Instructions for setting up Google login are provided below.*
|
||||
```
|
||||
|
|
@ -54,10 +54,10 @@ Most of the code is in place for sending password reset emails, but is not yet f
|
|||
|
||||
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.
|
||||
|
||||
### ***Warning***
|
||||
### ⚠️***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.
|
||||
|
||||
##
|
||||
---
|
||||
|
||||
## [Go Back to ReadMe](../../README.md)
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue