Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Info

Download the latest release of the XNAT pipeline engine: Image RemovedGet the latest Pipeline Engine code: $ git clone https://www.github.com/nrgXnat/xnat-pipeline-engine.git


The XNAT pipeline engine is distributed as a zip archive code repository that contains the pipeline engine installer. To install the pipeline engine:

  1. Download the XNAT 1.7 pipeline engine installer:

    Code Block
    languagebash
    titleDownloading the XNAT 1.7 pipeline engine installer
    $ curl -L -o xnat-pipeline-1.7.4.zip https://api.github.com/repos/NrgXnat/xnat-pipeline-engine/zipball/1.7.4

    Create a folder to contain the pipeline installer, change to that directory, then unzip clone the archive :

    Code Block
    languagebash
    titleExtracting XNAT pipeline installer
    $~$ mkdir pipeline
    ~$ cd pipeline/
    ~/pipeline$ unzip ../git clone https://www.github.com/nrgXnat/xnat-pipeline-1.7.4.zip 
    engine.git 


  2. Create a destination folder for the pipeline engine. The standard XNAT practice is to use /data/project/pipeline. As with other XNAT folders, the pipeline folder must be accessible by the Tomcat user.

    Code Block
    languagebash
    titleCreating XNAT pipeline installation folder
    ~$ mkdir /data/xnat/pipeline


  3. Run setup.sh with the administrator email address, SMTP server address, XNAT URL, site name, and destination folder:

    Alternatively, you can save these options in a file named gradle.properties in the pipeline installer folder:

    Code Block
    languagebash
    titleXNAT pipeline installer gradle.properties
    xnatUrl=http://oldschool.edu
    siteName=XNAT
    adminEmail=admin@oldschool.edu
    smtpServer=mail.oldschool.edu
    destination=/data/xnat/pipeline

    Now run gradlew from that folder:

    Code Block
    languagebash
    titleInstalling XNAT pipeline with gradlew
    ~$ ./gradlew

    The advantage of the latter approach is that you can reinstall updates to the pipeline engine with one simple command rather than having to re-enter the full setup.sh syntax again.