w3c Jigsaw

Installation Procedure

Prerequisite

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:

Note on upgrading (skip if not upgrading)

For those of you who have already installed a previous release of Jigsaw, you should be aware that since version 1.0alpha4, Jigsaw has a facility for automatically upgrading your configuration files. You will note that the first time you run a newer release of Jigsaw, it will tell you about that upgrading process, and how it goes.

Note: for the upgrade process to happen, it is mandatory that you run Jigsaw the old way, through the w3c.jigsaw.http.httpd class. Once the upgrade is done, you can safely start using the modern command line (ie the w3c.jigsaw.Main). That's a bug !

It is recommended that you keep a backup of the previous configuration, by packing all the config directory in an archive file. Backup'ing the configuration can be done using any tools, if INSTDIR is the place where you installed the previous release of Jigsaw:

Backuping the config
UNIX cd INSTDIR; tar cvf - config > config.tar
Windows cd INSTDIR; zip -r config.zip config

If you use the following instructions, you can re-install using:

Restoring a backed up configuration
UNIX cd INSTDIR; tar xomvf - config.tar
Windows cd INSTADIR; unzip config.zip

Last but not least, once your configuration has been upgraded, you may want :

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:

UNIX
cd INSTDIR
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:

Jigsaw/src
Contains Jigsaw sources.
Jigsaw/classes
Contains the pre-compiled classes.
Jigsaw/lib
Contains some native code support for solaris.
Jigsaw/Jigsaw
Is a sample root directory to run the server in. This directory in turns contain the following sub-directories:
Jigsaw/Jigsaw/config
Is the configuration directory for the server
Jigsaw/Jigsaw/logs
Is the normal directory for log files
Jigsaw/Jigsaw/bin
Contains some shell scripts to help you start Jigsaw.
Jigsaw/Jigsaw/cache
The directory to use for caching when using Jigsaw as a caching proxy.
Jigsaw/Jigsaw/WWW
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:

UNIX
# This depends on the shell you are using, we're assuming /bin/sh
CLASSPATH=INSTDIR/Jigsaw/classes/jigsaw.zip
export CLASSPATH
Windows
set CLASSPATH=INSTDIR/Jigsaw/classes/jigsaw.zip

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.

Running Jigsaw

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

UNIX
cd INSTDIR/Jigsaw/Jigsaw
java w3c.jigsaw.Main -host host -root INSTDIR/Jigsaw/Jigsaw
Windows
cd INSTDIR/Jigsaw/Jigsaw
java 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:

www24:Jigsaw$ bin/jigsaw -root `pwd` 
loading properties from: /0/w3c/abaird/puzzles/JigEdit/config/server.props
Jigsaw[1.0alpha5]: serving at http://www43.inria.fr:8009/

Indicating that it is waiting to meet your browser at the given URL.

Further reading

At this point, it is recommended that you start reading the documentation, available from your server at /User (i.e. in the above example, the full URL would be http://www24.w3.org:8001/User.

Here is a roadmap to the documentation:


Anselm Baird-Smith
$Id: installation.html,v 1.12 1997/02/12 09:26:45 abaird Exp $