From 690acf1c93e5305f24b5bf847de9149bdfa47f80 Mon Sep 17 00:00:00 2001 From: Fuegovic <32828263+fuegovic@users.noreply.github.com> Date: Thu, 30 Nov 2023 13:49:39 -0500 Subject: [PATCH] =?UTF-8?q?docs:=20mongo-express=20=F0=9F=8D=83=20(#1247)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * docs: mongo-express * Update manage_your_database.md add screenshot and mongodb logo * Update manage_your_database.md upload smaller mongodb logo --- README.md | 3 +- docs/assets/LibreChat-wide-margin.svg | 342 ++----------------- docs/assets/LibreChat.svg | 440 ++----------------------- docs/features/manage_your_database.md | 71 ++++ docs/install/docker_compose_install.md | 3 + docs/install/linux_install.md | 3 + docs/install/windows_install.md | 3 + mkdocs.yml | 1 + 8 files changed, 148 insertions(+), 718 deletions(-) create mode 100644 docs/features/manage_your_database.md diff --git a/README.md b/README.md index 123c24722..127447d38 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,7 @@

-## All-In-One AI Conversations with LibreChat ## +## All-In-One AI Conversations with LibreChat LibreChat brings together the future of assistant AIs with the revolutionary technology of OpenAI's ChatGPT. Celebrating the original styling, LibreChat gives you the ability to integrate multiple AI models. It also integrates and enhances original client features such as conversation and message search, prompt templates and plugins. With LibreChat, you no longer need to opt for ChatGPT Plus and can instead use free or pay-per-call APIs. We welcome contributions, cloning, and forking to enhance the capabilities of this advanced chatbot platform. @@ -101,6 +101,7 @@ Keep up with the latest updates by visiting the releases page - [Releases](https * [Proxy](docs/features/proxy.md) * [Bing Jailbreak](docs/features/bing_jailbreak.md) * [Token Usage](docs/features/token_usage.md) + * [Manage Your Database](docs/features/manage_your_database.md)
diff --git a/docs/assets/LibreChat-wide-margin.svg b/docs/assets/LibreChat-wide-margin.svg index e94187d44..d281b210b 100644 --- a/docs/assets/LibreChat-wide-margin.svg +++ b/docs/assets/LibreChat-wide-margin.svg @@ -1,311 +1,33 @@ - + - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/assets/LibreChat.svg b/docs/assets/LibreChat.svg index 2cfb2632c..75e383531 100644 --- a/docs/assets/LibreChat.svg +++ b/docs/assets/LibreChat.svg @@ -1,408 +1,34 @@ - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/features/manage_your_database.md b/docs/features/manage_your_database.md new file mode 100644 index 000000000..dc3cc7112 --- /dev/null +++ b/docs/features/manage_your_database.md @@ -0,0 +1,71 @@ + + + +# Manage Your MongoDB Database with Mongo Express + +To enhance the security of your data, external ports for MongoDB are not exposed outside of the docker environment. However, you can safely access and manage your MongoDB database using Mongo Express, a convenient web-based administrative interface. Follow this guide to set up Mongo Express in your Docker environment. + +![image](https://github.com/danny-avila/LibreChat/assets/32828263/612cee31-7fc2-4660-98c0-06627e581bd8) + + +## Mongo-Express Setup + +Mongo Express allows you to interact with your MongoDB database through your browser. To set it up, perform the following steps: + +1. Create a new file named `docker-compose.override.yml` in the same directory as your main `docker-compose.yml` file for LibreChat. + +2. Copy the following contents into the `docker-compose.override.yml` file: + +```yaml +version: '3.4' + +services: + mongo-express: + image: mongo-express + container_name: mongo-express + environment: + ME_CONFIG_MONGODB_SERVER: mongodb + ME_CONFIG_BASICAUTH_USERNAME: admin + ME_CONFIG_BASICAUTH_PASSWORD: password + ports: + - '8081:8081' + depends_on: + - mongodb + restart: always +``` + +3. **Security Notice:** Before using this configuration, replace `admin` and `password` with a unique username and password for accessing Mongo Express. These credentials should be strong and not easily guessable to prevent unauthorized access. + +4. Save the `docker-compose.override.yml` file and run the following command from the directory where your `docker-compose.yml` file is located to start Mongo-Express along with your other Docker services: + +``` +docker-compose up -d +``` + +This command will merge the `docker-compose.override.yml` with your `docker-compose.yml` and apply the configuration. + +5. Once Mongo-Express is up and running, access it by navigating to `http://localhost:8081` in your web browser. You'll need to enter the username and password you specified for `ME_CONFIG_BASICAUTH_USERNAME` and `ME_CONFIG_BASICAUTH_PASSWORD`. + +--- + +## Removing Mongo Express + +If you wish to remove Mongo-Express from your Docker environment, follow these straightforward steps: + +1. Navigate to the directory containing your `docker-compose.yml` and `docker-compose.override.yml` files. + +2. Bring down the current Docker environment, which will stop and remove all running containers defined in the `docker-compose.yml` and `docker-compose.override.yml` files. Use the following command: + +``` +docker-compose down +``` + +3. Now you can either rename or delete the `docker-compose.override.yml` file, which contains the Mongo Express configuration. + +4. Finally, bring your Docker environment back up, which will now exclude Mongo Express: + +``` +docker-compose up -d +``` + +By following these steps, you will have successfully removed Mongo Express from your Docker environment. If you want to reinstate Mongo Express at a later time, you can either rename the backup file back to `docker-compose.override.yml` or recreate the original `docker-compose.override.yml` file with the Mongo Express configuration. diff --git a/docs/install/docker_compose_install.md b/docs/install/docker_compose_install.md index a368d52f3..a8afd87b9 100644 --- a/docs/install/docker_compose_install.md +++ b/docs/install/docker_compose_install.md @@ -26,6 +26,9 @@ Before running LibreChat with Docker, you need to configure some settings: #### [API Keys and Tokens Setup](apis_and_tokens.md) (Required) You must set up at least one of these tokens or APIs to run the app. +#### [Manage Your MongoDB Database](../features/manage_your_database.md) (Optional) +Safely access and manage your MongoDB database using Mongo Express + #### [User Authentication System Setup](../install/user_auth_system.md) (Optional) How to set up the user/auth system and Google login. diff --git a/docs/install/linux_install.md b/docs/install/linux_install.md index 2dadff3a8..439c54413 100644 --- a/docs/install/linux_install.md +++ b/docs/install/linux_install.md @@ -32,6 +32,9 @@ Here are the steps to follow: Note: If you run the command on the same computer and want to access it, navigate to `localhost:3080`. You should see a login page where you can create or sign in to your account. Then you can choose an AI model and start chatting. +- [Manage Your MongoDB Database (optional)](../features/manage_your_database.md) +Safely access and manage your MongoDB database using Mongo Express + Have fun! --- diff --git a/docs/install/windows_install.md b/docs/install/windows_install.md index 9d0445fbf..8ae911a82 100644 --- a/docs/install/windows_install.md +++ b/docs/install/windows_install.md @@ -31,6 +31,9 @@ In this video we're going to install LibreChat on Windows 11 using Docker and Gi - `docker-compose up` - Visit http://localhost:3080/ to access LibreChat. Create an account and start chatting. +- [Manage Your MongoDB Database (optional)](../features/manage_your_database.md) +Safely access and manage your MongoDB database using Mongo Express + Have fun! --- diff --git a/mkdocs.yml b/mkdocs.yml index c614c5c43..7bac2b8e1 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -104,6 +104,7 @@ nav: - Make Your Own Plugin: 'features/plugins/make_your_own.md' - Using official ChatGPT Plugins: 'features/plugins/chatgpt_plugins_openapi.md' - Automated Moderation: 'features/mod_system.md' + - Manage Your Database: 'features/manage_your_database.md' - Token Usage: 'features/token_usage.md' - Third-Party Tools: 'features/third_party.md' - Proxy: 'features/proxy.md'