Skip to main content

Installation

This guide provides the fastest and easiest way to install WrenAI on your local computer. We support Linux, Windows, and Mac OSX computers.

Prerequisites​

1. Install Docker Desktop on your local computer.​

Please ensure the version of Docker Desktop at least >= 4.17.

2. Prepare an OpenAI API key​

Please ensure that your Open API key has Full Permission(All).

info

The OpenAI key is used for generating SQL whenever a question is asked in WrenAI.
We will not store your OpenAI key for other purposes.

Using WrenAI Launcher​

WrenAI Launcher is a program that we designed to make installation as easy as possible.

Download and run WrenAI Launcher​

Execute following commands in the terminal.

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

You can see other versions from our release page on Github: https://github.com/Canner/WrenAI/releases

Set privacy & security setting​

  1. You will notice that the launcher will fail to run because this program is not verified by Apple yet. mac1

  2. Go to System Settings from the Apple menu, then click Privacy & Security in the sidebar. You will see "wren-launcher-darwin" was blocked... message. Click Allow Anyway. mac2

Run the program​

  1. Click Open mac3

  2. Enter your OpenAI API key mac4

  3. Wait for the installation to finish

    At this point, the installation is automatically running. This program will setup docker containers for you and open the application URL in the browser for you after installation. mac5

  4. Enjoy it!

    If the launcher program doesn't open the URL for you, go to localhost:3000 to start using WrenAI. mac6

Change OpenAI API Key​

If you wish to change the OpenAI API Key you've previously used in WrenAI, please follow these steps to update the key.

  1. Run the WrenAI Launcher again and enter the OpenAI API key you'd like to use linux1
  2. Restart WrenAI service
    To restart WrenAI service using Docker Desktop, simply click on the restart option listed in the wrenai project. restart

Update WrenAI Version​

If you'd like to upgrade your WrenAI version, please follow these steps:

  1. Download the WrenAI Launcher of the latest version and run it
    You can simply use the command line provided in Using WrenAI Launcher.
  2. Restart WrenAI service
    To restart WrenAI service using Docker Desktop, simply click on the restart option listed in the wrenai project. restart

Troubleshooting​

  1. Wren-engine failed to start due to qemu: uncaught target signal 11 (Segmentation fault) issue

    If you're using Apple Silicon Mac, you saw WrenAI failed to launch and wren-engine container failed to start due to following errors:


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

    please upgrade your docker desktop to the latest version or enable Use Rosetta for x86/amd64 emulation on Apple Silicon option in docker desktop settings. troubleshoot