Skip to content

Latest commit

 

History

History
122 lines (82 loc) · 5.74 KB

README.md

File metadata and controls

122 lines (82 loc) · 5.74 KB
Raw

Build Status Minimum PHP Version Documentation Status

LORIS Neuroimaging Platform

LORIS (Longitudinal Online Research and Imaging System) is a self-hosted web application that provides data- and project-management for neuroimaging research. LORIS makes it easy to manage large datasets including behavioural, clinical, neuroimaging and genetic data acquired over time or at different sites.

This Readme covers installation of LORIS version 23 on Ubuntu. (CentOS Readme also available).

Please consult the LORIS Wiki Setup Guide notes on this Install process for more information.

Heroku

You can try LORIS on Heroku before installing it on your system. The project management and clinical data management functions of LORIS are available for experimenting with. Imaging functionality is not yet available.

Deploy and log in with username admin and the password that's set up during deployment via ClearDB.

Deploy

Installation

System Requirements

  • Apache 2.4 or higher
  • MySQL >= 5.7 (or MariaDB >= 10.3)
  • PHP 7.3 or higher
  • Composer 1.4 or higher
  • NodeJS 8.0 or higher
  • NPM
  • make

These dependencies are subject to change so be sure to verify your version of MySQL and PHP when updating LORIS. Installing some dependencies may require sudo privileges.

Install Steps

Consult the LORIS Wiki page on this Install process for more information.

  1. Set up LINUX user and group lorisadmin and create LORIS base directory:
# Create lorisadmin user and group
# Give lorisadmin `sudo` permission. This is required for the install process
# in order to automatically generate Apache configuration files.
# Sudo privileges can be revoked once the install is completed.
sudo useradd -U -m -G sudo -s /bin/bash lorisadmin
# Add apache to the lorisadmin group
sudo usermod -a -G lorisadmin www-data
# Set the password for the lorisadmin account
sudo passwd lorisadmin
sudo mkdir -m 755 -p /var/www/$projectname
sudo chown lorisadmin.lorisadmin /var/www/$projectname
su - lorisadmin

$projectname ⇾ "loris" or one-word project name

  1. Get the code: Download the latest release from the releases page and extract it to /var/www/$projectname

  2. Run installer script to install core code, and libraries. The script will prompt for information and so that it can create directories automatically.

For more information, please read the Installing Loris wiki page.

cd /var/www/$projectname/tools
./install.sh
  1. Run the makefile (use make dev if you are setting up a development sandbox)
cd /var/www/$projectname
make
  1. Apache configuration

If your apache configuration was not completed by the Install script, run the following enable rewriting of LORIS, enable your $projectname site, and restart apache: (run by user who has root privileges)

sudo a2enmod rewrite
sudo a2dissite default
sudo a2ensite $projectname
sudo service apache2 reload
  1. Go to http://localhost/installdb.php and follow the instructions to finalize LORIS installation, then restart apache.

If you use MySQL 8, please read this link and also this.

  1. Follow the Setup Guide in the LORIS Wiki to complete your post-installation setup and configuration, and for more documentation.

Community

Get in touch

For questions and troubleshooting guidance beyond what is covered in our GitHub Wiki, please subscribe to the LORIS Developers mailing list and email us there.

GitHub Issues

For bug reporting and new feature requests, please search and report via our GitHub Issues. Please include details such as the version of LORIS you're using as well as information such as the OS you're using, your PHP and Apache versions, etc.

Contributing

The LORIS team at the Montreal Neurological Institute (MNI) is very happy to get code contributions and features from the global LORIS community.

Contributing Code

If you would like to contribute to LORIS development, please consult our Contributing Guide.

Powered by MCIN

LORIS is made by staff developers at the McGill Centre for Integrative Neuroscience (MCIN.ca), led by Alan Evans and Samir Das at the Montreal Neurological Institute.

See LORIS.ca for our current team, the history of LORIS, and our Technical Papers.

The original (pre-GitHub) LORIS development team from 1999-2010 included: Dario Vins, Alex Zijdenbos, Jonathan Harlap, Matt Charlet, Andrew Corderey, Sebastian Muehlboeck, and Samir Das.