mirror of
https://github.com/danny-avila/LibreChat.git
synced 2025-09-22 06:00:56 +02:00
refactor: update references from chatgpt-clone to LibreChat (#541)
* refactor: update references from chatgpt-clone to LibreChat * refactor: update references from chatgpt-clone to LibreChat
This commit is contained in:
parent
3d40dce76a
commit
731304f96a
12 changed files with 34 additions and 34 deletions
|
@ -116,13 +116,13 @@ CREDS_IV=e2341419ec3dd3d19b13a1a87fafcbfb
|
|||
|
||||
# AI-Assisted Google Search
|
||||
# This bot supports searching google for answers to your questions with assistance from GPT!
|
||||
# See detailed instructions here: https://github.com/danny-avila/chatgpt-clone/blob/main/docs/features/plugins/google_search.md
|
||||
# See detailed instructions here: https://github.com/danny-avila/LibreChat/blob/main/docs/features/plugins/google_search.md
|
||||
GOOGLE_API_KEY=
|
||||
GOOGLE_CSE_ID=
|
||||
|
||||
# StableDiffusion WebUI
|
||||
# This bot supports StableDiffusion WebUI, using it's API to generated requested images.
|
||||
# See detailed instructions here: https://github.com/danny-avila/chatgpt-clone/blob/main/docs/features/plugins/stable_diffusion.md
|
||||
# See detailed instructions here: https://github.com/danny-avila/LibreChat/blob/main/docs/features/plugins/stable_diffusion.md
|
||||
# Use "http://127.0.0.1:7860" with local install and "http://host.docker.internal:7860" for docker
|
||||
SD_WEBUI_URL=http://host.docker.internal:7860
|
||||
|
||||
|
@ -151,7 +151,7 @@ PROXY=
|
|||
# ENABLING SEARCH MESSAGES/CONVOS
|
||||
# Requires the installation of the free self-hosted Meilisearch or a paid Remote Plan (Remote not tested)
|
||||
# The easiest setup for this is through docker-compose, which takes care of it for you.
|
||||
SEARCH=false
|
||||
SEARCH=true
|
||||
|
||||
# REQUIRED FOR SEARCH: MeiliSearch Host, mainly for the API server to connect to the search server.
|
||||
# Replace '0.0.0.0' with 'meilisearch' if serving MeiliSearch with docker-compose.
|
||||
|
|
2
.github/ISSUE_TEMPLATE/BUG-REPORT.yml
vendored
2
.github/ISSUE_TEMPLATE/BUG-REPORT.yml
vendored
|
@ -58,7 +58,7 @@ body:
|
|||
id: terms
|
||||
attributes:
|
||||
label: Code of Conduct
|
||||
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/danny-avila/chatgpt-clone/blob/main/documents/contributions/code_of_conduct.md)
|
||||
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/danny-avila/LibreChat/blob/main/CODE_OF_CONDUCT.md)
|
||||
options:
|
||||
- label: I agree to follow this project's Code of Conduct
|
||||
required: true
|
||||
|
|
2
.github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml
vendored
2
.github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml
vendored
|
@ -51,7 +51,7 @@ body:
|
|||
id: terms
|
||||
attributes:
|
||||
label: Code of Conduct
|
||||
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/danny-avila/chatgpt-clone/blob/main/documents/contributions/code_of_conduct.md)
|
||||
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/danny-avila/LibreChat/blob/main/CODE_OF_CONDUCT.md)
|
||||
options:
|
||||
- label: I agree to follow this project's Code of Conduct
|
||||
required: true
|
||||
|
|
2
.github/ISSUE_TEMPLATE/QUESTION.yml
vendored
2
.github/ISSUE_TEMPLATE/QUESTION.yml
vendored
|
@ -52,7 +52,7 @@ body:
|
|||
id: terms
|
||||
attributes:
|
||||
label: Code of Conduct
|
||||
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/danny-avila/chatgpt-clone/blob/main/documents/contributions/code_of_conduct.md)
|
||||
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/danny-avila/LibreChat/blob/main/CODE_OF_CONDUCT.md)
|
||||
options:
|
||||
- label: I agree to follow this project's Code of Conduct
|
||||
required: true
|
||||
|
|
12
README.md
12
README.md
|
@ -30,9 +30,9 @@ https://github.com/danny-avila/LibreChat/assets/110412045/c1eb0c0f-41f6-4335-b98
|
|||
- Response streaming identical to ChatGPT through server-sent events
|
||||
- UI from original ChatGPT, including Dark mode
|
||||
- AI model selection (through 5 endpoints: OpenAI API, BingAI, ChatGPT Browser, PaLM2, Plugins)
|
||||
- Create, Save, & Share custom presets - [More info on prompt presets here](https://github.com/danny-avila/chatgpt-clone/releases/tag/v0.3.0)
|
||||
- Create, Save, & Share custom presets - [More info on prompt presets here](https://github.com/danny-avila/LibreChat/releases/tag/v0.3.0)
|
||||
- Edit and Resubmit messages with conversation branching
|
||||
- Search all messages/conversations - [More info here](https://github.com/danny-avila/chatgpt-clone/releases/tag/v0.1.0)
|
||||
- Search all messages/conversations - [More info here](https://github.com/danny-avila/LibreChat/releases/tag/v0.1.0)
|
||||
- Plugins now available (including web access, image generation and more)
|
||||
|
||||
---
|
||||
|
@ -98,7 +98,7 @@ Keep up with the latest updates by visiting the releases page - [Releases](https
|
|||
* [Code Standards and Conventions](docs/contributions/coding_conventions.md)
|
||||
* [Testing](docs/contributions/testing.md)
|
||||
* [Security](SECURITY.md)
|
||||
* [Trello Board](https://trello.com/b/17z094kq/chatgpt-clone)
|
||||
* [Trello Board](https://trello.com/b/17z094kq/LibreChate)
|
||||
</details>
|
||||
|
||||
|
||||
|
@ -106,7 +106,7 @@ Keep up with the latest updates by visiting the releases page - [Releases](https
|
|||
|
||||
## Star History
|
||||
|
||||
[](https://star-history.com/#danny-avila/chatgpt-clone&Date)
|
||||
[](https://star-history.com/#danny-avila/LibreChat&Date)
|
||||
|
||||
---
|
||||
|
||||
|
@ -128,6 +128,6 @@ For new features, components, or extensions, please open an issue and discuss be
|
|||
|
||||
This project exists in its current state thanks to all the people who contribute
|
||||
---
|
||||
<a href="https://github.com/danny-avila/chatgpt-clone/graphs/contributors">
|
||||
<img src="https://contrib.rocks/image?repo=danny-avila/chatgpt-clone" />
|
||||
<a href="https://github.com/danny-avila/LibreChat/graphs/contributors">
|
||||
<img src="https://contrib.rocks/image?repo=danny-avila/LibreChat" />
|
||||
</a>
|
||||
|
|
|
@ -8,12 +8,12 @@
|
|||
{
|
||||
"authField": "GOOGLE_CSE_ID",
|
||||
"label": "Google CSE ID",
|
||||
"description": "This is your Google Custom Search Engine ID. For instructions on how to obtain this, see <a href='https://github.com/danny-avila/chatgpt-clone/blob/main/guides/GOOGLE_SEARCH.md'>Our Docs</a>."
|
||||
"description": "This is your Google Custom Search Engine ID. For instructions on how to obtain this, see <a href='https://github.com/danny-avila/LibreChat/blob/main/docs/features/plugins/google_search.md'>Our Docs</a>."
|
||||
},
|
||||
{
|
||||
"authField": "GOOGLE_API_KEY",
|
||||
"label": "Google API Key",
|
||||
"description": "This is your Google Custom Search API Key. For instructions on how to obtain this, see <a href='https://github.com/danny-avila/chatgpt-clone/blob/main/guides/GOOGLE_SEARCH.md'>Our Docs</a>."
|
||||
"description": "This is your Google Custom Search API Key. For instructions on how to obtain this, see <a href='https://github.com/danny-avila/LibreChat/blob/main/docs/features/plugins/google_search.md'>Our Docs</a>."
|
||||
}
|
||||
]
|
||||
},
|
||||
|
|
|
@ -97,7 +97,7 @@ Defines Mongoose models to represent data entities and their relationships.
|
|||
|
||||
### Data Services
|
||||
|
||||
Use the conventions found in the `data-provider` directory for handling data services. For more information, see [this article](https://www.danorlandoblog.com/chatgpt-clone-data-services-with-react-query/) which describes the methodology used.
|
||||
Use the conventions found in the `data-provider` directory for handling data services. For more information, see [this article](https://www.danorlandoblog.com/building-data-services-for-librechat-with-react-query/) which describes the methodology used.
|
||||
|
||||
### State Management
|
||||
|
||||
|
|
|
@ -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,10 +68,10 @@ Clicking on **"Show Agent Settings"** will allow you to modify parameters for th
|
|||
|
||||
### Showcase
|
||||
|
||||

|
||||

|
||||
|
||||
|
||||

|
||||

|
||||
|
||||
---
|
||||
|
||||
|
|
|
@ -207,12 +207,12 @@ Here are a few customConstructors, which have varying initializations
|
|||
{
|
||||
"authField": "GOOGLE_CSE_ID",
|
||||
"label": "Google CSE ID",
|
||||
"description": "This is your Google Custom Search Engine ID. For instructions on how to obtain this, see <a href='https://github.com/danny-avila/chatgpt-clone/blob/main/guides/GOOGLE_SEARCH.md'>Our Docs</a>."
|
||||
"description": "This is your Google Custom Search Engine ID. For instructions on how to obtain this, see <a href='https://github.com/danny-avila/LibreChat/blob/main/docs/features/plugins/google_search.md'>Our Docs</a>."
|
||||
},
|
||||
{
|
||||
"authField": "GOOGLE_API_KEY",
|
||||
"label": "Google API Key",
|
||||
"description": "This is your Google Custom Search API Key. For instructions on how to obtain this, see <a href='https://github.com/danny-avila/chatgpt-clone/blob/main/guides/GOOGLE_SEARCH.md'>Our Docs</a>."
|
||||
"description": "This is your Google Custom Search API Key. For instructions on how to obtain this, see <a href='https://github.com/danny-avila/LibreChat/blob/main/docs/features/plugins/google_search.md'>Our Docs</a>."
|
||||
}
|
||||
]
|
||||
},
|
||||
|
|
|
@ -55,13 +55,13 @@ 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
|
||||
|
||||

|
||||

|
||||

|
||||

|
||||
|
||||
|
||||
## 5. Select the plugin and enjoy!
|
||||
|
||||

|
||||

|
||||
|
||||
---
|
||||
|
||||
|
|
|
@ -11,13 +11,13 @@ An AppID must be supplied in all calls to the Wolfram|Alpha API.
|
|||
- 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!
|
||||
|
||||

|
||||

|
||||
|
||||
---
|
||||
|
||||
|
|
|
@ -85,23 +85,23 @@ Setup the app:
|
|||
- Open a text editor
|
||||
- Paste the following code in a new document
|
||||
- Put your MeiliSearch master key instead of "your_master_key_goes_here"
|
||||
- Save the file as "/home/user/chatgpt-clone/chatgpt-clone.sh"
|
||||
- Save the file as "/home/user/LibreChat/LibreChat.sh"
|
||||
- You can make a shortcut of this shell script and put it anywhere
|
||||
|
||||
```
|
||||
#!/bin/bash
|
||||
# the meilisearch executable needs to be at the root of the chatgpt-clone directory
|
||||
# the meilisearch executable needs to be at the root of the LibreChat directory
|
||||
|
||||
gnome-terminal --tab --title="MeiliSearch" --command="bash -c 'meilisearch --master-key your_master_key_goes_here'"
|
||||
# ↑↑↑ meilisearch is the name of the meilisearch executable, put your own master key there
|
||||
|
||||
gnome-terminal --tab --title="ChatGPT-Clone" --working-directory=/home/user/chatgpt-clone/ --command="bash -c 'npm run backend'"
|
||||
# this shell script goes at the root of the chatgpt-clone directory (/home/user/chatgpt-clone/)
|
||||
gnome-terminal --tab --title="LibreChat" --working-directory=/home/user/LibreChat/ --command="bash -c 'npm run backend'"
|
||||
# this shell script goes at the root of the LibreChat directory (/home/user/LibreChat/)
|
||||
```
|
||||
|
||||
## Update the app version
|
||||
|
||||
If you update the chatgpt-clone project files, manually redo the npm ci and npm run frontend steps.
|
||||
If you update the LibreChat project files, manually redo the npm ci and npm run frontend steps.
|
||||
|
||||
##
|
||||
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue