跳到主要内容

安装

本指南提供了在本地计算机上安装 Wren AI 的最快、最简便的方法。我们支持 Linux、Windows 和 Mac OSX 计算机。

先决条件​

1. 在您的本地计算机上安装 Docker Desktop。​

请确保 Docker Desktop 的版本至少 >= 4.17。如果您使用的是 Apple Silicon Mac，请确保在 Docker Desktop 设置中启用 Rosetta 2，以防止出现性能缓慢的问题。

2. 准备一个 OpenAI API 密钥​

请确保您的 Open API 密钥具有完整权限（所有）。 api_key

信息

Wren AI 中提出的任何问题都需要使用 OpenAI 密钥来生成 SQL。
我们不会将您的 OpenAI 密钥存储用于其他目的。

使用 Wren AI 启动器​

Wren AI 启动器 是我们设计的一个旨在让安装尽可能简单的程序。

下载并运行 Wren AI 启动器​

在终端中执行以下命令。

如果您使用的是 Apple Silicon Mac，请运行以下命令

curl -L https://github.com/Canner/WrenAI/releases/latest/download/wren-launcher-darwin-arm64.tar.gz | tar -xz && ./wren-launcher-darwin-arm64

如果您使用的是 Intel Mac，请运行以下命令

curl -L https://github.com/Canner/WrenAI/releases/latest/download/wren-launcher-darwin.tar.gz | tar -xz && ./wren-launcher-darwin
信息

您可以在 Github 的发布页面查看其他版本： https://github.com/Canner/WrenAI/releases

设置隐私和安全设置​

  1. 您会注意到启动器无法运行，因为此程序尚未获得 Apple 的验证。 mac1

  2. 从 Apple 菜单中前往 系统设置，然后在侧边栏中点击 隐私与安全性。您会看到 "wren-launcher-darwin" was blocked... 消息。点击 仍然允许。 mac2

运行程序​

  1. 点击 打开

    mac3

  2. 选择您想使用的 LLM 提供商。如果是 OpenAI，请转到下一步；否则，请在此处阅读文档以进行自定义 LLM 提供商设置。

    mac4

  3. 如果您选择 OpenAI 作为 LLM 提供商，请输入您的 OpenAI API 密钥，然后选择您想在 Wren AI 中使用的 OpenAI 生成模型。

  4. 等待安装完成

    此时，安装会自动运行。此程序将为您设置 Docker 容器并在安装后在浏览器中为您打开应用程序 URL。

    mac5

  5. 尽情享用吧！

    如果启动器程序没有为您打开 URL，请前往 localhost:3000 开始使用 Wren AI。

    connect

使用 Shell​

您也可以通过 shell 命令启动 Wren AI。通过向启动器传递参数，您可以跳过一些配置设置，从而顺利启动 Wren AI。

步骤 1。打开您的 shell 并运行以下命令检查可传递给启动器的参数

如果您使用的是 Apple Silicon Mac，请运行以下命令

./wren-launcher-darwin-arm64 -h

如果您使用的是 Intel Mac，请运行以下命令

./wren-launcher-darwin -h

usingShell_mac1 步骤 2。运行启动器并传递所需参数。例如，如果您想跳过所有 OpenAI 设置，可以运行以下命令

如果您使用的是 Apple Silicon Mac，请运行以下命令

./wren-launcher-darwin-arm64 -llm-provider openai -openai-api-key YOUR_OPENAI_API_KEY -openai-generation-model GENERATION_MODEL_NAME

如果您使用的是 Intel Mac，请运行以下命令

./wren-launcher-darwin -llm-provider openai -openai-api-key YOUR_OPENAI_API_KEY -openai-generation-model GENERATION_MODEL_NAME

您将看到日志指示 OpenAI API 密钥和生成模型已提供，然后 Wren AI 将自动启动。

usingShell_mac2

更改 OpenAI API 密钥​

如果您希望更改之前在 Wren AI 中使用的 OpenAI API 密钥，请按照以下步骤更新密钥。

  1. 再次运行 Wren AI 启动器并输入您想使用的 OpenAI API 密钥

    linux1

  2. 重启 Wren AI 服务
    要使用 Docker Desktop 重启 Wren AI 服务，只需点击 wrenai 项目中列出的 restart 选项即可。

    restart

更新 Wren AI 版本​

如果您想升级 Wren AI 版本，请按照以下步骤操作

  1. 下载最新版本的 Wren AI 启动器并运行它
    您只需使用 使用 Wren AI 启动器 中提供的命令行即可。

  2. 重启 Wren AI 服务
    要使用 Docker Desktop 重启 Wren AI 服务，只需点击 wrenai 项目中列出的 restart 选项即可。

    restart

故障排除​

  1. Wren-engine 启动失败，原因是 qemu: uncaught target signal 11 (Segmentation fault) 问题

    如果您使用的是 Apple Silicon Mac， 您看到 Wren AI 启动失败，并且 wren-engine 容器启动失败，原因是以下错误


    qemu: uncaught target signal 11 (Segmentation fault) - core dumped
    Seamentation fault
    ...

    请将您的 docker desktop 升级到最新版本，或在 docker desktop 设置中启用 Use Rosetta for x86/amd64 emulation on Apple Silicon 选项。 troubleshoot