Home

Overview:

The xnat-setup scripts installs all the necessary software and file structures required for an XNAT server. It can install it on either directly on a computer/server or within Docker containers. 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.

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

Requirements:

OS: Linux - recommend Ubuntu 24.04. Mac is possible using Docker.
Docker: Docker Installation Instructions
Static IP address.

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'.

Important notes - Firewall Configuration:

The script installs the firewall configuration tool UFW, however it is disabled by default. If running XNAT within a Docker container, follow the guide to install UFW on the host server and configure the firewall. If installing XNAT directly on the server, configure the firewall following the guide.

More on firewalls, firewall configuration and mapping ports on Docker can be found here

Some important developer notes...