mirror of
https://github.com/danny-avila/LibreChat.git
synced 2025-12-17 17:00:15 +01:00
* 📑 update mkdocs * rename docker override file and add to gitignore * update .env.example - GOOGLE_MODELS * update index.md * doc refactor: split installation and configuration in two sub-folders * doc update: installation guides * doc update: configuration guides * doc: new docker override guide * doc: new beginner's guide for contributions - Thanks @Berry-13 * doc: update documentation_guidelines.md * doc: update testing.md * doc: update deployment guides * doc: update /dev readme * doc: update general_info * doc: add 0 value to doc weight * doc: add index.md to every doc folders * doc: add weight to index.md and move openrouter from free_ai_apis.md to ai_setup.md * doc: update toc so they display properly on the right had side in mkdocs * doc: update pandoranext.md * doc: index logging_system.md * doc: update readme.md * doc: update litellm.md * doc: update ./dev/readme.md * doc:🔖 new presets.md * doc: minor corrections * doc update: user_auth_system.md and presets.md, doc feat: add mermaid support to mkdocs * doc update: add screenshots to presets.md * doc update: add screenshots to - OpenID with AWS Cognito * doc update: BingAI cookie instruction * doc update: discord auth * doc update: facebook auth * doc: corrections to user_auth_system.md * doc update: github auth * doc update: google auth * doc update: auth clean up * doc organization: installation * doc organization: configuration * doc organization: features+plugins & update:plugins screenshots * doc organization: deploymend + general_info & update: tech_stack.md * doc organization: contributions * doc: minor fixes * doc: minor fixes
121 lines
4.8 KiB
Markdown
121 lines
4.8 KiB
Markdown
---
|
|
title: ⏹️ Render
|
|
weight: -4
|
|
---
|
|
# Render Deployment
|
|
|
|
## Note:
|
|
|
|
Some features will not work:
|
|
- Bing/Sydney: success may vary
|
|
- Meilisearch: additional configuration is needed, [see guide here](./meilisearch_in_render.md).
|
|
|
|
Also:
|
|
- You need to create an online MongoDB Atlas Database to be able to properly deploy
|
|
|
|
## Create an account
|
|
|
|
**1.** visit [https://render.com/](https://render.com/) and click on 'Get Started for Free` to create an account and Login
|
|
|
|
**2.** Go into your dashboard
|
|
|
|
**3.** Select `New` then `Web Service`
|
|
|
|

|
|
|
|
**4.** Add `https://github.com/danny-avila/LibreChat` in the public repositories section and click `continue`
|
|
|
|

|
|
|
|
**5.** Give it a unique name and continue with the free tier and click on the `create web service` button in the bottom of the page
|
|
|
|

|
|
|
|
**6.** At that point it will try to automatically deploy, you should cancel the deployment as it is not properly configured yet.
|
|
|
|

|
|
|
|
|
|
## Add Environement Variables
|
|
|
|
**1.** Next you want to go in the `Environement` section of the menu to manually add the `Environement Variables`
|
|
- You need to use the `Add Environement Variables` and add them one by one as adding a secret file will not work in our case.
|
|
|
|

|
|
|
|
**2.** You will need to copy and paste all of these:
|
|
|
|
| Key | Value |
|
|
| --- | --- |
|
|
| ALLOW_REGISTRATION | true |
|
|
| ANTHROPIC_API_KEY | user_provided |
|
|
| BINGAI_TOKEN | |
|
|
| CHATGPT_TOKEN | user_provided |
|
|
| CREDS_IV | e2341419ec3dd3d19b13a1a87fafcbfb |
|
|
| CREDS_KEY | f34be427ebb29de8d88c107a71546019685ed8b241d8f2ed00c3df97ad2566f0 |
|
|
| HOST | 0.0.0.0 |
|
|
| JWT_REFRESH_SECRET | secret |
|
|
| JWT_SECRET | secret |
|
|
| OPENAI_API_KEY | user_provided |
|
|
| GOOGLE_KEY | user_provided |
|
|
| PORT | 3080 |
|
|
| SESSION_EXPIRY | (1000 * 60 * 60 * 24) * 7 |
|
|
|
|
> ⬆️ **Add a single space in the value field for any endpoints that you wish to disable.**
|
|
|
|
**DO NOT FORGET TO SAVE YOUR CHANGES**
|
|
|
|

|
|
|
|
|
|
**3.** Also add `DOMAIN_CLIENT` `DOMAIN_SERVER` and use the custom render address you were attributed in the value fields
|
|
|
|
| Key | Value |
|
|
| --- | --- |
|
|
| DOMAIN_CLIENT | add your custom `onrender.com` address here |
|
|
| DOMAIN_SERVER | add your custom `onrender.com` address here |
|
|
|
|

|
|
|
|
|
|
## Create and Configure your Database
|
|
|
|
The last thing you need is to create a MongoDB Atlas Database and get your connection string.
|
|
|
|
Follow the instructions in this document: [Online MongoDB Database](../install/configuration/mongodb.md)
|
|
|
|
## Complete the Environment Variables configuration
|
|
|
|
**1.** Go back to render.com and enter one last key / value in your `Environment Variables`
|
|
|
|
| Key | Value |
|
|
| --- | --- |
|
|
| MONGO_URI | `mongodb+srv://USERNAME:PASSWORD@render-librechat.fgycwpi.mongodb.net/?retryWrites=true&w=majority` |
|
|
|
|
**2.** **Important**: Remember to replace `<password>` with the database password you created earlier (when you did **step 6** of the database creation **(do not leave the `<` `>` each side of the password)**
|
|
|
|
**3.** Save Changes
|
|
|
|
**4.** You should now have all these variables
|
|
|
|

|
|
|
|
|
|
## Deployment
|
|
|
|
**1.** Now click on `Manual Deploy` and select `Deploy latest commit`
|
|
|
|

|
|
|
|
**2.** It will take a couple of minutes
|
|
|
|

|
|
|
|
**3.** When it's ready you will see `your service is live 🎉` in the console and the green `Live` icon on top
|
|
|
|

|
|
|
|
## Conclusion
|
|
You can now access it by clicking the link, congrattulation, you've sucessfully deployed LibreChat on render.com
|
|
|
|
### Note: If you're still 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.
|