/miso-lims

MISO: An open-source LIMS for NGS sequencing centres

Primary LanguageJavaGNU General Public License v3.0GPL-3.0

Build Status Quality Gate

MISO: An open source LIMS for small-to-large scale sequencing centres

© 2017. Earlham Institute, Norwich, UK, Ontario Institute for Cancer Research, Toronto, Canada

MISO project contacts: Robert Davey, Morgan Taschuk

MISO is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

MISO is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with MISO. If not, see http://www.gnu.org/licenses/.

View Full MISO Documentation

Trying MISO

Docker

The simplest way to get MISO up and running quickly is to use Docker. Images of the most recent MISO releases are available on Docker Hub in misolims/miso-lims. The Docker container is intended as a demonstration and not a permanent installation. Please note that shutting down the Docker container deletes all MISO data, and restarting the Docker container starts up with a fresh MISO. If you wish to store your data longer-term when testing out MISO, please follow the instructions for Running an Instance of MISO below.

To use it:

  1. Install Docker 1.9.1+
  2. docker pull misolims/miso-lims
  3. docker run -p 8090:8080 -d -t misolims/miso-lims

Navigate to http://localhost:8090 to login to miso with the credentials admin/admin.

Virtual Box

An older version of MISO is available in our our virtual machine image with everything preinstalled. A VirtualBox instance is available with a self-contained MISO installation and MySQL database server, fully configured and can be used out-of-the-box.

To use it:

  1. Download VirtualBox software from: https://www.virtualbox.org/
  2. Download the MISO OVA: https://repos.tgac.ac.uk/miso/latest/MISO_Image.ova
  3. Import this OVA file into VirtualBox via FileImport Appliance. You may have to select Bridged Adaptor instead of NAT in the network settings.
  4. Start the instance. Starting the appliance will result in an Ubuntu virtual machine complete with all MISO’s prerequisites pre-installed. The login for the virtual image is miso / misoadmin.
  5. Start MISO server by using ./misoStart.sh and then open the browser and go http://localhost:8080/
  6. Log in to MISO using admin / admin. Only some simple configuration for certain elements is required, such as Sequencer References, Printers and any additional users and groups.

Running an Instance of MISO

To run your own MISO instance in the long term, you will need to maintain your own fork of the MISO codebase with your configuration changes. For each release, you will need to merge the main changes into your local repository and then deploy a new version.

For deployment, you will need a mySQL database server, a server to scan the sequencer output directories (the notification server), and a Tomcat application server. These can be on the same machine. It is advisable to have a separate build environment.

At each upgrade, there are two steps: migrating the database and deploying a new application. Each version of the application contains all the migrations needed to upgrade any old database to match the current version. However, there is no rollback procedure, so a full database backup should be taken before migration.

Installation and configuration details can be found in the MISO maintainer guide.

Contact and Community