mirror of
https://github.com/danny-avila/LibreChat.git
synced 2025-12-17 17:00:15 +01:00
92 lines
3.3 KiB
Markdown
92 lines
3.3 KiB
Markdown
|
# Hugging Face Deployment 🤗
|
|||
|
|
|
|||
|
|
>#### ⚠️ Note - Some features are not supported by HuggingFace:
|
|||
|
|
>- Meilisearch
|
|||
|
|
>- Social Logins
|
|||
|
|
|
|||
|
|
> #### ❗Also:
|
|||
|
|
>- You will have to create an online MongoDB Atlas Database to be able to properly deploy
|
|||
|
|
|
|||
|
|
## 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: [Online MongoDB Database](..\install\mongodb.md)
|
|||
|
|
|
|||
|
|
## Getting Started
|
|||
|
|
|
|||
|
|
**1.** Login or Create an account on [Hugging Face](https://huggingface.co/)
|
|||
|
|
|
|||
|
|
**2.** Visit [https://huggingface.co/spaces/LibreChat/LibreChat](https://huggingface.co/spaces/LibreChat/LibreChat) and click on `Duplicate this Space` to copy LibreChat into your profile
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
**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:
|
|||
|
|
|
|||
|
|
| Secrets | Values |
|
|||
|
|
| --- | --- |
|
|||
|
|
| MONGO_URI | * use the string aquired in the previous step |
|
|||
|
|
| OPENAI_API_KEY | `user_provided` |
|
|||
|
|
| BINGAI_TOKEN | `user_provided` |
|
|||
|
|
| CHATGPT_TOKEN | `user_provided` |
|
|||
|
|
| ANTHROPIC_API_KEY | `user_provided` |
|
|||
|
|
| PALM_KEY | `user_provided` |
|
|||
|
|
| CREDS_KEY | * see bellow |
|
|||
|
|
| CREDS_IV | * see bellow |
|
|||
|
|
| JWT_SECRET | * see bellow |
|
|||
|
|
| JWT_REFRESH_SECRET | * see bellow |
|
|||
|
|
|
|||
|
|
> ⬆️ **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: [https://replit.com/@daavila/crypto#index.js](https://replit.com/@daavila/crypto#index.js).
|
|||
|
|
>* Run the tool a second time and use the new `JWT_SECRET` value for the `JWT_REFRESH_SECRET`
|
|||
|
|
|
|||
|
|
| Variables | Values |
|
|||
|
|
| --- | --- |
|
|||
|
|
| APP_TITLE | LibreChat |
|
|||
|
|
| ALLOW_REGISTRATION | true |
|
|||
|
|
|
|||
|
|
|
|||
|
|
## 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! 🤗
|