Admin UI - File System Settings

In order for XNAT to work properly, it needs to know where to look for the files it needs. This is where you can configure the paths where XNAT should look, as well as configure some other file system related options. These options are configured on your initial setup. Each of these file system paths and their utility is discussed  in further detail in the documentation for Understanding the Components of XNAT

File System Settings

It can be dangerous to change file path settings in a running XNAT.


SettingProperty NameDescriptionDefault
Archive PatharchivePathThis should be the location of the XNAT archive. This is where all the image files for sessions that have been added to XNAT are stored. Modifying this on systems that have already been set up can cause problems, so editing of this is disabled. This path can either be relative, or absolute, and should use the appropriate slashes for your file system./data/xnat/archive
Cache PathcachePathThis should be the location where you want XNAT to cache image session data. This path can either be relative, or absolute, and should use the appropriate slashes for your file system./data/xnat/cache
Prearchive PathprearchivePathThis should be the location of the XNAT prearchive. This is where new imagine sessions are stored while awaiting review before they are archived. This path can either be relative, or absolute, and should use the appropriate slashes for your file system./data/xnat/prearchive

FTP Path

ftpPath
This setting is deprecated and no longer visible in the Admin UI

This is the path where the XNAT FTP Server (no longer available) would write files to. This path can be set to a dummy value if you aren't setting up the FTP Server. This can either be a relative or absolute path, and should use the appropriate slashes for your file system.

/data/xnat/ftp
Build PathbuildPathThis property is not currently used by the XNAT webapp itself, but may be used by pipelines. This path can either be relative, or absolute, and should use the appropriate slashes for your file system./data/xnat/build
Pipeline PathpipelinePathThis should be the location of your pipeline scripts. This path can either be relative, or absolute, and should use the appropriate slashes for your file system./data/xnat/pipeline
Quarantine LocationtriagePathIf set, this file path will contain any "triaged" resource files that are uploaded via Custom Resource Uploaders.


Site-wide config properties can be accessed via REST at /xapi/siteConfig/values/{property-name}.

Site-wide config properties can be access programmatically in Velocity via $siteConfig.{property-name}.


Managing File Caches and Storage

As XNAT repositories scale up in size, storage management becomes a challenge. The XNAT IT Operations documentation has some tips on operating XNAT at scale.

See: Managing XNAT Cache and Temp Storage

$label.name