This document describes how to install Jigsaw. It assumes that you
have retreived Jigsaw distribution (see
Jigsaw overview for how
to get the distribution files), and that you have downloaded any of the Java
interpreters for your machine. We are assuming that if you are running on
Windows (be it 95 or NT), you have downloaded the .zip
file,
otherwise, you have the .tar.gz
file (this is not required,
but if you are not doing so, you are supposed to know what you do).
The installation process involves the following steps:
Pick a place to unpack the distribution: we'll call this directory the installation directory (abreviated 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
Jigsaw/classes
Jigsaw/Jigsaw
Jigsaw/Jigsaw/config
Jigsaw/Jigsaw/logs
Jigsaw/Jigsaw/bin
Jigsaw/Jigsaw/WWW
You are now ready for the next section, which explains how to setup 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 |
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.
You are now all set to run Jigsaw. Just type in the following command:
UNIX |
cd INSTDIR/Jigsaw/Jigsaw java w3c.jigsaw.http.httpd -host host -root INSTDIR/Jigsaw/Jigsaw |
Windows |
cd INSTDIR/Jigsaw/Jigsaw java w3c.jigsaw.http.httpd -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: /afs/w3.org/usr/abaird/Jigsaw/config/httpd.props [httpd]: listening at:http://www24.w3.org:8001
Indicating that it is waiting to meet your browser at the given URL.
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: