Hugging Face Deployment

Create and Configure your Database (Required)

The first thing you need is to create a MongoDB Atlas Database and get your connection string.

Follow the instructions in this document: MongoDB Atlas

Getting Started

1. Login or Create an account on Hugging Face

2. Visit https://huggingface.co/spaces/LibreChat/template and click on Duplicate this Space to copy the LibreChat template into your profile.

Note: It is normal for this template to have a runtime error, you will have to configure it using the following guide to make it functional.

3. Name your Space and Fill the Secrets and Variables

You can also decide here to make it public or private

You will need to fill these values:

⬆️ Leave the value field blank for any endpoints that you wish to disable.

⚠️ setting the API keys and token to user_provided allows you to provide them safely from the webUI

• For CREDS_KEY, CREDS_IV and JWT_SECRET use this tool: Credentials Generator
• Run the tool a second time and use the new JWT_SECRET value for the JWT_REFRESH_SECRET

Deployment

1. When you’re done filling the secrets and variables, click Duplicate Space in the bottom of that window

2. The project will now build, this will take a couple of minutes

3. When ready, Building will change to Running

And you will be able to access LibreChat!

Update

To update LibreChat, simply select Factory Reboot from the ⚙️Settings menu

Conclusion

You can now access it with from the current URL. If you want to access it without the Hugging Face overlay, you can modify this URL template with your info:

https://username-projectname.hf.space/

e.g. https://cooluser-librechat.hf.space/

🎉 Congratulation, you’ve sucessfully deployed LibreChat on Hugging Face! 🤗