documentation update: mongodb (danny-avila#1347)

* update dotenv.md add details about the MONGO_URI connection string format * update mongodb.md add details about the MONGO_URI connection string format
jung0han · Dec 14, 2023 · 1f5cb71 · 1f5cb71
1 parent bff3657
commit 1f5cb71
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 3 deletions.
diff --git a/docs/install/dotenv.md b/docs/install/dotenv.md
@@ -30,7 +30,9 @@ PORT=3080
 
 ### MongoDB Database
 
-- Change this to your MongoDB URI if different. It is recommend to append LibreChat.
+- Change this to your MongoDB URI if different. You should also add `LibreChat` or your own `APP_TITLE` as the database name in the URI. For example:
+  - if you are using docker, the URI format is `mongodb://<ip>:<port>/<database>`. Your `MONGO_URI` should look like this: `mongodb://127.0.0.1:27018/LibreChat`
+  - if you are using an online db, the URI format is `mongodb+srv://<username>:<password>@<host>/<database>?<options>`. Your `MONGO_URI` should look like this: `mongodb+srv://username:[email protected]/LibreChat?retryWrites=true` (`retryWrites=true` is the only option you need when using the online db)
 - Instruction on how to create an online MongoDB database (useful for use without docker):
     - [Online MongoDB](./mongodb.md)
 - Securely access your docker MongoDB database:

diff --git a/docs/install/mongodb.md b/docs/install/mongodb.md
@@ -80,10 +80,10 @@
 
   ![image](https://github.com/fuegovic/LibreChat/assets/32828263/ccc52648-39fa-4f45-8e2b-96c93ffede4a)
 
-- Make sure to replace `<password>` with the database password you created in the "[database credentials](#database-credentials)" section above. Do not forget to remove the `<` `>` around the password. Also remove `&w=majority` at the end of the connection string.
+- The URI format is `mongodb+srv://<username>:<password>@<host>/<database>?<options>`. Make sure to replace `<password>` with the database password you created in the "[database credentials](#database-credentials)" section above. Do not forget to remove the `<` `>` around the password. Also remove `&w=majority` at the end of the connection string. `retryWrites=true` is the only option you need to keep. You should also add `LibreChat` or your own `APP_TITLE` as the database name in the URI.
 - example:
 ```
-mongodb+srv://fuegovic:[email protected]/?retryWrites=true
+mongodb+srv://fuegovic:[email protected]/LibreChat?retryWrites=true
 ```
 
 ---