Home

Overview:

UPDATE: 17th July 26: This is for XNAT 1.10+, using JDK21.

The wiki is in the process of being updated but it may take some time. Please report any bugs/mistakes.

The xnat-setup script creates an XNAT Docker stack and all the necessary software, maintenance scripts and file structures required for an XNAT server. A docker container is similar to a Virtual Machine, therefore it does not affect the host computer and agnostic to the operating system of the host computer.

XNAT setup contains many scripts and tools to ensure an easily maintainable XNAT server, with many maintenance scripts included and designed for large-scale XNAT servers. Everything is designed for automatic cleaning, backup, updates of software and monitoring of the server.

An overview of software installed and the file structure can be found here

Full documentation and details about XNAT can be found here: https://www.xnat.org

This originated for the DASHER project but has since taken some guidance from the official xnat docker compose project: https://github.com/NrgXnat/xnat-docker-compose.

Features:

XNAT-setup has developed to automate most of the maintenance required and to simplify all major updates.

Simple to install and deploy. Fill in the config file and build.
Automated maintenance: pg_dump, cleaning logs, monitoring site, log rotation, in-container updates (apt get via cronjob)
Automatic session importer: DICOMs placed in /xnat-data/import_data_folder will be automatically imported.
Easy scripts to backup/restore/update everything.
Easy to configure with ldap/proxy/subnet.

Requirements:

OS: Linux. Mac is possible with adjustments but not regularly tested. It might be possible to run via WSL on windows, but untested.
Docker Engine: [Docker Installation Instructions

Definitions:

XNAT: an extensible open-source imaging informatics software platform dedicated to imaging-based research. XNAT is a Tomcat web application with a Postgresql database backend. Users interact with XNAT via a web user interface.

Docker: Docker is a technology that enables software and servers to be packaged into lightweight virtual machines - the software, operating system and dependencies are packaged into 'images' and these images can be run in 'containers'.

Some important developer notes...