source: branches/ant-install-branch/gsdl3/README.txt@ 9785

Last change on this file since 9785 was 9767, checked in by kjdon, 19 years ago

added a windows note about building colls

  • Property svn:keywords set to Author Date Id Revision
File size: 2.7 KB
Line 
1Greenstone 3 (GSDL3)
2Copyright (C) 2003 New Zealand Digital Libraries, University Of Waikato
3GSDL3 comes with ABSOLUTELY NO WARRANTY; for details see LICENSE.txt
4This is free software, and you are welcome to redistribute it
5
6Installing Greenstone from a binary distribution (Linux):
7---------------------------------------------------------
8
9Download the gsdl3-x.xx-linux executable file, and run it. Follow the instructions given.
10
11Installing Greenstone from a binary distribution (Windows):
12-----------------------------------------------------------
13
14Download the gsdl3-x.xx-win32.exe executable file, and double click on it.
15Follow the instructions given.
16
17
18Installing Greenstone from a CVS checkout (Linux and Windows):
19--------------------------------------------------------------
20
21Checkout the code:
22
23cvs -d :pserver:[email protected]:2402/usr/local/global-cvs/gsdl-src co gsdl3
24
25Build and install:
26
27Greenstone is built and installed using Ant (Apache's Java based build tool,
28http://ant.apache.org). You will need a Java Development
29Environment (1.4 or higher), and Ant installed to use Greenstone. You can download Ant from http://ant.apache.org/bindownload.cgi.
30
31In the gsdl3 directory, you can run ant which will give you a help message.
32Running 'ant -projecthelp' gives a list of the targets that you can run - these
33do various things like compile the source code, startup the server etc.
34
35For a first time install, run 'ant install'.
36
37The file build.properties contains various parameters that can be set by the user.
38
39
40Running Greenstone:
41-------------------
42
43To startup the servers, run 'ant startup'. 'ant restart' and 'ant shutdown' restarts and shuts down the servers.
44
45On Windows, if you have installed a binary version, you can also start Greenstone by selecting Greenstone 3 Digital Library from the Start menu.
46
47Using SOAP (Linux and Windows):
48-------------------------------
49
50Greenstone 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.
51
52To set up a SOAP server on a new site, run
53ant soap-deploy-site
54This 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.
55
56Building Collections:
57-----------------------
58Windows: need to have Perl installed and on your PATH.
59
60Other Notes:
61---------------
62
63See gsdl3/docs/manual/manual.pdf for more details about the software and installation etc.
64
65Tomcat logs output in gsdl3/comms/jakarta/tomcat/logs/catalina.out.
66
67To 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.
68
Note: See TracBrowser for help on using the repository browser.