Skip to content

Home

Jump to bottom
Christophe Philemotte edited this page Aug 27, 2024 · 21 revisions

Welcome to the OpenHEXA wiki!

What is OpenHEXA?

OpenHEXA is an open-source data integration platform developed by Bluesquare.

Its goal is to facilitate data integration and analysis workflows, in particular in the context of public health projects.

OpenHEXA allows you to:

  1. Create workspaces to group code, data and users
  2. Upload and read files from a shared filesystem
  3. Write and read to a PostgreSQL database
  4. Use Jupyter notebooks to explore and analyze data
  5. Run and schedule complex data workflows using data pipelines
  6. Manage your team members
Workspace homepage

Quick Start

If you want to try quickly OpenHexa and work with a Debian-based Linux distribution, follow the next instructions. If you need a more permanent installation, or you'd like to contribute to the project, please see the installation instructions.

Before starting, make sur that the following requirements are met:

  • a least Docker 26.1
  • Debian bookworm
  • Debian packages git, gettext-base postgresql postgresql-14-postgis-3
  • yq

Retrieve OpenHexa:

git clone https://github.com/BLSQ/openhexa.git
cd openhexa

You can check your installation by running first

./script/setup.sh check

It'll tell you that the .env is missing, that is expected as it's the next step.

Then, you need to setup the environment and the database. To do so execute the following command

./script/setup.sh all

This will generate a file in the working directory: .env (ee below to know more about the configuration properties).

Then you can prepare the database and environment with

./script/openhexa.sh prepare

Finally, you can run openhexa with

./script/openhexa.sh start

You can then access OpenHexa at http://localhost:3000/. The default login is root@openhexa.org with the password root.

To stop, execute

./script/openhexa.sh stop

If you need to purge the configuration and the database after having stopped it, you can do it by executing the following command

./script/openhexa.sh purge

Using OpenHEXA

You can find more information on how to use OpenHEXA in the user manual.

We also have specific guides for users who write and run code on OpenHEXA:

Installing and deploying OpenHEXA

You can find more information on how to install OpenHEXA in the installation instructions. The installation document is not 100% complete yet - don't hesitate to reach out using the discussions section if you need assistance.

Administering OpenHEXA

You can find more information on how to administer OpenHEXA in the administration guide.

Comments, questions, feedback?

Feel free to reach out in the discussions section.

Clone this wiki locally