XNAT Container Service
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs CS-529 Add "format" property to wrapper output handler Oct 5, 2018
src Add another rest endpoint for /commands/available that takes project … Oct 24, 2018
CODE_OF_CONDUCT.md Add code of conduct from contributor-covenant.org Jun 23, 2017
CONTRIBUTING.md References to the dummy TransportService removed, as it was a placeho… Oct 18, 2018
build.gradle Bump version to 1.6.0 Oct 29, 2018


XNAT Container Service Circle CI

XNAT plugin for controlling containers (primarily Docker containers).

To use it, you will need an XNAT running 1.7.3+. Get the containers-<version>-fat jar (through one of the methods below) and put it into your {xnat.home}/plugins directory. Restart tomcat and you are ready to run containers. See the guide to getting started.

This document is cross-posted on the XNAT wiki and the README in the source repository.

Getting the jar


Releases are posted to the repository's Releases tab on GitHub. Download the version you want (probably the latest release) and deploy it to XNAT.

Build the jar

If you clone the source repository, you can build an XNAT plugin jar by running

[container-service] $ ./gradlew fatJar

The jar will be created as build/libs/containers-${VERSION}-fat.jar

Deploy to XNAT

One you have a jar, copy it to the ${xnat.home}/plugins directory, and restart tomcat.

Where is ${xnat.home}? If you are using a VM generated by the XNAT Vagrant project, xnat.home is in the ~/${PROJECT} directory (and the default value for ${PROJECT} is xnat). If you aren't using the Vagrant project, or even if you are and you're still confused, then ${xnat.home}/logs is where XNAT writes its logs; you'll want the plugins directory which should be right next to the logs directory.