source: trunk/gsdl3/README.txt@ 8964

Last change on this file since 8964 was 8428, checked in by kjdon, 20 years ago

added a note about java 1.4

  • Property svn:keywords set to Author Date Id Revision
File size: 3.0 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(cvs co gsdl3) (if not already done)
19cd gsdl3
20./gs3-install.sh
21
22If you change the source and want to compile it again later, you can run 'make' then 'make install' from this directory.
23
24If you want to compile the test servlet, (useful is you are unsure whether Tomcat is working properly), go to gsdl3/web/WEB-INF/classes, and run 'javac TestServlet.java'.
25
26Greenstone requires Java 1.4.
27
28Running Greenstone:
29-------------------
30
31Run the script gs3-launch.sh from the gsdl3 directory. This starts up a Tomcat web server and a mysql database server. To shutdown, run gs3-launch.sh -shutdown
32
33Using SOAP:
34------------
35
36Greenstone comes setup to use SOAP. SOAP runs as a servlet inside Tomcat, and is disabled by default. To enable it, run
37./gs3-enable-soap.sh
38Then re-launch Greenstone:
39./gs3-launch.sh -shutdown
40./gs3-launch.sh
41
42A SOAP server for localsite comes predeployed.
43You should be able to see all localsite's collections through the gateway servlet.
44
45To set up a SOAP server on a new site, run
46gs3-soap-deploy-site.sh <sitename> <siteURI>
47where the sitename is the directory name of the site, and siteURI is a unique
48identifier for the sites 'web service'.
49
50
51
52|----------|
53| Windows: |
54|----------|
55
56Installing Greenstone from a binary distribution:
57-------------------------------------------------
58
59Download the gsdl3-x.xx-win32.exe executable file, and double click on it.
60
61To run Greenstone, select Greenstone 3 Digital Library from the Start menu.
62
63Installing Greenstone from a CVS checkout:
64------------------------------------------
65
66(cvs co gsdl3) (if not already done)
67cd gsdl3
68gs3-install
69
70To run Greenstone, run
71gs3-launch
72This starts up the Tomcat web server and mysql database server.
73
74Using SOAP:
75------------
76
77Greenstone comes setup to use SOAP. SOAP runs as a servlet inside Tomcat, and is disabled by default. To enable it, run
78gs3-enable-soap
79Then shutdown and restart Greenstone.
80
81A SOAP server for localsite comes predeployed.
82You should be able to see all localsite's collections through the gateway servlet.
83
84To set up a SOAP server on a new site, run
85gs3-soap-deploy-site <sitename> <siteURI>
86where the sitename is the directory name of the site, and siteURI is a unique
87identifier for the sites 'web service'.
88
89|--------------|
90| Other notes: |
91|--------------|
92
93See gsdl3/docs/manual/manual.pdf for more details about the software and installation etc.
94
95To 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.
96
Note: See TracBrowser for help on using the repository browser.