Skip to content

Commit 66b8580

Browse files
docs: third-party tools (#848)
* docs: third-party tools * docs: third-party tools * Update third-party.md * Update third-party.md --------- Co-authored-by: Danny Avila <110412045+danny-avila@users.noreply.github.com>
1 parent 9791a78 commit 66b8580

14 files changed

+92
-34
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,8 @@ Keep up with the latest updates by visiting the releases page - [Releases](https
9595
* [Make Your Own Plugin](docs/features/plugins/make_your_own.md)
9696
* [Using official ChatGPT Plugins](docs/features/plugins/chatgpt_plugins_openapi.md)
9797

98+
99+
* [Third-Party Tools](docs/features/third-party.md)
98100
* [Proxy](docs/features/proxy.md)
99101
* [Bing Jailbreak](docs/features/bing_jailbreak.md)
100102
</details>

docs/features/third-party.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# Third-Party Tools
2+
3+
> ⚠️ Warning: The tools featured here are not officially maintained or supported by the LibreChat team
4+
5+
#### ❗Note: If you would like to include your own tool in the list, you're welcome to submit a Pull Request.
6+
---
7+
8+
## [LibreChat Discord Bot](https://github.com/Berry-13/LibreChat-DiscordBot)
9+
10+
The LibreChat-DiscordBot is a versatile and user-friendly Discord bot designed to streamline interactions with your LibreChat server. With this bot, you can effortlessly manage the LibreChat server directly from your Discord server, eliminating the need for direct server access. It offers an array of functionalities to enhance your LibreChat experience.
11+
12+
<div>
13+
<img src="https://github.com/fuegovic/LibreChat/assets/32828263/d3841040-64d0-402f-95a5-8eb07bfbbfe5" width=400>
14+
</div>
15+
16+
---
17+
18+
## [LibreChat Android App](https://github.com/goodair220917/LibreChat-Android-App)
19+
20+
This app is a webview for LibreChat instance Android independent app, this project is forked from ChatGPT-android-app. Default webpage of this app has been set to LibreChat's GitHub Page. This app is optimized for LibreChat's function which is not an original project. For example, Social Login Oauth login support is added to this build.
21+
22+
<div>
23+
<img src="https://github.com/fuegovic/LibreChat/assets/32828263/2da13b4c-8d77-42fc-9d36-75e9913d0545" width=300>
24+
<img src="https://github.com/fuegovic/LibreChat/assets/32828263/6ec84228-f030-4aa9-9f9d-d81245dd9c03" width=300>
25+
</div>
26+
27+
---
28+
29+
## [LibreChat Windows Installer](https://github.com/fuegovic/LibreChat-Windows-Installer)
30+
31+
This script automates the local Windows 64 bits installation and offers a utility for initiating startups and updates
32+
33+
![image](https://github.com/fuegovic/LibreChat/assets/32828263/d4d1830c-ca53-4bbd-9954-9cda4ebe51b1)
34+
35+
---
36+
37+
## [LibreChat Azure Deployment](https://github.com/thunderbug1/LibreChatAzureDeployment)
38+
A Terraform setup to deploy LibreChat to Azure and setup all the necessary services.
39+
<div>
40+
<img src="https://upload.wikimedia.org/wikipedia/commons/thumb/f/fa/Microsoft_Azure.svg/1280px-Microsoft_Azure.svg.png" width=150>
41+
</div>
42+
43+
---
44+

docs/general_info/breaking_changes.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
# ⚠️ **Breaking Changes** ⚠️
22

3-
## Note:
3+
> **Note:**
44
**If you experience any issues after updating, we recommend clearing your browser cache and cookies.**
5-
65
Certain changes in the updates may impact cookies, leading to unexpected behaviors if not cleared properly.
76

87
## v0.5.7

docs/install/apis_and_tokens.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,6 +108,8 @@ These steps are quick workarounds as other solutions would require renaming envi
108108

109109
---
110110
## [Free AI APIs](free_ai_apis.md)
111+
111112
---
112-
### Note: If you're still having trouble, before creating a new issue, please search for similar ones on our [#issues thread on our discord](https://discord.gg/weqZFtD9C4) or our [troubleshooting discussion](https://github.com/danny-avila/LibreChat/discussions/categories/troubleshooting) on our Discussions page. If you don't find a relevant issue, feel free to create a new one and provide as much detail as possible.
113+
114+
>⚠️ Note: If you're having trouble, before creating a new issue, please search for similar ones on our [#issues thread on our discord](https://discord.gg/weqZFtD9C4) or our [troubleshooting discussion](https://github.com/danny-avila/LibreChat/discussions/categories/troubleshooting) on our Discussions page. If you don't find a relevant issue, feel free to create a new one and provide as much detail as possible.
113115

docs/install/container_install.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -215,4 +215,8 @@ podman run \
215215

216216
# Stop the container (if it's confirmed to be running) and restart the service
217217
podman stop librechat && systemctl --user start container-librechat
218-
```
218+
```
219+
220+
---
221+
222+
>⚠️ Note: If you're having trouble, before creating a new issue, please search for similar ones on our [#issues thread on our discord](https://discord.gg/weqZFtD9C4) or our [troubleshooting discussion](https://github.com/danny-avila/LibreChat/discussions/categories/troubleshooting) on our Discussions page. If you don't find a relevant issue, feel free to create a new one and provide as much detail as possible.

docs/install/default_language.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,4 +33,4 @@ export default { lang };
3333
```
3434
---
3535

36-
### **If you wish to contribute your own translation to LibreChat, please refer to this document for instructions: [Contribute a Translation](../contributions/translation_contribution.md)**
36+
> **If you wish to contribute your own translation to LibreChat, please refer to this document for instructions: [Contribute a Translation](../contributions/translation_contribution.md)**

docs/install/docker_compose_install.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,4 +111,4 @@ That's it! If you need more detailed information on configuring your compose fil
111111

112112
---
113113

114-
### Note: If you're still having trouble, before creating a new issue, please search for similar ones on our [#issues thread on our discord](https://discord.gg/weqZFtD9C4) or our [troubleshooting discussion](https://github.com/danny-avila/LibreChat/discussions/categories/troubleshooting) on our Discussions page. If you don't find a relevant issue, feel free to create a new one and provide as much detail as possible.
114+
>⚠️ Note: If you're having trouble, before creating a new issue, please search for similar ones on our [#issues thread on our discord](https://discord.gg/weqZFtD9C4) or our [troubleshooting discussion](https://github.com/danny-avila/LibreChat/discussions/categories/troubleshooting) on our Discussions page. If you don't find a relevant issue, feel free to create a new one and provide as much detail as possible.

docs/install/free_ai_apis.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,3 +40,7 @@ You can set `OPENAI_API_KEY=user_provided` if you would like the user to add the
4040

4141
### Plugins also work with this reverse proxy (OpenAI models). [More info on plugins here](https://docs.librechat.ai/features/plugins/introduction.html)
4242
![Screenshot 2023-07-23 202426](https://github.com/danny-avila/LibreChat/assets/110412045/45d0f79f-0963-49c0-9d1c-c292d1c25588)
43+
44+
---
45+
46+
>⚠️ Note: If you're having trouble, before creating a new issue, please search for similar ones on our [#issues thread on our discord](https://discord.gg/weqZFtD9C4) or our [troubleshooting discussion](https://github.com/danny-avila/LibreChat/discussions/categories/troubleshooting) on our Discussions page. If you don't find a relevant issue, feel free to create a new one and provide as much detail as possible.

docs/install/linux_install.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -132,4 +132,4 @@ gnome-terminal --tab --title="LibreChat" --working-directory=/home/user/LibreCha
132132

133133
---
134134

135-
### Note: If you're still having trouble, before creating a new issue, please search for similar ones on our [#issues thread on our discord](https://discord.gg/weqZFtD9C4) or our [troubleshooting discussion](https://github.com/danny-avila/LibreChat/discussions/categories/troubleshooting) on our Discussions page. If you don't find a relevant issue, feel free to create a new one and provide as much detail as possible.
135+
>⚠️ Note: If you're having trouble, before creating a new issue, please search for similar ones on our [#issues thread on our discord](https://discord.gg/weqZFtD9C4) or our [troubleshooting discussion](https://github.com/danny-avila/LibreChat/discussions/categories/troubleshooting) on our Discussions page. If you don't find a relevant issue, feel free to create a new one and provide as much detail as possible.

docs/install/mac_install.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,4 +92,4 @@ npm run backend
9292

9393
---
9494

95-
### Note: If you're still having trouble, before creating a new issue, please search for similar ones on our [#issues thread on our discord](https://discord.gg/weqZFtD9C4) or our [troubleshooting discussion](https://github.com/danny-avila/LibreChat/discussions/categories/troubleshooting) on our Discussions page. If you don't find a relevant issue, feel free to create a new one and provide as much detail as possible.
95+
>⚠️ Note: If you're having trouble, before creating a new issue, please search for similar ones on our [#issues thread on our discord](https://discord.gg/weqZFtD9C4) or our [troubleshooting discussion](https://github.com/danny-avila/LibreChat/discussions/categories/troubleshooting) on our Discussions page. If you don't find a relevant issue, feel free to create a new one and provide as much detail as possible.

docs/install/mongodb.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,4 +86,6 @@
8686
mongodb+srv://fuegovic:1Gr8Banana@render-librechat.fgycwpi.mongo.net/?retryWrites=true
8787
```
8888

89-
### Note: If you're still having trouble, before creating a new issue, please search for similar ones on our [#issues thread on our discord](https://discord.gg/weqZFtD9C4) or our [troubleshooting discussion](https://github.com/danny-avila/LibreChat/discussions/categories/troubleshooting) on our Discussions page. If you don't find a relevant issue, feel free to create a new one and provide as much detail as possible.
89+
---
90+
91+
>⚠️ Note: If you're having trouble, before creating a new issue, please search for similar ones on our [#issues thread on our discord](https://discord.gg/weqZFtD9C4) or our [troubleshooting discussion](https://github.com/danny-avila/LibreChat/discussions/categories/troubleshooting) on our Discussions page. If you don't find a relevant issue, feel free to create a new one and provide as much detail as possible.

docs/install/user_auth_system.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
# User/Auth System
22

3+
4+
>⚠️ Note: If you're having trouble, before creating a new issue, please search for similar ones on our [#issues thread on our discord](https://discord.gg/weqZFtD9C4) or our [troubleshooting discussion](https://github.com/danny-avila/LibreChat/discussions/categories/troubleshooting) on our Discussions page. If you don't find a relevant issue, feel free to create a new one and provide as much detail as possible.
5+
36
## **First Time Setup**
47

58
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.

docs/install/windows_install.md

Lines changed: 22 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -33,47 +33,44 @@ In this video we're going to install LibreChat on Windows 11 using Docker and Gi
3333

3434
Have fun!
3535

36-
---
37-
## **Other installation methods:**
38-
### **[Windows Installer](https://github.com/fuegovic/LibreChat-Windows-Installer)**
39-
(Includes a Startup and Update Utility)
40-
4136
---
42-
4337
## **Manual Installation**
44-
## Install the prerequisites on your machine
4538

46-
## **Download LibreChat**
47-
48-
- Download the latest release here: https://github.com/danny-avila/LibreChat/releases/
39+
- Install the prerequisites on your machine 👇
40+
41+
### Download and Install Node.js (Required)
42+
43+
- Navigate to https://nodejs.org/en/download and to download the latest Node.js version for your OS (The Node.js installer includes the NPM package manager.)
44+
45+
### Download and Install Git (Recommended)
46+
- Git: https://git-scm.com/download/win
47+
48+
### [Create a MongoDB database](mongodb.md) (Required)
49+
50+
### [Get Your API keys and Tokens](apis_and_tokens.md) (Required)
51+
- You must set up at least one of these tokens or APIs to run the app.
52+
53+
### Download LibreChat (Required)
54+
- (With Git) Open Terminal (command prompt) and clone the repository by running `git clone https://github.com/danny-avila/LibreChat.git`
55+
- Or download the latest release here: https://github.com/danny-avila/LibreChat/releases/
4956
- Or by clicking on the green code button in the top of the page and selecting "Download ZIP"
50-
- Open Terminal (command prompt) and clone the repository by running `git clone https://github.com/danny-avila/LibreChat.git`
5157
- If you downloaded a zip file, extract the content in "C:/LibreChat/"
5258
- **IMPORTANT : If you install the files somewhere else modify the instructions accordingly**
5359

54-
## **Enable the Conversation search feature:** (optional)
60+
### Enable the Conversation search feature: (optional)
5561
5662
- Download MeiliSearch latest release from : https://github.com/meilisearch/meilisearch/releases
5763
- Copy it to "C:/LibreChat/"
5864
- Rename the file to "meilisearch.exe"
5965
- Open it by double clicking on it
6066
- Copy the generated Master Key and save it somewhere (You will need it later)
61-
62-
## **Download and Install Node.js**
63-
64-
- Navigate to https://nodejs.org/en/download and to download the latest Node.js version for your OS (The Node.js installer includes the NPM package manager.)
65-
66-
## [Create a MongoDB database](mongodb.md) (Required)
6767

68-
## [Get Your API keys and Tokens](apis_and_tokens.md) (Required)
69-
- You must set up at least one of these tokens or APIs to run the app.
7068

71-
## [User/Auth System](../install/user_auth_system.md) (Optional)
69+
### [User/Auth System](../install/user_auth_system.md) (Optional)
7270
- How to set up the user/auth system and Google login.
7371

74-
## Setup and Run the app
75-
76-
## Using the command line (in the root directory)
72+
## Setup and Run LibreChat
73+
Using the command line (in the root directory)
7774
### To setup the app:
7875
1. Run `npm ci` (this step will also create the env file)
7976
2. Run `npm run frontend`
@@ -109,4 +106,4 @@ Have fun!
109106

110107
---
111108

112-
### Note: If you're still having trouble, before creating a new issue, please search for similar ones on our [#issues thread on our discord](https://discord.gg/weqZFtD9C4) or our [troubleshooting discussion](https://github.com/danny-avila/LibreChat/discussions/categories/troubleshooting) on our Discussions page. If you don't find a relevant issue, feel free to create a new one and provide as much detail as possible.
109+
>⚠️ Note: If you're having trouble, before creating a new issue, please search for similar ones on our [#issues thread on our discord](https://discord.gg/weqZFtD9C4) or our [troubleshooting discussion](https://github.com/danny-avila/LibreChat/discussions/categories/troubleshooting) on our Discussions page. If you don't find a relevant issue, feel free to create a new one and provide as much detail as possible.

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,7 @@ nav:
102102
- Azure Cognitive Search: 'features/plugins/azure_cognitive_search.md'
103103
- Make Your Own Plugin: 'features/plugins/make_your_own.md'
104104
- Using official ChatGPT Plugins: 'features/plugins/chatgpt_plugins_openapi.md'
105+
- Third-Party Tools: 'features/third-party.md'
105106
- Proxy: 'features/proxy.md'
106107
- Bing Jailbreak: 'features/bing_jailbreak.md'
107108
- Cloud Deployment:

0 commit comments

Comments
 (0)