安装
本指南提供了在本地计算机上安装Wren AI的最快和最简单的方法。我们支持Linux、Windows和Mac OSX计算机。
先决条件
1. 在您的本地计算机上安装 Docker Desktop。
请确保Docker Desktop的版本至少>= 4.17。
2. 准备一个OpenAI API key
请确保您的Open API密钥具有Full Permission(All)权限。
OpenAI 密钥用于在 Wren AI 中提问时生成 SQL。
我们不会将您的 OpenAI 密钥用于其他目的。
使用Wren AI启动器
Wren AI Launcher 是我们设计的一个程序,旨在使安装尽可能简单。
- Mac OSX
- Linux
- Windows
下载并运行 Wren AI 启动器
在终端中执行以下命令。
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
设置隐私和安全设置
-
您会注意到启动器将无法运行,因为此程序尚未通过苹果公司的验证。
-
从苹果菜单中选择系统设置,然后在侧边栏中点击隐私与安全。 你会看到
"wren-launcher-darwin" was blocked...
消息。点击仍然允许。
运行程序
-
点击打开
-
选择您想要选择的LLM提供商。如果是OpenAI,请继续下一步;否则,请阅读此处关于自定义LLM提供商设置的文档。
-
如果您选择OpenAI作为LLM提供商,请输入您的OpenAI API密钥,然后选择您想在Wren AI中使用的OpenAI生成模型。我们现在支持以下模型:
- GPT-4o-mini
- GPT-4o
-
等待安装完成
此时,安装程序正在自动运行。该程序将为您设置docker容器,并在安装完成后在浏览器中打开应用程序URL。
-
享受吧!
如果启动程序没有为你打开URL,请访问localhost:3000开始使用Wren AI。
下载并运行 Wren AI 启动器
在终端中执行以下命令。
curl -L https://github.com/Canner/WrenAI/releases/latest/download/wren-launcher-linux.tar.gz | tar -xz && ./wren-launcher-linux
您可以从我们在Github上的发布页面查看其他版本:https://github.com/Canner/WrenAI/releases
运行程序
-
选择您想要选择的LLM提供商。如果是OpenAI,请继续下一步;否则,请阅读此处关于自定义LLM提供商设置的文档。
-
输入您的OpenAI API密钥,然后选择您想在Wren AI中使用的OpenAI生成模型。我们现在支持以下模型:
- GPT-4o-mini
- GPT-4o
-
等待安装完成
此时,安装程序正在自动运行。该程序将为您设置docker容器,并在安装完成后在浏览器中打开应用程序URL。
-
享受吧!
如果启动程序没有为你打开URL,请访问localhost:3000开始使用Wren AI。
下载Wren AI启动器
下载程序:wren-launcher-windows.zip。
解压文件后,你会看到一个名为wren-launcher-windows.exe
的可执行文件。
运行 Wren AI 启动器
-
右键点击
wren-launcher-windows.exe
并选择以管理员身份运行。 -
您将看到一个
Microsoft Defender SmartScreen
弹出窗口,选择更多信息并点击仍然运行 -
选择您想要选择的LLM提供商。如果是OpenAI,请继续下一步;否则,请阅读此处关于自定义LLM提供商设置的文档。
-
输入您的OpenAI API密钥,然后选择您想在Wren AI中使用的OpenAI生成模型。我们现在支持以下模型:
- GPT-4o-mini
- GPT-4o
-
等待安装完成
此时,安装程序正在自动运行。该程序将为您设置docker容器,并在安装完成后在浏览器中打开应用程序URL。
-
享受吧!
如果启动程序没有为你打开URL,请访问localhost:3000开始使用Wren AI。
使用Shell
你也可以通过shell命令启动Wren AI。通过向启动器传递参数,你可以跳过一些配置设置并顺利启动Wren AI。
- Mac OSX
- Linux
第一步。 打开你的shell,通过运行以下命令检查你可以传递给启动器的参数:
./wren-launcher-darwin -h
第二步。 运行启动器并传递所需的参数。例如,如果你想跳过所有的OpenAI设置,你可以运行以下命令:
./wren-launcher-darwin -llm-provider openai -openai-api-key YOUR_OPENAI_API_KEY -openai-generation-model gpt-4o-mini
您将看到日志,表明已提供OpenAI API密钥和生成模型,然后Wren AI将自动启动。
第一步。 打开你的 shell 并通过运行以下命令检查你可以传递给启动器的参数:
./wren-launcher-linux -h
第二步。 运行启动器并传递所需的参数。例如,如果你想跳过所有的OpenAI设置,你可以运行以下命令:
./wren-launcher-linux -llm-provider openai -openai-api-key YOUR_OPENAI_API_KEY -openai-generation-model gpt-4o-mini
您将看到日志,表明已提供OpenAI API密钥和生成模型,然后Wren AI将自动启动。
更改OpenAI API密钥
如果您希望更改之前在Wren AI中使用的OpenAI API密钥,请按照以下步骤更新密钥。
-
再次运行Wren AI启动器,并输入您想要使用的OpenAI API密钥
-
重启Wren AI服务
要使用Docker Desktop重启Wren AI服务,只需点击wrenai
项目中列出的restart
选项。
更新Wren AI版本
如果您想升级您的Wren AI版本,请按照以下步骤操作:
-
下载最新版本的Wren AI启动器并运行它
你可以简单地使用使用Wren AI启动器中提供的命令行。 -
重启Wren AI服务
要使用Docker Desktop重启Wren AI服务,只需点击wrenai
项目中列出的restart
选项。
故障排除
-
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
选项。