[ You are here: XTF -> Deployment Guide -> Installing XTF ]

Installing XTF


Prior to installing the XTF package, install and configure the Run-Time Environment as described in the Run-time Installation section. Once the run-time environment is up and running, do the following steps to install the XTF Package.

Note: this procedure depends on a Unix-type shell and a Perl command interpreter. If you are attempting to run XTF on Microsoft Windows, and don't have an environment such as cygwin that includes Perl, then see the section Running on Windows.

  1. Shut down your servlet container, to keep it from prematurely trying to unpack XTF.
  2. Download the XTF web-archive file (via SourceForge) and place it in your servlet container's webapps directory. It will named xtf-2.x.x.war, where 2.x.x is the version number.
  3. Very important: rename the downloaded file to just xtf.war (so that the servlet container will unpack it to the xtf subdirectory instead of xtf-2.x.x).
  4. Start up the servlet container, and browse to a URL referencing an XTF servlet, such as crossQuery:
    http://yourserver:8080/xtf/search
    Accessing this URL should cause the servlet container to unpack the web archive file, creating an xtf sub-directory below the container's webapps directory. This automatically installs the crossQuery and dynaXML servlets, the textIndexer tool, and a default configuration that allows you to work with the Sample Document Library.
  5. Download the sample data package (sample-data-2.x.x.zip) from SourceForge.
  6. From the command prompt, set the XTF_HOME environment variable to the directory where the XTF package is installed. This environment variable is used by the textIndexer (and other tools) to locate various XTF components. For example, from a BASH shell:
    $ export XTF_HOME= servlet-container-directory/webapps/xtf
    (Note: To avoid having to repeatedly set and export the XTF_HOME environment variable, you may wish to add this statement to your .bashrc file.)
  7. Using this new environment variable, switch to the XTF installation directory:
    $ cd "$XTF_HOME"
  8. Extract the Sample Document Library using your favorite ZIP file utility. For example, using the unzip tool under Linux/Unix, you would type:
    $ unzip sample.zip
    Doing so will create a new sub-directory called data. This will place the Sample Document Library where the default XTF configuration expects to see it. You should now have the following directory present (among others): data/tei/ft958009mm.
At this point, the crossQuery and dynaXML servlets, and the textIndexer tool are installed and ready to use. Also installed are a sample document library and a sample configuration that you can use to index, search for, and retrieve documents from the sample library. To play with the sample setup, simply follow the steps outlined in the last two sections of the Quick Start guide.

Alternately, to customize the sample installation to better suit your needs, see one of the following sections: