| 1 | Greenstone 3 (GSDL3)
|
|---|
| 2 | Copyright (C) 2003 New Zealand Digital Libraries, University Of Waikato
|
|---|
| 3 | GSDL3 comes with ABSOLUTELY NO WARRANTY; for details see LICENSE.txt
|
|---|
| 4 | This is free software, and you are welcome to redistribute it
|
|---|
| 5 |
|
|---|
| 6 | Installing Greenstone from a binary distribution (Linux):
|
|---|
| 7 | ---------------------------------------------------------
|
|---|
| 8 |
|
|---|
| 9 | Download the gsdl3-x.xx-linux executable file, and run it. Follow the instructions given.
|
|---|
| 10 |
|
|---|
| 11 | Installing Greenstone from a binary distribution (Windows):
|
|---|
| 12 | -----------------------------------------------------------
|
|---|
| 13 |
|
|---|
| 14 | Download the gsdl3-x.xx-win32.exe executable file, and double click on it.
|
|---|
| 15 | Follow the instructions given.
|
|---|
| 16 |
|
|---|
| 17 |
|
|---|
| 18 | Installing Greenstone from a CVS checkout (Linux and Windows):
|
|---|
| 19 | --------------------------------------------------------------
|
|---|
| 20 |
|
|---|
| 21 | Checkout the code:
|
|---|
| 22 |
|
|---|
| 23 | cvs -d :pserver:[email protected]:2402/usr/local/global-cvs/gsdl-src co gsdl3
|
|---|
| 24 |
|
|---|
| 25 | Build and install:
|
|---|
| 26 |
|
|---|
| 27 | Greenstone is built and installed using Ant (Apache's Java based build tool,
|
|---|
| 28 | http://ant.apache.org). You will need a Java Development
|
|---|
| 29 | Environment (1.4 or higher), and Ant installed to use Greenstone. You can download Ant from http://ant.apache.org/bindownload.cgi.
|
|---|
| 30 |
|
|---|
| 31 | In the gsdl3 directory, you can run ant which will give you a help message.
|
|---|
| 32 | Running 'ant -projecthelp' gives a list of the targets that you can run - these
|
|---|
| 33 | do various things like compile the source code, startup the server etc.
|
|---|
| 34 |
|
|---|
| 35 | For a first time install, run 'ant install'.
|
|---|
| 36 |
|
|---|
| 37 | The file build.properties contains various parameters that can be set by the user.
|
|---|
| 38 |
|
|---|
| 39 | For a non-interactive version of the install, run
|
|---|
| 40 | ant -Dproperties.accepted=yes install
|
|---|
| 41 |
|
|---|
| 42 | To log the output in build.log, run
|
|---|
| 43 | ant -Dproperties.accepted=yes -logfile build.log install
|
|---|
| 44 |
|
|---|
| 45 | Running Greenstone:
|
|---|
| 46 | -------------------
|
|---|
| 47 |
|
|---|
| 48 | 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.
|
|---|
| 49 |
|
|---|
| 50 | On Windows, if you have installed a binary version, you can also start Greenstone by selecting Greenstone 3 Digital Library from the Start menu.
|
|---|
| 51 |
|
|---|
| 52 | Using SOAP (Linux and Windows):
|
|---|
| 53 | -------------------------------
|
|---|
| 54 |
|
|---|
| 55 | 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.
|
|---|
| 56 |
|
|---|
| 57 | To set up a SOAP server on a new site, run
|
|---|
| 58 | ant soap-deploy-site
|
|---|
| 59 | 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.
|
|---|
| 60 |
|
|---|
| 61 | For a non-interactive version, run
|
|---|
| 62 | ant -Daxis.sitename=xxx -Daxis.siteuri=yyy soap-deploy-site
|
|---|
| 63 |
|
|---|
| 64 | Building Collections:
|
|---|
| 65 | -----------------------
|
|---|
| 66 | Windows: need to have Perl installed and on your PATH.
|
|---|
| 67 |
|
|---|
| 68 | You can build collections using either Greenstone 2 style building, or native Greenstone 3 style.
|
|---|
| 69 | Greenstone 2:
|
|---|
| 70 | run 'ant gli", or cd to gsdl3/gli and run gli4gs3.sh/bat. This is a graphical tool for building collections.
|
|---|
| 71 |
|
|---|
| 72 | Greenstone 3:
|
|---|
| 73 | in the gsdl3 directory, run: source gs3-setup.sh (linux) or gs3-sestup (windows).
|
|---|
| 74 | To create a new collection, run 'gs3-mkcol.sh/bat <sitename> <collname>'
|
|---|
| 75 | 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>'
|
|---|
| 76 | Rename the building directory to index (in gsdl3/web/sites/<sitename>/collect/<collname>) and reload the collection in Tomcat, or restart Tomcat.
|
|---|
| 77 |
|
|---|
| 78 | See the manual for more details about both styles of collection building.
|
|---|
| 79 |
|
|---|
| 80 | Other Notes:
|
|---|
| 81 | ---------------
|
|---|
| 82 |
|
|---|
| 83 | See gsdl3/docs/manual/manual.pdf for more details about the software and installation etc.
|
|---|
| 84 |
|
|---|
| 85 | Under Linux, Tomcat logs output in gsdl3/comms/jakarta/tomcat/logs/catalina.out.
|
|---|
| 86 |
|
|---|
| 87 | 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.
|
|---|
| 88 |
|
|---|
