Skip to content

gift-surg/GiftCloudServerModule

Repository files navigation

GIFT-Cloud Server

GIFT-Cloud is a secure data storage and collaboration platform for medical imaging research.

GiftCloudServerModule is an XNAT module containing XNAT customisations specific to GIFT-Cloud. It is used in conjunction with GiftCloudServerBuilder to install a GIFT-Cloud Server.

A pre-build jar of GiftCloudServerModule is included in the GiftCloudServerBuilder codebase. Therefore, you do not need to use the GiftCloudServerModule repository unless you wish to provide further customisations to GIFT-Cloud.

Authors: Tom Doel and Dzhoshkun Shakir, Translational Imaging Group, Centre for Medical Image Computing, University College London (UCL). GIFT-Cloud was developed as part of the GIFT-Surg project. If you use this software, please cite this paper.

GIFT-Cloud Server extends the XNAT system developed by Harvard University / Howard Hughes Medical Institute (HHMI) / Washington University.

Disclaimer

  • GIFT-Cloud and XNAT are not certified for clinical use.

Software links

License

Copyright (c) 2014-2016, University College London.

GIFT-Cloud is available as free open-source software under a BSD 3-Clause License.

Parts of GIFT-Cloud derive from XNAT

  • XNAT (Harvard University / Howard Hughes Medical Institute (HHMI) / Washington University) uses the BSD 2-Clause License

System requirements

GIFT-Cloud Server runs a customised version of XNAT. Please see XNAT 1.6 prerequisites.

GIFT-Cloud Server can be installed on Linux, macOS or Windows.

GIFT-Cloud Server requires:

  • PostgreSQL 9.1 or later
  • Oracle Java SDK 1.7
  • Apache Tomcat 7.0

Depending on how you intend to deploy GIFT-Cloud Server, you may also need to configure a firewall, Apache daemon, SSL certificates, system backups etc.

Installation

Please use the repository GiftCloudServerBuilder to install a GIFT-Cloud Server.

GiftCloudServerBuilder include a pre-built jar of the GiftCloudServerModule jar - this is found in GiftCloudServerBuilder/modules/uk.ac.ucl.cmic.tig.gift-surg-datastore-GC-<>.jar. When you run the setup or update scripts to deploy/update the XNAT (GIFT-Cloud) server, the module jar will automatically be detected and deployed.

If you wish to modify GiftCloudServerModule (for example, if you want to modify the XNAT user interface), you should follow the XNAT Module procedures. In summary, you need to do the following:

  • Make the appropriate modifications to GiftCloudServerModule and modify the names and version numbers in the two pom files
  • Delete the pre-built jar provided in GiftCloudServerBuilder/modules/uk.ac.ucl.cmic.tig.gift-surg-datastore-GC-<>.jar
  • Run mvn clean package to build a new jar
  • Copy the new jar from GiftCloudServerModule/datastore/target/uk.ac.ucl.cmic.tig.gift-surg-datastore-GC-<>.jar to GiftCloudServerBuilder/modules (Replace <> with the version number in the pom files)
  • Run the update -Ddeploy=true script

Issues

If you experience installation issues, they will almost certainly be related to your configuration of XNAT, Java, Tomcat or PostgreSQL. The best way to resolve these is through the XNAT support resources:

Funding

GIFT-Cloud is part of GIFT-Surg. [GIFT-Surg][giftsurg was supported through an Innovative Engineering for Health award by the Wellcome Trust [WT101957], the Engineering and Physical Sciences Research Council (EPSRC) [NS/A000027/1] and a National Institute for Health Research Biomedical Research Centre UCLH/UCL High Impact Initiative.

About

GIFT-Cloud's customised server module, used to customise a GIFT-Cloud server

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published