From 2ea6e8c18a65ccb9c3aa93ea3e3ba9db9ad4adb5 Mon Sep 17 00:00:00 2001 From: Fuegovic <32828263+fuegovic@users.noreply.github.com> Date: Mon, 4 Mar 2024 19:49:34 -0500 Subject: [PATCH] =?UTF-8?q?=F0=9F=A5=B7=F0=9F=AA=A6=20docs:=20remove=20nin?= =?UTF-8?q?ja=20and=20chatgptBrowser=20(#1973)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .env.example | 10 +-- docs/features/index.md | 1 - docs/features/ninja.md | 105 ------------------------- docs/general_info/breaking_changes.md | 7 +- docs/install/configuration/ai_setup.md | 5 +- docs/install/configuration/dotenv.md | 6 +- 6 files changed, 12 insertions(+), 122 deletions(-) delete mode 100644 docs/features/ninja.md diff --git a/.env.example b/.env.example index 8bb936ddfd..3682e0f897 100644 --- a/.env.example +++ b/.env.example @@ -50,7 +50,7 @@ DEBUG_CONSOLE=false # Endpoints # #===================================================# -# ENDPOINTS=openAI,assistants,azureOpenAI,bingAI,chatGPTBrowser,google,gptPlugins,anthropic +# ENDPOINTS=openAI,assistants,azureOpenAI,bingAI,google,gptPlugins,anthropic PROXY= @@ -102,14 +102,6 @@ ANTHROPIC_MODELS=claude-1,claude-instant-1,claude-2 BINGAI_TOKEN=user_provided # BINGAI_HOST=https://cn.bing.com -#============# -# ChatGPT # -#============# - -CHATGPT_TOKEN= -CHATGPT_MODELS=text-davinci-002-render-sha -# CHATGPT_REVERSE_PROXY= - #============# # Google # #============# diff --git a/docs/features/index.md b/docs/features/index.md index 9932664786..8ebe530656 100644 --- a/docs/features/index.md +++ b/docs/features/index.md @@ -26,7 +26,6 @@ weight: 2 * 🔥 [Firebase CDN](./firebase.md) * 🍃 [Manage Your Database](./manage_your_database.md) * 🪵 [Logging System](./logging_system.md) -* 🥷 [Ninja (ChatGPT reverse proxy)](./ninja.md) * 😈 [Bing Jailbreak](./bing_jailbreak.md) --- diff --git a/docs/features/ninja.md b/docs/features/ninja.md deleted file mode 100644 index d622d02612..0000000000 --- a/docs/features/ninja.md +++ /dev/null @@ -1,105 +0,0 @@ ---- -title: 🥷 Ninja (ChatGPT reverse proxy) -description: How to deploy Ninja, and enable the `CHATGPT_REVERSE_PROXY` for use with LibreChat. -weight: -3 ---- - -# Ninja Deployment Guide - -If you're looking to use the ChatGPT Endpoint in LibreChat **(not to be confused with [OpenAI's Official API](../install/configuration/ai_setup.md#openai))**, setting up a reverse proxy is an essential. Ninja offers a solution for this purpose, and this guide will walk you through deploying Ninja to enable the `CHATGPT_REVERSE_PROXY` for use with LibreChat. See their official GitHub for more info: [https://github.com/gngpp/ninja](https://github.com/gngpp/ninja) - -> Using this method you will only be able to use `text-davinci-002-render-sha` with Ninja in LibreChat. Other models offered with a `plus` subscription will not work. - -You can use it locally in Docker or deploy it on the web for remote access. - ---- - -## Deploy Locally Using Docker: - -For local deployment using Docker, the steps are as follows: - -### 1. **Create a Ninja folder and a docker-compose.yml file inside it:** -- Edit the docker-compose file like this: - -```yaml -version: '3.4' - -services: - ninja: - image: gngpp/ninja:latest - container_name: ninja - restart: unless-stopped - command: run - ports: - - "7999:7999" -``` - -### 2. **Set Up the LibreChat `.env` File:** -In the `.env` file within your LibreChat directory, you'll need to set the `CHATGPT_REVERSE_PROXY` variable: - -```bash -CHATGPT_REVERSE_PROXY=http://host.docker.internal:7999/backend-api/conversation -``` - -### 3. **Start Docker Containers:** -From the Ninja directory, run the following command to launch the Docker containers: - -```bash -docker compose up -d -``` - ---- - -## Alternate Docker Method: - -You can add it to the LibreChat override file if you prefer - -### 1. **Edit or Create the override file:** -In the LibreChat folder, find the `docker-compose.override.yml` file. (If you haven't created it yet you can either rename the `docker-compose.override.yml.example` to `docker-compose.override.yml`, or create a new one) - -The override file should contain this: - -```yaml -version: '3.4' - -services: - - ninja: - image: gngpp/ninja:latest - container_name: ninja - restart: unless-stopped - command: run - ports: - - "7999:7999" -``` - -### 2. **Set Up the LibreChat `.env` File:** -In the `.env` file within your LibreChat directory, you'll need to set the `CHATGPT_REVERSE_PROXY` variable: - -```bash -CHATGPT_REVERSE_PROXY=http://host.docker.internal:7999/backend-api/conversation -``` - ---- - -## Deploy Online on Hugging Face: - -To deploy Ninja online by duplicating the Hugging Face Space, follow these steps: - -### 1. **Hugging Face Space:** -Visit the [Ninja LibreChat Space](https://huggingface.co/spaces/LibreChat/Ninja) on Hugging Face. - -### 2. **Duplicate the Space:** -Utilize the available options to duplicate or fork the space into your own Hugging Face account. - -### 3. **Configure LibreChat:** -In the .env file (or secrets settings if you host LibreChat on Hugging Face), set the `CHATGPT_REVERSE_PROXY` variable using the following format: - -```bash -CHATGPT_REVERSE_PROXY=http://your_hf_space_url.com/backend-api/conversation -``` - -- Replace `your_hf_space_url.com` with the domain of your deployed space. - - Note: you can use this format: `https://your_username-ninja.hf.space` (replace `your_username` with your Huggingface username). -- The resulting URL should look similar to: -`https://your_username-ninja.hf.space/backend-api/conversation` diff --git a/docs/general_info/breaking_changes.md b/docs/general_info/breaking_changes.md index 2b1d1dc742..52e191707f 100644 --- a/docs/general_info/breaking_changes.md +++ b/docs/general_info/breaking_changes.md @@ -11,6 +11,11 @@ Certain changes in the updates may impact cookies, leading to unexpected behavio --- +## 🥷🪦 Ninja - March 4, 2024 +- Since Ninja has shut down, the ChatGPTbrowser endpoint is no longer available in LibreChat. + +--- + ## 🐋 docker-compose.yml - February 22nd, 2024 ### Update to `docker-compose.yml` @@ -89,7 +94,7 @@ see [⚙️ Environment Variables](../install/configuration/dotenv.md) for more ## January 31th 2024 - A new method to use the ChatGPT endpoint is now documented. It uses "Ninja" - For more info: - - [Ninja Deployment Guide](../features/ninja.md) + - ~~[Ninja Deployment Guide](../general_info/breaking_changes.md)~~ - [Ninja GitHub repo](https://github.com/gngpp/ninja/tree/main) --- diff --git a/docs/install/configuration/ai_setup.md b/docs/install/configuration/ai_setup.md index f4c35a8082..e02ea3b5ca 100644 --- a/docs/install/configuration/ai_setup.md +++ b/docs/install/configuration/ai_setup.md @@ -287,7 +287,7 @@ As noted earlier, [review the Custom Config Guide (click here)](./custom_config. **Important:** Stability for Unofficial APIs are not guaranteed. Access methods to these APIs are hacky, prone to errors, and patching, and are marked lowest in priority in LibreChat's development. -### ChatGPTBrowser + ### BingAI I recommend using Microsoft Edge for this: diff --git a/docs/install/configuration/dotenv.md b/docs/install/configuration/dotenv.md index 718efc4053..5e7e14a68d 100644 --- a/docs/install/configuration/dotenv.md +++ b/docs/install/configuration/dotenv.md @@ -247,10 +247,10 @@ BINGAI_TOKEN=user_provided BINGAI_HOST= ``` -### ChatGPT + ### Google Follow these instructions to setup the [Google Endpoint](./ai_setup.md#google)