HuggingFace

创建并配置您的数据库 (必需)

你需要做的第一件事是创建一个 MongoDB Atlas 数据库并获取你的连接字符串。

请按照本文档中的说明进行操作：MongoDB Atlas

入门指南

1. 在 Hugging Face 上登录或创建一个账户

2. 访问 https://huggingface.co/spaces/LibreChat/template 并点击 Duplicate this Space，将 LibreChat 模板复制到您的个人资料中。

注意：此模板出现运行时错误是正常的，您需要按照以下指南进行配置才能使其正常工作。

3. 为您的 Space 命名并填写 Secrets 和 Variables

您也可以在此处决定将其设为公开或私有。

您需要填写这些值：

⬆️ 对于您希望禁用的任何 endpoint，请将 value 字段留空。

⚠️ 将 API 密钥和令牌设置为 user_provided 允许您从 WebUI 安全地提供它们

• 对于 CREDS_KEY、CREDS_IV 和 JWT_SECRET，请使用此工具：Credentials Generator
• 第二次运行该工具，并将新的 JWT_SECRET 值用于 JWT_REFRESH_SECRET

部署

1. 当您完成 secrets 和 variables 的填写后，点击该窗口底部的 Duplicate Space

2. 项目现在将开始构建，这需要几分钟时间

3. 准备就绪后，Building 将变为 Running

这样您就可以访问 LibreChat 了！

更新

要更新 LibreChat，只需从 ⚙️Settings 菜单中选择 Factory Reboot。

结论

您现在可以通过当前 URL 访问它。如果您想在没有 Hugging Face 覆盖层的情况下访问它，可以使用您的信息修改此 URL 模板：

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

例如 https://cooluser-librechat.hf.space/

🎉 恭喜，您已成功在 Hugging Face 上部署了 LibreChat！🤗

Meilisearch 设置（可选）

要在 LibreChat 中启用搜索功能，您需要部署并配置一个 Meilisearch 实例。具体步骤如下：

1. 复制 Meilisearch Space：

访问此链接：https://huggingface.co/spaces/LibreChat/meilisearch 并点击“Duplicate this Space”。

2. 配置 Meilisearch 空间：

• 可见性： 将可见性设置为 "public"。

• MEILI_MASTER_KEY: 生成一个安全的 16 位主密钥。你可以使用 https://randomkeygen.com/ 之类的工具来生成随机密钥。将此密钥设置为 Meilisearch 空间中 MEILI_MASTER_KEY 环境变量的值。重要提示：请妥善保管此密钥！

• MEILI_ENV: 将 MEILI_ENV 环境变量设置为 production。

3. 复制 Space：

点击“Duplicate Space”按钮。

4. 配置 LibreChat 以使用 Meilisearch：

• 编辑 Dockerfile： 前往您的 LibreChat 空间（即您从主 LibreChat 模板复制的那个）。导航至“Files” -> “Dockerfile”并点击“Edit”。

• 取消注释并修改行： 取消注释/编辑 Dockerfile 中的以下行。这些行将包含 ENV SEARCH 和 ENV MEILI_*。请确保将 <YOUR_MEILISEARCH_SPACE_URL> 替换为您在 Hugging Face Spaces 上部署的 Meilisearch 的实际 URL。它看起来应该类似于 https://<your-username>-meilisearch.hf.space/。请更新用户名以匹配您的用户名！

  ENV SEARCH=true
  ENV MEILI_NO_ANALYTICS=true
  ENV MEILI_HOST=<YOUR_MEILISEARCH_SPACE_URL>

• 提交更改： 将您的更改提交到 main 分支。

5. 将 MEILI_MASTER_KEY 密钥添加到 LibreChat：

• 前往您的 LibreChat 空间设置（指 LibreChat 部署，而非 Meilisearch 部署）。

• 点击“New secret”。

• 名称： 输入 MEILI_MASTER_KEY。

• 值： 输入您在设置 Meilisearch 空间时使用的相同主密钥。

6. 验证设置：

在 LibreChat 重建并开始运行后，你应该能在 LibreChat 界面的左上角看到一个搜索选项。如果你没有看到它，请仔细检查是否已正确执行了所有步骤。