mirror of
https://github.com/danny-avila/LibreChat.git
synced 2025-12-25 20:58:50 +01:00
🐳 docs: Formatting Fix (#1725)
This commit is contained in:
parent
7b38586716
commit
c31d5d9a1d
2 changed files with 12 additions and 11 deletions
|
|
@ -41,9 +41,11 @@ services:
|
|||
```
|
||||
|
||||
3. **Security Notice:**
|
||||
- a. 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.
|
||||
- b. You can also add native authentication to your database. See the [`docker-compose.override` guide](../install/configuration/docker_override.md#mongodb-authentication) for instructions on how to do so
|
||||
- After following the guide to authenticate MongoDB, you will need these variables under the environment section for mongo-express:
|
||||
|
||||
- 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.
|
||||
- Optional: You can also add native authentication to your database. See the [`docker-compose.override` guide](../install/configuration/docker_override.md#mongodb-authentication) for instructions on how to do so.
|
||||
- If utilizing authentication, ensure the admin user has the "clusterAdmin" and "readAnyDatabase" permissions. These steps are detailed in the [docker-compose.override guide](../install/configuration/docker_override.md#step-1-creating-an-admin-user).
|
||||
- After following the guide to authenticate MongoDB, you will need these variables under the environment section for mongo-express:
|
||||
|
||||
```yaml
|
||||
environment:
|
||||
|
|
@ -56,8 +58,6 @@ services:
|
|||
ME_CONFIG_MONGODB_ADMINPASSWORD: securePassword
|
||||
```
|
||||
|
||||
- c. If using authentication for your database, make sure the admin user has the "clusterAdmin" and "readAnyDatabase" permissions as detailed in the [`docker-compose.override` guide](../install/configuration/docker_override.md#step-1-creating-an-admin-user)
|
||||
|
||||
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:
|
||||
|
||||
```
|
||||
|
|
|
|||
|
|
@ -88,11 +88,12 @@ After starting your services with the modified configuration, you can verify tha
|
|||
By following these steps and considerations, you can easily and safely modify your Docker Compose configuration without altering the original `docker-compose.yml` file, making it simpler to manage and maintain different environments or local customizations.
|
||||
|
||||
|
||||
# MongoDB Authentication
|
||||
## MongoDB Authentication
|
||||
|
||||
Use of the `docker-compose.override.yml` file allows us to enable explicit authentication for MongoDB.
|
||||
|
||||
**Notes:**
|
||||
|
||||
- The default configuration is secure by blocking external port access, but we can take it a step further with access credentials.
|
||||
- As noted by the developers of MongoDB themselves, authentication in MongoDB is fairly complex. We will be taking a simple approach that will be good enough for most cases, especially for existing configurations of LibreChat. To learn more about how mongodb authentication works with docker, see here: https://hub.docker.com/_/mongo/
|
||||
- This guide focuses exclusively on terminal-based setup procedures.
|
||||
|
|
@ -103,7 +104,7 @@ Use of the `docker-compose.override.yml` file allows us to enable explicit authe
|
|||
- Enable authentication and create a "readWrite" user for "LibreChat"
|
||||
- Configure the MONGO_URI with newly created user
|
||||
|
||||
## Step 1: Creating an Admin User
|
||||
### Step 1: Creating an Admin User
|
||||
|
||||
First, we must stop the default containers from running, and only run the mongodb container.
|
||||
|
||||
|
|
@ -206,7 +207,7 @@ And shut down the running container:
|
|||
docker-compose down
|
||||
```
|
||||
|
||||
## Step 2: Enabling Authentication and Creating a User with `readWrite` Access
|
||||
### Step 2: Enabling Authentication and Creating a User with `readWrite` Access
|
||||
|
||||
We must now create/edit the `docker-compose.override.yml` file to enable authentication for our mongodb container. You can use this configuration to start or reference:
|
||||
|
||||
|
|
@ -302,7 +303,7 @@ db.createUser({ user: 'user', pwd: 'userpasswd', roles: [ { role: "readWrite", d
|
|||
|
||||
If it's still not persisting, you can try running the commands with all containers running, but note that the `LibreChat` container will be in an error/retrying state.
|
||||
|
||||
## Step 3: Update the `MONGO_URI` to Use the New Credentials
|
||||
### Step 3: Update the `MONGO_URI` to Use the New Credentials
|
||||
|
||||
Finally, we add the new connection string with our newly created credentials to our `docker-compose.override.yml` file under the `api` service:
|
||||
|
||||
|
|
@ -336,7 +337,7 @@ chat-mongodb | {"t":{"$date":"2024-02-04T20:59:53.880+00:00"},"s":"I", "c"
|
|||
|
||||
If you're having Authentication errors, run the last part of Step 2 again. I'm not sure why it's finicky but it will work after a few tries.
|
||||
|
||||
## TL;DR
|
||||
### TL;DR
|
||||
|
||||
These are all the necessary commands if you'd like to run through these quickly or for reference:
|
||||
|
||||
|
|
@ -362,7 +363,7 @@ docker-compose down
|
|||
docker-compose up
|
||||
```
|
||||
|
||||
# Example
|
||||
## Example
|
||||
|
||||
Example `docker-compose.override.yml` file using the [`librechat.yaml` config file](./custom_config.md), MongoDB with [authentication](#mongodb-authentication), and `mongo-express` for [managing your MongoDB database](../../features/manage_your_database.md):
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue