Links

Run Aidbox locally

Get up-to-speed with Aidbox features via interactive tutorials.

Intro

This guide helps you to launch and explore the Aidbox key features locally through built-in interactive tutorials called Notebooks.
It introduces you to:
  • The aidbox installation process with Docker & Docker Compose,
  • Basic API capabilities like RESTful FHIR and SQL API,
  • Aidbox UI features that make the Aidbox instance transparent for you.
Please make sure that both Docker & Docker Compose are installed.

Quickstart Guide

1. Get the Aidbox License for self-hosting

Create the Aidbox License for the 14-day trial period on https://aidbox.app/, select self-hosted, or use the license that you already have.
The Aidbox License Key will be required in the next step, where we will prepare the configuration for Aidbox.

2. Configure the Aidbox

Aidbox is configured by dedicated Aidbox Configuration Projects.
You can start with the default configuration project published on our GitHub and customize it for your specific needs later. Select the FHIR version and clone the corresponding project with the Bash commands below:
FHIR R4
FHIR R4B
FHIR R5
git clone \
--branch=main \
--depth=1 \
https://github.com/Aidbox/aidbox-project-template.git \
aidbox-project && \
cd aidbox-project && \
rm -rf .git
git clone \
--branch=fhir-r4b \
--depth=1 \
https://github.com/Aidbox/aidbox-project-template.git \
aidbox-project && \
cd aidbox-project && \
rm -rf .git
git clone \
--branch=fhir-r5 \
--depth=1 \
https://github.com/Aidbox/aidbox-project-template.git \
aidbox-project && \
cd aidbox-project && \
rm -rf .git
Here is the basic structure of the Aidbox Configuration Project:
aidbox-project/
├── .env
├── docker-compose.yaml
├── zen-package.edn
└── zrc/
├── config.edn
└── main.edn
Aidbox Configuration Projects
Everything in Aidbox can be configured with a dedicated Aidbox Configuration Project from the FHIR version definition to enabling add-on modules.
This approach helps you keep configurations under a version control system and share them between Aidbox Instances.

Add the license key to your configuration project.

Update the .env file within your configuration project with the Aidbox License Key from Step 1:
.env
AIDBOX_LICENSE=YOUR_AIDBOX_LICENSE_KEY
PGPORT=5437
PGUSER=postgres
...

3. Start Aidbox with Docker Compose

Start Aidbox with Docker Compose:
docker compose up --force-recreate
Navigate to http://localhost:8888/ and Sign In to the Aidbox UI using the login admin and password password.

4. Discover Aidbox features with Notebooks

Go to the Notebooks section within the Aidbox UI and open Getting Started Notebooks.
Use the pre-defined Getting Started Notebooks to explore the basic features of Aidbox through interactive steps with API queries:
Aidbox Notebooks
Notebooks are interactive tutorials within the Aidbox UI with built-in REST, RPC, and SQL editors and the ability to execute requests and queries on the fly and see the result. You can use pre-built or create your own Notebooks. Learn more.

Next Steps

Last modified 20d ago