Skip to main content

Installation

After ensuring that the pre-requisites are met, follow these steps:

  1. Unzip the provided application to a folder. For this tutorial, I'll place all my files at /home/user/aival-label. To create the folder, I'll run:
mkdir -p /home/user/aival-label
tar -xzf aival-label-vX.X.X.tar.gz -C /home/user/aival-label
  1. You should be able to spot that the app binary is now extracted to a folder. Next, run the aival-label-vX.X.X binary. Once the application has been launched, you should see this in your terminal:
[SERVER] Starting main server on port 8000 with pid 552399
[SERVER] You can access the app at http://127.0.0.1:8000

[SERVER] Starting DICOM-Web server with 8 workers on port 8001 with pid 552419
INFO:     Started server process [552399]
INFO:     Waiting for application startup.
INFO:     Application startup complete.
INFO:     Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)

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://127.0.0.1:8000 (the terminal should also display this).
  2. Great! Now head over to the setup guides for more information of how to login if you're a labeller or an administrator.

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-label: SERVER_PORT=7777 ./aival-label-vX.X.X
[SERVER] Starting main server on port 7777 with pid 20671
[SERVER] You can access the app at http://127.0.0.1:7777

[SERVER] Starting DICOM-Web server with 6 workers on port 7778 with pid 20679
INFO:     Started server process [20671]
INFO:     Waiting for application startup.
INFO:     Application startup complete.
INFO:     Uvicorn running on http://127.0.0.1:7777 (Press CTRL+C to quit)

You can also modify the DICOM_PORT via environment variables, but it will usually automatically choose the next available port from the server port.

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
  • Download the newer version
  • Replace the old ./aival-label-vX.X.X executable with this new one
  • Run the server and you're ready!