Skip to content

molgenis/molgenis-service-armadillo

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Armadillo suite

CircleCI Build Status SonarCloud Coverage Quality Gate Status

Overview

Use MOLGENIS Armadillo to make data available for privacy protecting federated analysis using DataSHIELD protocol. Armadillo service provides the following features:

  • manage data projects. Projects can either hold tabular data in the efficient 'parquet' format or any other file use DataSHIELD 'resources' framework.
  • grant users access permission. We use a central OIDC service like KeyCloak or FusionAuth in combination with a trused identity provider like Life Sciences AAI to authenticate users.
  • configure DataSHIELD analysis profiles. DataSHIELD analysis profiles are Docker images that contain a collection of multiple DataSHIELD analysis packages.

DataSHIELD overview

Getting started

For installing and using Armadillo see our Documentation.

For developing and contributing see our dev guides.

Quick start

Jar

  1. Download the jar from our releases page.
  2. Copy paste the contents of application-template.yml and paste it in a file called application.yml, in the same folder as the downloaded jar.
  3. To start the application, run java -jar molgenis-armadillo-x.yy.zz.jar.
  4. Go to http://localhost:8080 to see the Armadillo UI.

Docker

For testing without having to installing Java you can run using docker:

  1. Install docker-compose
  2. Download this docker-compose.yml.
  3. Execute docker-compose up
  4. Once it says 'Started', go to http://localhost:8080 to see your Armadillo running.