Andreas/LibreChat
1
0
Fork 0
mirror of https://github.com/danny-avila/LibreChat.git synced 2025-12-17 00:40:14 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 6

Docs: fix meilisearch_in_render.md and update email password reset instructions (#1062)

Browse source 
* Update user_auth_system.md

* Update .env.example

* Update .env.example

fix typo

* Update .env.example

typo

* Update user_auth_system.md

* Update meilisearch_in_render.md

fix image links for mkdocs

* Update README.md
This commit is contained in:
Fuegovic 2023-10-16 13:35:37 -04:00 • committed by GitHub
parent 0450c34e3b
commit 9f201577ef
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 18 additions and 15 deletions
Download patch file Download diff file Expand all files Collapse all files

3
.env.example
View file

@ -398,7 +398,8 @@ DOMAIN_SERVER=http://localhost:3080
########################### ###########################
# Email is used for password reset. Note that all 4 values must be set for email to work. # Email is used for password reset. Note that all 4 values must be set for email to work.
# Failing to set the 4 values will result in LibreChat using the unsecured password reset!
EMAIL_SERVICE= # eg. gmail EMAIL_SERVICE= # eg. gmail
EMAIL_USERNAME= # eg. your email address if using gmail EMAIL_USERNAME= # eg. your email address if using gmail
EMAIL_PASSWORD= # eg. this is the "app password" if using gmail EMAIL_PASSWORD= # eg. this is the "app password" if using gmail
EMAIL_FROM= # eg. email address for from field like noreply@librechat.ai EMAIL_FROM=noreply@librechat.ai # email address for from field, it is required to set a value here even in the cases where it's not porperly working.

1
README.md
View file

@ -113,6 +113,7 @@ Keep up with the latest updates by visiting the releases page - [Releases](https
* [Ngrok](docs/deployment/ngrok.md) * [Ngrok](docs/deployment/ngrok.md)
* [HuggingFace](docs/deployment/huggingface.md) * [HuggingFace](docs/deployment/huggingface.md)
* [Render](docs/deployment/render.md) * [Render](docs/deployment/render.md)
* [Meilisearch in Render](docs/deployment/meilisearch_in_render.md)
* [Hetzner](docs/deployment/hetzner_ubuntu.md) * [Hetzner](docs/deployment/hetzner_ubuntu.md)
* [Heroku](docs/deployment/heroku.md) * [Heroku](docs/deployment/heroku.md)
</details> </details>

26
docs/deployment/meilisearch_in_render.md
View file

@ -7,26 +7,27 @@
**2.** Access your control panel **2.** Access your control panel
**3.** Select `New` and then `Web Service` **3.** Select `New` and then `Web Service`
![image](https://github.com/fuegovic/LibreChat/assets/32828263/4edeceaf-6032-4bd0-9575-0dda76fd9958) ![image](https://github.com/danny-avila/LibreChat/assets/32828263/36e7fa0d-aa7a-4505-ad9b-a2daabaca712)
**4.** Add `https://github.com/itzraiss/Meilisearch` to the public repositories section and click `continue` **4.** Add `https://github.com/itzraiss/Meilisearch` to the public repositories section and click `continue`
![image](https://github.com/itzraiss/images/blob/main/Captura%20de%20tela%202023-09-19%20184044.png) ![image](https://github.com/danny-avila/LibreChat/assets/32828263/9a982355-a575-4e95-8d21-dffaf8252426)
**5.** Assign a unique name and proceed with the free option and click on the `create web service` button at the bottom of the page **5.** Assign a unique name and proceed with the free option and click on the `create web service` button at the bottom of the page
![image](https://github.com/itzraiss/images/blob/main/Captura%20de%20tela%202023-09-19%20185545.png) ![image](https://github.com/danny-avila/LibreChat/assets/32828263/691132c7-afea-4125-9ca5-a9a8854dc1c2)
## Click on Advanced to add Environment Variables ## Click on Advanced to add Environment Variables
![image](https://github.com/itzraiss/images/blob/main/imagem_2023-09-19_185841007.png)
![image](https://github.com/danny-avila/LibreChat/assets/32828263/0fb3e3cf-9cfd-463c-8b02-a31354f0cabb)
## Add the Environment Variables ## Add the Environment Variables
**1.** To manually add the `Environment Variables` **1.** To manually add the `Environment Variables`
- You need to use `Add Environment Variables` and add them one at a time, as adding a secret file will not work in our case. - You need to use `Add Environment Variables` and add them one at a time, as adding a secret file will not work in our case.
![image](https://github.com/itzraiss/images/blob/main/Captura%20de%20tela%202023-09-19%20184259.png) ![image](https://github.com/danny-avila/LibreChat/assets/32828263/8cbc35e5-2b9b-4dad-835f-f0444627a01f)
**2.** You need to enter these values: **2.** You need to enter these values:
@ -41,18 +42,17 @@
**1.** Everything is set up, now all you need to do is click on 'Create Web Service'. This will take a few seconds **1.** Everything is set up, now all you need to do is click on 'Create Web Service'. This will take a few seconds
![image](https://github.com/itzraiss/images/blob/main/Captura%20de%20tela%202023-09-19%20184303.png) ![image](https://github.com/danny-avila/LibreChat/assets/32828263/282f0bf3-923f-4603-aaf6-0fcc5b085635)
**3.** Once it's ready, you'll see `your service is live 🎉` in the console and the green `Live` icon at the top **3.** Once it's ready, you'll see `your service is live 🎉` in the console and the green `Live` icon at the top
![image](https://github.com/itzraiss/images/blob/main/imagem_2023-09-19_192433154.png) ![image](https://github.com/danny-avila/LibreChat/assets/32828263/2f1cdca7-658d-4de7-95a1-915d784e1ec2)
**Get URL Address** **Get URL Address**
Once you get the message: `your service is live 🎉`, copy the URL address of your project in the top left corner of Render: Once you get the message: `your service is live 🎉`, copy the URL address of your project in the top left corner of Render:
![image](https://github.com/itzraiss/images/blob/main/Captura%20de%20tela%202023-09-19%20184509.png) ![image](https://github.com/danny-avila/LibreChat/assets/32828263/f879ac99-8273-467c-8389-ce54703fc1ff)
## In LibreChat Project ## In LibreChat Project
@ -66,17 +66,17 @@ Now, insert the below environment variable values into your LibreChat project (R
| MEILI_NO_ANALYTICS | true | | MEILI_NO_ANALYTICS | true |
| SEARCH | true | | SEARCH | true |
![image](https://github.com/itzraiss/images/blob/main/imagem_2023-09-19_190801655.png) ![image](https://github.com/danny-avila/LibreChat/assets/32828263/f4ff1310-dc6b-4a81-944e-0eece8606b86)
## Deployment ## Deployment
**1.** Now, click on `Manual Deployment` and select `Clear build cache & Deploy`. It will take a few minutes **1.** Now, click on `Manual Deployment` and select `Clear build cache & Deploy`. It will take a few minutes
![image](https://github.com/itzraiss/images/blob/main/Captura%20de%20tela%202023-09-19%20193702.png) ![image](https://github.com/danny-avila/LibreChat/assets/32828263/075adc07-df7d-43e6-9d1c-783ee0cf47ea)
**3.** Once it's ready, you'll see `your service is live 🎉` in the console and the green `Live` icon at the top **3.** Once it's ready, you'll see `your service is live 🎉` in the console and the green `Live` icon at the top
![image](https://github.com/itzraiss/images/blob/main/imagem_2023-09-19_200952435.png) ![image](https://github.com/danny-avila/LibreChat/assets/32828263/fd7cbcc3-4854-4733-ab18-4d0efc170a83)
## Conclusion ## Conclusion
Now, you should be able to perform searches again, congratulations, you have successfully deployed Meilisearch on render.com Now, you should be able to perform searches again, congratulations, you have successfully deployed Meilisearch on render.com

3
docs/install/user_auth_system.md
View file

@ -202,7 +202,8 @@ EMAIL_PASSWORD=your-app-password
EMAIL_FROM=email address for the from field, e.g., noreply@librechat.ai EMAIL_FROM=email address for the from field, e.g., noreply@librechat.ai
``` ```
NOTE: The variable EMAIL_FROM currently does not work. To stay updated, check the bug fixes [here](https://github.com/danny-avila/LibreChat/tags). NOTE: ⚠️ **Failing to set the 4 values will result in LibreChat using the unsecured password reset!** The variable EMAIL_FROM does not support all email providers **but is still required**. To stay updated, check the bug fixes [here](https://github.com/danny-avila/LibreChat/tags).
## **Disable User Registration** ## **Disable User Registration**