Greenstone 3 (GSDL3)
Copyright (C) 2003 New Zealand Digital Libraries, University Of Waikato
GSDL3 comes with ABSOLUTELY NO WARRANTY; for details see LICENSE.txt
This is free software, and you are welcome to redistribute it

Installing Greenstone from a binary distribution (Linux):
---------------------------------------------------------

Download the gsdl3-x.xx-linux executable file, and run it. Follow the instructions given.

Installing Greenstone from a binary distribution (Windows):
-----------------------------------------------------------

Download the gsdl3-x.xx-win32.exe executable file, and double click on it. 
Follow the instructions given. 


Installing Greenstone from a CVS checkout (Linux and Windows):
--------------------------------------------------------------

Checkout the code:

cvs -d :pserver:cvs_anon@cvs.scms.waikato.ac.nz:2402/usr/local/global-cvs/gsdl-src co gsdl3

Build and install:

Greenstone is built and installed using Ant (Apache's Java based build tool, 
http://ant.apache.org). You will need a Java Development 
Environment (1.4 or higher), and Ant installed to use Greenstone. You can download Ant from http://ant.apache.org/bindownload.cgi.

In the gsdl3 directory, you can run ant which will give you a help message.
Running 'ant -projecthelp' gives a list of the targets that you can run - these
do various things like compile the source code, startup the server etc.

For a first time install, run 'ant install'.

The file build.properties contains various parameters that can be set by the user.

For a  non-interactive version of the install, run
ant -Dproperties.accepted=yes install

To log the output in build.log, run
ant -Dproperties.accepted=yes -logfile build.log install

Running Greenstone:
-------------------

To startup the servers, run 'ant startup'. 'ant restart' and 'ant shutdown' restarts and shuts down the servers. TO start or stop just Tomcat or MYSQL, use the startup-tomcat, startup-mysql, shutdown-tomcat, shutdown-mysql targets.

On Windows, if you have installed a binary version, you can also start Greenstone by selecting Greenstone 3 Digital Library from the Start menu.

Using SOAP (Linux and Windows):
-------------------------------

Greenstone comes with Apache Axis installed as a webapp in Tomcat.  A SOAP server on localsite is deployed during installation. You should be able to see all localsite's collections through the gateway servlet.

To set up a SOAP server on a new site, run
ant soap-deploy-site
This will prompt you for the sitename (the directory name), and the site uri - this should be a unique identifier for the site's web service.

For a non-interactive version, run
ant -Daxis.sitename=xxx -Daxis.siteuri=yyy soap-deploy-site

Building Collections:
-----------------------
Windows: need to have Perl installed and on your PATH.

You can build collections using either Greenstone 2 style building, or native Greenstone 3 style.
Greenstone 2:
run  'ant gli", or cd to gsdl3/gli and run gli4gs3.sh/bat. This is a graphical tool for building collections.

Greenstone 3:
in the gsdl3 directory, run: source gs3-setup.sh (linux) or gs3-sestup (windows).
To create a new collection, run 'gs3-mkcol.sh/bat <sitename> <collname>'
Put documents in the import directory (gsdl3/web/sites/<sitename>/collect/<collname>/import), edit the collection configuration file (gsdl3/web/sites/<sitename>/collect/<collname>/etc/collectionConfig.xml), and run 'gs3-build.sh <sitename> <collname>'
Rename the building directory to index (in gsdl3/web/sites/<sitename>/collect/<collname>) and reload the collection in Tomcat, or restart Tomcat.

See the manual for more details about both styles of collection building.

Other Notes:
---------------

See gsdl3/docs/manual/manual.pdf for more details about the software and installation etc.

Under Linux, Tomcat logs output in gsdl3/comms/jakarta/tomcat/logs/catalina.out.

To prevent Tomcat showing directory listings, edit the gsdl3/comms/jakarta/tomcat/conf/web.xml file and set the value of the "listings" servlet parameter to false.