Aidbox
Search…
Reference
Run Aidbox locally with Docker
This quickstart guide explains how to run Aidbox locally using docker compose. You will learn how to obtain a free short-time license and set up Aidbox.

Get a license

Go to the Aidbox portal. Sign up and click the new license button. Choose product type "Aidbox" and hosting type "on premises".
You'll see your license in the "My Licenses" list. Click on your new license and copy credentials. It is a long string like
eyJhbGciOiJ...
This string is your license key.

Install Docker and Docker Compose

Follow the official Docker guide to install Docker and Docker Compose

Create docker-compose.yaml

Firstly, let's make the configuration file. There are two services: aidbox-db and aidbox. The first one is PostgreSQL database and the second one is the Aidbox itself.
docker-compose.yaml
version: '3.7'
services:
aidbox-db:
image: "${PGIMAGE}"
ports:
- "${PGHOSTPORT}:${PGPORT}"
volumes:
- "./pgdata:/data"
environment:
POSTGRES_USER: "${PGUSER}"
POSTGRES_PASSWORD: "${PGPASSWORD}"
POSTGRES_DB: "${PGDATABASE}"
​
aidbox:
image: "${AIDBOX_IMAGE}"
depends_on: ["aidbox-db"]
links:
- "aidbox-db:database"
ports:
- "${AIDBOX_PORT}:${AIDBOX_PORT}"
env_file:
- .env
environment:
PGHOST: database

Create .env file

To configure Aidbox we need to pass environment variables to it. We can pass them with .env file.
.env
# postgres image to run
PGIMAGE=healthsamurai/aidboxdb:14.2
​
# aidbox image to run
# AIDBOX_IMAGE=healthsamurai/aidboxone:stable
AIDBOX_IMAGE=healthsamurai/aidboxone:edge
​
# license details
AIDBOX_LICENSE=<your-license-key>
​
# if you got pair of id and key use this instead
# AIDBOX_LICENSE_ID=<your-license-id>
# AIDBOX_LICENSE_KEY=<your-license-key>
​
# Client to create on start up
AIDBOX_CLIENT_ID=root
AIDBOX_CLIENT_SECRET=secret
​
# root user to create on start up
AIDBOX_ADMIN_ID=admin
AIDBOX_ADMIN_PASSWORD=secret
​
# port to run webserver at
AIDBOX_PORT=8888
AIDBOX_FHIR_VERSION=4.0.1
​
# db connection params
PGPORT=5432
PGHOSTPORT=5437
PGUSER=postgres
PGPASSWORD=postgres
PGDATABASE=aidbox
Insert your license key into environment file. Change the line
AIDBOX_LICENSE=<your-license-key>
in the .env file where <your-license-key> is a license key which you obtained on the get a license step.
You can find more about required Aidbox environment variables here.​

Launch Aidbox

Start Aidbox with Docker Compose
docker compose up
This command will download and start Aidbox and its dependencies. This can take a few minutes.

Go to the Aidbox UI

Open http://localhost:8888. You'll see Aidbox login page. Sign in using login admin and password secret.
Now you are ready to use Aidbox.