mirror of
https://github.com/danny-avila/LibreChat.git
synced 2025-09-22 08:12:00 +02:00
182 lines
7 KiB
Markdown
182 lines
7 KiB
Markdown
|
# Render Deployment
|
||
|
|
|
||
|
|
## Note:
|
||
|
|
|
||
|
|
Some features will not work:
|
||
|
|
- Bing/Sydney (the IP is blocked by Microsoft)
|
||
|
|
- Meilisearch
|
||
|
|
|
||
|
|
Also:
|
||
|
|
- You will have 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 |
|
||
|
|
| PALM_KEY | user_provided |
|
||
|
|
| PORT | 3080 |
|
||
|
|
| SESSION_EXPIRY | (1000 * 60 * 60 * 24) * 7 |
|
||
|
|
|
||
|
|
⬆️ **Add a single space in the value field for `BINGAI_TOKEN` and all other 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.
|
||
|
|
|
||
|
|
**1.** Open a new tab and go to [https://account.mongodb.com/account/register](https://account.mongodb.com/account/register) to create an account
|
||
|
|
|
||
|
|
**2.** Once you have set up your account, create a new project and name it:
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
**3.** Now select build a database:
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
**4.** Select the free tier:
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
**5.** Name your cluster (leave everything else default) and click create:
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
**6.** Enter a user name and a secure password:
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
**7.** Select Cloud environement:
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
**8.** Click /Finish and Close:
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
**9.** Go to database:
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
**10.** Click on network access in the side menu:
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
**11.** Add a IP Adress:
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
**12.** Select allow access from everywhere and confirm:
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
**13.** Now Select Database in the side menu:
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
**14.** Connect:
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
**15.** Select the first option (driver)
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
**16.** Copy the connection string:
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
## 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.
|