Skip to main content

Installation

Quite simple really! After ensuring that the pre-requisites are met, follow these steps:

  1. Download the current latest release from our releases page. This page is password protected, and if you haven't received a password, contact support@aival.io and we'll be happy to help!
  2. Create a folder where you'd like to have all of the aival files located (optional).
    As for this tutorial, I'll place all my files at /home/justin/aival-lab. To create the folder, I'll run: mkdir -p /home/justin/aival-lab in a terminal.
  3. Next, extract your downloaded file (mine's aival-lab-v1.4.7.tar.gz) to your path. You should see a single binary file simply called aival.
  4. Run the aival binary. This will generate the data folder, and more folders as you progress through the setup and use more of the features! You should see this in your terminal: 
[2023-07-12 00:00:00 +0000] [1000] [INFO] Starting gunicorn 20.1.0
[2023-07-12 00:00:00 +0000] [1000] [INFO] Listening at: http://0.0.0.0:5050 (1000)
[2023-07-12 00:00:00 +0000] [1000] [INFO] Using worker: gunicorn.workers.sync.SyncWorker
[2023-07-12 00:00:00 +0000] [1000] [INFO] Booting worker with pid: 1001

Voilà! Your server is now running!

  1. Now, open your browser (Chrome, Firefox, etc.) and navigate to the website where the server is running. If you're opening the browser on the same machine as the server, the web address will be http://0.0.0.0:5050 (the terminal should also display this).
  2. Great! Now head over to the setup guides for more information of how to prepare your data and setup your project in the app!
info

If you are running this on WSL2, then the web address will be http://127.0.0.1:5050 instead.

Changing your server port​

If you'd like to host the server on a different port, you can use the SERVER_PORT environment variable to set it to a port you'd like. For example:

➜  aival-lab: SERVER_PORT=7777 ./aival
[2023-07-12 00:00:00 +0000] [1000] [INFO] Starting gunicorn 20.1.0
[2023-07-12 00:00:00 +0000] [1000] [INFO] Listening at: http://0.0.0.0:7777 (1000)
[2023-07-12 00:00:00 +0000] [1000] [INFO] Using worker: gunicorn.workers.sync.SyncWorker
[2023-07-12 00:00:00 +0000] [1000] [INFO] Booting worker with pid: 1001

Updating to a newer version​

If a newer version has been released and you would like to update to this newer version, it is as simple as:

  • Stop the server if it is running, and close any open tabs of the app
  • Download the newer version
  • Extract out the new executable
  • Replace the old ./aival executable with this new one
  • Run the server with ./aival and open a tab to the web address again