docs: third-party tools (danny-avila#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>
cnkang · Aug 28, 2023 · e685e68 · e685e68
1 parent ae1c56f
commit e685e68
Show file tree

Hide file tree

Showing 14 changed files with 92 additions and 34 deletions.
diff --git a/README.md b/README.md
@@ -95,6 +95,8 @@ Keep up with the latest updates by visiting the releases page - [Releases](https
     * [Make Your Own Plugin](docs/features/plugins/make_your_own.md)
     * [Using official ChatGPT Plugins](docs/features/plugins/chatgpt_plugins_openapi.md)
 
+
+  * [Third-Party Tools](docs/features/third-party.md)
   * [Proxy](docs/features/proxy.md)
   * [Bing Jailbreak](docs/features/bing_jailbreak.md)
 </details>

diff --git a/docs/features/third-party.md b/docs/features/third-party.md
@@ -0,0 +1,44 @@
+# Third-Party Tools
+
+> ⚠️ Warning: The tools featured here are not officially maintained or supported by the LibreChat team
+
+#### ❗Note: If you would like to include your own tool in the list, you're welcome to submit a Pull Request.
+---
+
+## [LibreChat Discord Bot](https://github.com/Berry-13/LibreChat-DiscordBot)
+
+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.
+
+<div>
+<img src="https://github.com/fuegovic/LibreChat/assets/32828263/d3841040-64d0-402f-95a5-8eb07bfbbfe5" width=400>
+</div>
+
+---
+
+## [LibreChat Android App](https://github.com/goodair220917/LibreChat-Android-App)
+
+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.
+
+<div>
+<img src="https://github.com/fuegovic/LibreChat/assets/32828263/2da13b4c-8d77-42fc-9d36-75e9913d0545" width=300>
+<img src="https://github.com/fuegovic/LibreChat/assets/32828263/6ec84228-f030-4aa9-9f9d-d81245dd9c03" width=300>
+</div>
+
+---
+
+## [LibreChat Windows Installer](https://github.com/fuegovic/LibreChat-Windows-Installer)
+
+This script automates the local Windows 64 bits installation and offers a utility for initiating startups and updates
+
+![image](https://github.com/fuegovic/LibreChat/assets/32828263/d4d1830c-ca53-4bbd-9954-9cda4ebe51b1)
+
+---
+
+## [LibreChat Azure Deployment](https://github.com/thunderbug1/LibreChatAzureDeployment)
+A Terraform setup to deploy LibreChat to Azure and setup all the necessary services.
+<div>
+<img src="https://upload.wikimedia.org/wikipedia/commons/thumb/f/fa/Microsoft_Azure.svg/1280px-Microsoft_Azure.svg.png" width=150>
+</div>
+
+---
+
diff --git a/docs/general_info/breaking_changes.md b/docs/general_info/breaking_changes.md
@@ -1,8 +1,7 @@
 # ⚠️ **Breaking Changes** ⚠️
 
-## Note:
+> **Note:**
 **If you experience any issues after updating, we recommend clearing your browser cache and cookies.**
-
 Certain changes in the updates may impact cookies, leading to unexpected behaviors if not cleared properly.
 
 ## v0.5.7

diff --git a/docs/install/apis_and_tokens.md b/docs/install/apis_and_tokens.md
@@ -108,6 +108,8 @@ These steps are quick workarounds as other solutions would require renaming envi
 
 ---
  ## [Free AI APIs](free_ai_apis.md)
+
 ---
-### 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.
+
+>⚠️ 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.
 
diff --git a/docs/install/container_install.md b/docs/install/container_install.md
@@ -215,4 +215,8 @@ podman run \
 
 # Stop the container (if it's confirmed to be running) and restart the service
 podman stop librechat && systemctl --user start container-librechat
-```
+```
+
+---
+
+>⚠️ 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.
diff --git a/docs/install/default_language.md b/docs/install/default_language.md
@@ -33,4 +33,4 @@ export default { lang };
 ```
 ---
 
-### **If you wish to contribute your own translation to LibreChat, please refer to this document for instructions: [Contribute a Translation](../contributions/translation_contribution.md)**
+> **❗If you wish to contribute your own translation to LibreChat, please refer to this document for instructions: [Contribute a Translation](../contributions/translation_contribution.md)**
diff --git a/docs/install/docker_compose_install.md b/docs/install/docker_compose_install.md
@@ -111,4 +111,4 @@ That's it! If you need more detailed information on configuring your compose fil
 
 ---
 
-### 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.
+>⚠️ 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.
diff --git a/docs/install/free_ai_apis.md b/docs/install/free_ai_apis.md
@@ -40,3 +40,7 @@ You can set `OPENAI_API_KEY=user_provided` if you would like the user to add the
 
 ### Plugins also work with this reverse proxy (OpenAI models). [More info on plugins here](https://docs.librechat.ai/features/plugins/introduction.html)
 ![Screenshot 2023-07-23 202426](https://github.com/danny-avila/LibreChat/assets/110412045/45d0f79f-0963-49c0-9d1c-c292d1c25588)
+
+---
+
+>⚠️ 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.
diff --git a/docs/install/linux_install.md b/docs/install/linux_install.md
@@ -132,4 +132,4 @@ gnome-terminal --tab --title="LibreChat" --working-directory=/home/user/LibreCha
 
 ---
 
-### 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.
+>⚠️ 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.
diff --git a/docs/install/mac_install.md b/docs/install/mac_install.md
@@ -92,4 +92,4 @@ npm run backend
 
 ---
 
-### 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.
+>⚠️ 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.
diff --git a/docs/install/mongodb.md b/docs/install/mongodb.md
@@ -86,4 +86,6 @@
 mongodb+srv://fuegovic:1Gr8Banana@render-librechat.fgycwpi.mongo.net/?retryWrites=true
 ```
 
-### 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.
+---
+
+>⚠️ 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.
diff --git a/docs/install/user_auth_system.md b/docs/install/user_auth_system.md
@@ -1,5 +1,8 @@
 # User/Auth System
 
+
+>⚠️ 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.
+
 ## **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](/.env.example) file.

diff --git a/docs/install/windows_install.md b/docs/install/windows_install.md
@@ -33,47 +33,44 @@ In this video we're going to install LibreChat on Windows 11 using Docker and Gi
 
 Have fun!
 
---- 
-## **Other installation methods:**
-### **[Windows Installer](https://github.com/fuegovic/LibreChat-Windows-Installer)**
-(Includes a Startup and Update Utility)
-
 ---
-
 ## **Manual Installation**
-## Install the prerequisites on your machine
 
-## **Download LibreChat**
-
-  - Download the latest release here: https://github.com/danny-avila/LibreChat/releases/
+- Install the prerequisites on your machine 👇
+
+### Download and Install Node.js (Required)
+
+  - 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.)
+
+### Download and Install Git (Recommended)
+- Git: https://git-scm.com/download/win
+
+### [Create a MongoDB database](mongodb.md) (Required)
+
+### [Get Your API keys and Tokens](apis_and_tokens.md) (Required)
+- You must set up at least one of these tokens or APIs to run the app.
+
+### Download LibreChat (Required)
+  - (With Git) Open Terminal (command prompt) and clone the repository by running `git clone https://github.com/danny-avila/LibreChat.git`
+  - Or download the latest release here: https://github.com/danny-avila/LibreChat/releases/
   - Or by clicking on the green code button in the top of the page and selecting "Download ZIP"
-  - Open Terminal (command prompt) and clone the repository by running `git clone https://github.com/danny-avila/LibreChat.git`
   - If you downloaded a zip file, extract the content in "C:/LibreChat/" 
   - **IMPORTANT : If you install the files somewhere else modify the instructions accordingly**
 
-## **Enable the Conversation search feature:** (optional)
+### Enable the Conversation search feature: (optional)
 		
   - Download MeiliSearch latest release from : https://github.com/meilisearch/meilisearch/releases
   - Copy it to "C:/LibreChat/"
   - Rename the file to "meilisearch.exe"
   - Open it by double clicking on it
   - Copy the generated Master Key and save it somewhere (You will need it later)
-
-## **Download and Install Node.js**
-
-  - 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.)
-
-## [Create a MongoDB database](mongodb.md) (Required)
 
-## [Get Your API keys and Tokens](apis_and_tokens.md) (Required)
-- You must set up at least one of these tokens or APIs to run the app.
 
-## [User/Auth System](../install/user_auth_system.md) (Optional)
+### [User/Auth System](../install/user_auth_system.md) (Optional)
 - How to set up the user/auth system and Google login.
 
-## Setup and Run the app
-
-## Using the command line (in the root directory)
+## Setup and Run LibreChat
+Using the command line (in the root directory)
 ### To setup the app:
 1. Run `npm ci` (this step will also create the env file)
 2. Run `npm run frontend`
@@ -109,4 +106,4 @@ Have fun!
 
 ---
 
-### 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.
+>⚠️ 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.
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -102,6 +102,7 @@ nav:
       - Azure Cognitive Search: 'features/plugins/azure_cognitive_search.md'
       - Make Your Own Plugin: 'features/plugins/make_your_own.md'
       - Using official ChatGPT Plugins: 'features/plugins/chatgpt_plugins_openapi.md'
+    - Third-Party Tools: 'features/third-party.md'  
     - Proxy: 'features/proxy.md'
     - Bing Jailbreak: 'features/bing_jailbreak.md'
   - Cloud Deployment:
-Original file line number
+Diff line change
@@ Expand Up / @@ -33,4 +33,4 @@ export default { lang }; @@
     ```
     ---
-    ### **If you wish to contribute your own translation to LibreChat, please refer to this document for instructions: [Contribute a Translation](../contributions/translation_contribution.md)**
+    > **❗If you wish to contribute your own translation to LibreChat, please refer to this document for instructions: [Contribute a Translation](../contributions/translation_contribution.md)**
Original file line number	Diff line number	Diff line change
Expand Up		@@ -111,4 +111,4 @@ That's it! If you need more detailed information on configuring your compose fil

		---

		### 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.
		>⚠️ 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.
Original file line number	Diff line number	Diff line change
Expand Up		@@ -132,4 +132,4 @@ gnome-terminal --tab --title="LibreChat" --working-directory=/home/user/LibreCha

		---

		### 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.
		>⚠️ 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.
Original file line number	Diff line number	Diff line change
Expand Up		@@ -92,4 +92,4 @@ npm run backend

		---

		### 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.
		>⚠️ 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.