mirror of
https://github.com/danny-avila/LibreChat.git
synced 2025-12-17 08:50:15 +01:00
bce4f41fae
* mkdocs plugins: add plugin for social cards and plugin that allow to exclude a folder * docs: fix hyperlinks * mkdocs: social cards (descriptions) for 'contributions' and 'deployment' guides * mkdocs: social cards (descriptions) for all 'index.md' * mkdocs: social cards (descriptions) for 'features' and 'plugins' * mkdocs: social cards (descriptions) for 'general_info' * mkdocs: social cards (descriptions) for 'configuration' * mkdocs: social cards (descriptions) for 'installation' * mkdocs: minor fixes * update librechat.svg * update how_to_contribute.md add reference to the official GitHub documentation
97 lines
4 KiB
Markdown
97 lines
4 KiB
Markdown
---
|
|
title: 🍃 Online MongoDB
|
|
description: This guide teaches you how to set up an online MongoDB database for LibreChat using MongoDB Atlas, a cloud-based service. You will learn how to create an account, a project, and a cluster, as well as how to configure your database credentials, network access, and connection string.
|
|
weight: -4
|
|
---
|
|
|
|
# Set Up an Online MongoDB Database
|
|
|
|
## Create an account
|
|
- Open a new tab and go to **[account.mongodb.com/account/register](https://account.mongodb.com/account/register)** to create an account.
|
|
|
|
## Create a project
|
|
- Once you have set up your account, create a new project and name it (the name can be anything):
|
|
|
|
|
|
|
|
|
|
|
|
## Build a database
|
|
- Now select `Build a Database`:
|
|
|
|
|
|
|
|
## Choose your cloud environment
|
|
- Select the free tier:
|
|
|
|
|
|
|
|
## Name your cluster
|
|
- Name your cluster (leave everything else default) and click create:
|
|
|
|
|
|
|
|
## Database credentials
|
|
- Enter a user name and a secure password:
|
|
|
|
|
|
|
|
## Select environment
|
|
- Select `Cloud Environement`:
|
|
|
|
|
|
|
|
## Complete database configuration
|
|
- Click `Finish and Close`:
|
|
|
|
|
|
|
|
## Go to your database
|
|
- Click `Go to Databases`:
|
|
|
|
|
|
|
|
## Network access
|
|
- Click on `Network Access` in the side menu:
|
|
|
|
|
|
|
|
## Add IP adress
|
|
- Add a IP Adress:
|
|
|
|
|
|
|
|
## Allow access
|
|
- Select `Allow access from anywhere` and `Confirm`:
|
|
|
|
|
|
|
|
## Get your connection string
|
|
|
|
- Select `Database` in the side menu
|
|
|
|
|
|
|
|
- Select `Connect`:
|
|
|
|
|
|
|
|
|
|
- Select the first option (`Drivers`)
|
|
|
|
|
|
|
|
|
|
- Copy 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:1Gr8Banana@render-librechat.fgycwpi.mongo.net/LibreChat?retryWrites=true
|
|
```
|
|
|
|
---
|
|
|
|
>⚠️ 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.
|