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

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

starting the changeover to Ant instructions

  • Property svn:keywords set to Author Date Id Revision
File size: 3.3 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
6|--------|
7| Linux: |
8|--------|
9
10Installing Greenstone from a binary distribution:
11-------------------------------------------------
12
13Download the gsdl3-x.xx-linux executable file, and run it. Follow the instructions given.
14
15Installing Greenstone from a CVS checkout:
16------------------------------------------
17
18
19Checkout the code:
20
21cvs -d :pserver:[email protected]:2402/usr/local/global-cvs/gsdl-src co gsdl3
22
23Build and install:
24
25Greenstone is built and installed using Ant (Apache's Java based build tool,
26http://ant.apache.org). You will need a Java Development
27Environment (1.4 or higher), and Ant installed to use Greenstone.
28
29In the gsdl3 directory, you can run ant which will give you a help message.
30Running 'ant -projecthelp' gives a list of the targets that you can run - these
31do various things like compile the source code, startup the server etc.
32
33For a first time install, run 'ant install'.
34
35The file build.properties contains various parameters that can be set by the user.
36
37
38Running Greenstone:
39-------------------
40
41To startup the servers, run 'ant startup'. 'ant restart' and 'ant shutdown' restarts and shuts down the servers.
42
43
44Using SOAP:
45------------
46
47Greenstone comes setup to use SOAP. SOAP runs as a servlet inside Tomcat, and is disabled by default. To enable it, run
48./gs3-enable-soap.sh
49Then re-launch Greenstone:
50./gs3-launch.sh -shutdown
51./gs3-launch.sh
52
53A SOAP server for localsite comes predeployed.
54You should be able to see all localsite's collections through the gateway servlet.
55
56To set up a SOAP server on a new site, run
57gs3-soap-deploy-site.sh <sitename> <siteURI>
58where the sitename is the directory name of the site, and siteURI is a unique
59identifier for the sites 'web service'.
60
61
62
63|----------|
64| Windows: |
65|----------|
66
67Installing Greenstone from a binary distribution:
68-------------------------------------------------
69
70Download the gsdl3-x.xx-win32.exe executable file, and double click on it.
71
72To run Greenstone, select Greenstone 3 Digital Library from the Start menu.
73
74Installing Greenstone from a CVS checkout:
75------------------------------------------
76
77(cvs co gsdl3) (if not already done)
78cd gsdl3
79gs3-install
80
81To run Greenstone, run
82gs3-launch
83This starts up the Tomcat web server and mysql database server.
84
85Using SOAP:
86------------
87
88Greenstone comes setup to use SOAP. SOAP runs as a servlet inside Tomcat, and is disabled by default. To enable it, run
89gs3-enable-soap
90Then shutdown and restart Greenstone.
91
92A SOAP server for localsite comes predeployed.
93You should be able to see all localsite's collections through the gateway servlet.
94
95To set up a SOAP server on a new site, run
96gs3-soap-deploy-site <sitename> <siteURI>
97where the sitename is the directory name of the site, and siteURI is a unique
98identifier for the sites 'web service'.
99
100|--------------|
101| Other notes: |
102|--------------|
103
104See gsdl3/docs/manual/manual.pdf for more details about the software and installation etc.
105
106To 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.
107
Note: See TracBrowser for help on using the repository browser.