W3C logo

Installation Procedure

Jigsaw Home / Documentation Overview


Before reading further make sure:

This document describes how to install Jigsaw. As an example, we are assuming that you are running either on Windows (be it 95 or NT) or on UNIX, even though Jigsaw will (should ?) run on any platform that supports Java.

The installation process involves the following steps:

Unpacking the distribution file

Pick a place to unpack the distribution: we'll call this directory the installation directory (abreviated as INSTDIR). This can be any directory, you just have to change your current working directory to it:


Windows : cd INSTDIR

Now unpack the file:

UNIX : cat jigsaw.tar.gz | gzip -d | tar xomvf -

Windows : unzip jigsaw.zip

This will create a number of directories under the Jigsaw directory:

Contains Jigsaw sources.
Contains the pre-compiled classes.
Contains some native code support for solaris.
Is a sample root directory to run the server in. This directory in turns contain the following sub-directories:
Is the configuration directory for the server
Is the configuration directory for the administration server.
Is the normal directory for log files
Contains some shell scripts to help you start Jigsaw.
The directory to use for caching when using Jigsaw as a caching proxy.
Is your exported file space

You are now ready for the next section, which explains how to setup your environment.

Setting up your environment

As Jigsaw is just a set of Java classes, you need to specify to the Java interpreter the place where Jigsaw classes are stored. This is usually done by setting some CLASSPATH environment variable. This is simply done by the following command for 2.1.0 and up:

            # This depends on the shell you are using, we're assuming /bin/sh
            export CLASSPATH

            set CLASSPATH=INSTDIR\Jigsaw\classes\jigsaw.jar;INSTDIR\Jigsaw\classes\sax.jar;INSTDIR\Jigsaw\classes\xp.jar;.

And this one for version up to 2.0.x:

            # This depends on the shell you are using, we're assuming /bin/sh
            export CLASSPATH

            set CLASSPATH=INSTDIR\Jigsaw\classes\jigsaw.zip;INSTDIR\Jigsaw\classes\servletjar.

Don't forget to change INSTDIR with the absolute path of the place you have unpacked the distribution. You should now be ready to run Jigsaw.

Warning: on some Windows Java implementation, prefixing the CLASSPATH with the disk drive letter may cause some confusion. If java complains about not being able to find some class, you may want to remove the disk drive letter from the CLASSPATH. Note also that if you are adding this line in a batch file, you must escape the '\' the line will be: set CLASSPATH=INSTDIR\\Jigsaw\\classes\\jigsaw.zip

Build the right property files

Be careful to have the right CLASSPATH (see above):

         cd INSTDIR/Jigsaw/Jigsaw
         java Install

         cd INSTDIR\Jigsaw\Jigsaw
         java Install

Running Jigsaw

You are now all set to run Jigsaw. Just type in the following command:

         cd INSTDIR/Jigsaw/Jigsaw
         java org.w3c.jigsaw.Main -host host -root INSTDIR/Jigsaw/Jigsaw

         cd INSTDIR\Jigsaw\Jigsaw
         java org.w3c.jigsaw.Main -host host -root INSTDIR\Jigsaw\Jigsaw

Don't forget to susbstitute to INSTDIR the absolute path of the location where you have unpacked the distribution file, and to host the full IP hostname of the machine running Jigsaw.

Jigsaw should be running, and will probably have emited a message like:

jigsaw Sample/Jigsaw> java org.w3c.jigsaw.Main
loading properties from: /auto/tarantula/u/tarantula/0/w3c/ylafon/Sample/Jigsaw/config/server.props
Jigsaw[2.0beta1]: serving at http://jigsaw.inria.fr:8007/
*** Warning : no logger specified, not logging.
JigAdmin[2.0beta1]: serving at http://jigsaw.inria.fr:8009/