[ You are here:
XTF ->
Deployment Guide -> XTF Base Directory ]
The XTF Base Directory (XTF_HOME)
The
XTF base directory is critical to understanding where resources are located in your XTF installation. In general, the base directory is the top level of the XTF installation, and contains important sub-directories such as conf, style, and WEB-INF. Every component of XTF needs to locate this base directory to enable it to find configuration files, stylesheets, and data files.
In the case of the servlets, the servlet container (typically
Tomcat or
Resin) provides the base directory, and it's usually:
servlet-directory/webapps/xtf/. This can be overridden in the servlet configuration by specifying a
base-dir configuration parameter; how to do this depends on the particular servlet container.
The command-line tools such as
textIndexer cannot rely on the servlet container. The way this is handled depends on whether you're running XTF on Unix or Windows:
- On Unix systems, the textIndexer perl script in the XTF bin directory can detect where it's running from and set XTF_HOME automatically. However, if you are running multiple instances of XTF on one machine, you'll need to explicitly set the XTF_HOME variable to point to the correct instance.
- On Windows systems, you run bin/textIndexer.bat, which is not able to detect where it's running and set XTF_HOME. Thus, you need to set it explicitly. See the Running on Windows section for details.