Changeset 3561


Ignore:
Timestamp:
2002-11-25T13:46:02+13:00 (21 years ago)
Author:
kjdon
Message:

installation now carried out by a script

Location:
trunk/gsdl3
Files:
3 edited

Legend:

Unmodified
Added
Removed

  • trunk/gsdl3/CHANGES

    r3393 r3561  
     12002/11/25 ******************************
     2
     3haven't kept up with comments :-(
     4Installation has been changed - now uses a script to carry out the stuff that
     5was previously done by hand.
     6
     7
    182002/08/23 ******************************
    29

  • trunk/gsdl3/INSTALL

    r3393 r3561  
    11INSTALLATION GUIDE FOR GSDL3
    22
    3 1. you also need to get mgpp code - comes in a separate checkout.
    4 I once added a directory for mgpp into gsdl3/packages in cvs - now I cant get
    5 rid of it, so you need to delete it before you start.
    6 cd packages
    7 rm -r mgpp
    8 cvs co mgpp
    9 cd mgpp
    10 ./configure --prefix <gsdl3home>
    11 make
    12 make install
    13 cd ../..
     3This stuff is all done by a script now:
     4need to carry out the following:
    145
    15 Note: you need to use your gsdl3 home directory as the prefix for configure
    16 at this stage - mgpp has been set up properly, but gsdl3 hasn't
     6source setup.bash
     7install.bash
     8
     9if you want to use soap, also run
     10install-soap.bash
    1711
    1812
    19 2. Make the gsdl3 stuff
    20 
    21 First need to unpack the tomcat stuff, cos we use a jar file from there
    22 
    23 cd comms/tomcat/
    24 
    25 tar xzvf jakarta-tomcat-4.0.1.tar.gz
    26 
    27 cd ../..
    28 
    29 source setup.bash - to set up your CLASSPATH
    30 
    31 do a 'make', then 'make install', in each of the following directories
    32 
    33 src/java/org/greenstone/gdbm
    34 src/java/org/greenstone/testing
    35 src/java/org/greenstone/gsdl3
    36 src/java/org/greenstone/applet/phind
    37 
    38 3. set up the sample mgpp collection
    39 
    40 in sites/localsite/collect/mgppdemo/index/
    41 
    42 tar xzvf mgpp-indexfiles.tar.gz
    43 
    44 this is a collection built using mgpp in greenstone 2 - MGPPGDBMService works
    45 with this type of collection.
    46 
    47 Note, you can use the new Java Queryer program to query this collection (see
    48 RUNNING)
    49 
    50 
    51 4. set up the servlet information for tomcat
    52 
    53 edit web/WEB-INF/web.xml
    54 
    55 in the init-param entries for the servlet, you need to change the siteshome
    56 and interfaces home params to reflect your installation setup. - should point to the sites and interfaces directories.
    57 
    58 in web, add symbolic links to your interfaces, sites and lib directories
    59 
    60 is likely to be:
    61 ln -s ../interfaces
    62 ln -s ../sites
    63 ln -s ../lib
    64 
    65 5. set up tomcat
    66 
    67 cd comms/tomcat/jakarta-tomcat-4.0.1
    68 
    69 edit bin/catalina.sh:
    70 
    71 on line 89 add $CLASSPATH to the CP="...." line ie. CP="$CLASSPATH:..." - this
    72 sets up the class path properly
    73 
    74 edit conf/server.xml:
    75 
    76 you need  add a context for gsdl servlets
    77 add these lines (putting the correct path for GSDL3HOME)
    78 
    79 <!-- GSDL3 Service -->
    80 <Context path="/gsdl3" docBase="<GSDL3HOME>/web" debug="1" reloadable="true"/>
    81 
    82 when you edit server.xml, (or change web.xml in gsdl3/web/WEB-INF/web.xml) or
    83 change the classes, you need to shutdown and restart the server. also you may
    84 need to clear the cache of your browser
    85 
    86 (conf/server.xml is the place to change the port number if needed)
    87 
    88 
    89 6. run tomcat
    90 
    91 to run tomcat, you need to have sourced setup.bash in GSDL3HOME to set up $CLASSPATH
    92 
    93 then cd to comms/tomcat/jakarta-tomcat-4.0.1/bin
    94 
    95 run ./startup.sh
    96 
    97 (to shut down tomcat, run ./shutdown.sh)
    98 
    99 the tomcat server can be accessed on the web via localhost:8080
    100 
    101 the greenstone stuff is at localhost:8080/gsdl3 - this uses index.html - has
    102 links to the test servlet and the greenstone servlets
    103 
    104 you should be able to run library from the index page
    105 
    106 System.out/err and cout/cerr go to comms/tomcat/jakarta-tomcat-4.0.1/logs/catalina.out - if need to debug stuff
    107 
    108 7. The test servlet
    109 
    110 a test servlet is provided to make sure you have tomcat set up properly
    111 
    112 in web/WEB-INF/classes, do 'javac TestServlet.java'
    113 
    114 you can click on the link on the gsdl3 index page to run the test.
    115 or can specify it directly:
    116 localhost:8080/gsdl3/testing
    117 
    118 the path 'testing' is determined by servlet-mapping entry in
    119 web/WEB-INF/web.xml
    120 
    121 
    122 
    123 USING SOAP TO TALK TO A REMOTE SITE
    124 
    125 this is needed if you have a setup such as for site1 - it uses a SOAP
    126 connection to site2.
    127 
    128 1. set up SOAP
    129 
    130 untar soap-bin-2.2.tar.gz in the comms/soap directory
    131 
    132 edit comms/tomcat/jakarta-tomcat-4.0.1/conf/server.xml
    133 
    134 add the following (put proper path for <GSDL3HOME>)
    135 
    136 <!-- SOAP Service -->
    137 <Context path="/soap" docBase="<GSDL3HOME>/comms/soap/soap-2_2/webapps/soap" debug="1" reloadable="true"/>
    138 
    139 
    140 2. set up SOAP Server:
    141 
    142 the class SOAPServer is a wrapper around a messagerouter - so can serve
    143 the collections
    144 
    145 it has a path hard coded in  - need to set this to your appropriate site -
    146 for the example sites that I've set up, it should be <GSDL3HOME>/sites/site2
    147 
    148 3. deploy your service - SOAPServer
    149 
    150 you can access the soap service though the web, at http://localhost:8080/soap
    151 
    152 Run the admin client
    153 
    154 can list, deploy, undeploy soap services
    155 
    156 to deploy the SOAPServer for site2:
    157 
    158 edit the following fields in the deploy form:
    159 
    160 ID:  org.greenstone.site2
    161 Scope: any will do: Request - new instantiation for each request
    162             Session - same instantiation across a session
    163             Application - only uses one instantiation
    164 
    165 Methods: process
    166 
    167 Java Provider / Provider Class: org.greenstone.gsdl3.SOAPServer
    168 
    169 then click deploy.
    170 hopefully all will be well.
    171 
    172 4. debugging soap:
    173 
    174 tomcat output goes to jakarta-tomcat-4.0.1/logs/catalina.out
    175 
    176 if you recompile the classes, you need to shutdown and restart tomcat to get
    177 the new classes.
    178 
    179 deployment info is retained between shutdown and start up - dont need to
    180 redeploy it each time.
    181 
    182 TcpTUnnelGui:
    183 
    184 this program allows you to view the actual soap messages
    185 
    186 run like:
    187 
    188 java org.apache.soap.util.net.TcpTunnelGui 8070 localhost 8080
    189 
    190 tomcat uses 8080, and you need to modify the greenstone stuff to talk to port
    191 8070 instead of 8080:
    192 
    193 sites/site1 is the site that talks to the SOAPServer for site2
    194 
    195 in site1/sitecfg.xml, in the address field, replace 8080 with 8070 when you
    196 want to use TcpTunnelGui.
    197 
    198 note that
    199 http://localhost:8080/soap/servlet/rpcrouter
    200 
    201 is the address for talking to the tomcat soap thingy.
    202 
    203 

  • trunk/gsdl3/RUNNING

    r3393 r3561  
    1 Note: when running the localhost:8080/gsdl3/library, only the mgppdemo
    2 collection can do anything useful.
     1Note: when running the localhost:8080/gsdl3/library, only the mgppdemo and
     2chinese demo collections can do anything useful.
    33
    44*******************************************************
    … …  
    77Sites contain collections. Interfaces contain images and xslts.
    88
    9 There are 3 sites in this prototype example.
     9There are 2 sites in this prototype example.
    1010
    1111sites/localsite is a standalone site, like used by a local library. It has
    1212no connections to any other sites.
    1313
    14 sites/site1 is a site that specifies a SOAP connection to another site: site2
     14sites/site1 is a site that specifies a SOAP connection to another site: localsite
    1515
    16 sites/site2 can be run as a local site also.
    17 
    18 to run site1, and talk to site2 via SOAP, you need to have apache tomcat installed,running, and serving site2. (see INSTALL)
     16to run site1, and talk to localsite via SOAP, you need to have apache tomcat installed, running, and serving site2. (see INSTALL)
    1917
    2018You can add other sites by putting a directory in the sites directory, and
    … …  
    2927
    3028XSL Files: when an xslt file is to be used, eg home.xsl, it is looked for in
    31 several places: in current site/transform, current interface/transform, and
    32  finally default/transform
     29several places: in sites/current site/transform, interfaces/current interface/transform, and finally interfaces/default/transform
    3330
    3431so you can change the interface by adding new xslt files to these three places.
    35  Note, if a stylesheet includes another one, eg they all include style.xsl,
    36 the included one needs to be in the same directory  - ie you need to either
    37 create a new one, or copy the default one to the new location.
    3832
    3933******************************************************
    … …  
    4842Currently, only Text search works.
    4943
    50 to change the interface language, you can add &l=fr to the url. fr is the
    51 only alternative to en at the moment.
     44to change the interface language, you can add &l=fr to the url. However, there are no alternative langs at the moment.
    5245
    5346*******************************************************
    … …  
    10295
    10396<message lang="en">
    104 <request type="action" info="q/text">
     97<request type="action" action="q" subaction="text">
    10598<paramList>
    10699<param name="q" value="the"/>
    … …  
    114107
    115108home page:
    116 <message lang="en"><request type="action" info="p/home"/></message>
     109<message lang="en"><request type="action" action="p" subaction="home" /></message>
    117110
    118111about page for mgppdemo:
    119 <message lang="en"><request type="action" info="p/about"><paramList><param name="c" value="mgppdemo"/></paramList></request></message>
     112<message lang="en"><request type="action" action="p" subaction="about""><paramList><param name="c" value="mgppdemo"/></paramList></request></message>
    120113
    121114search for frog in mgppdemo: (no docs returned)
    122 <message lang="en"><request type="action" info="q/text"><paramList><param name="c" value="mgppdemo"/><param name="q" value="frog"/><param name="md" value="10"/></paramList></request></message>
     115<message lang="en"><request type="action" action="q" subaction="text"><paramList><param name="c" value="mgppdemo"/><param name="q" value="frog"/><param name="md" value="10"/></paramList></request></message>
    123116
    124117search for frog in mgppdemo, with stemming on: (some docs returned)
    125 <message lang="en"><request type="action" info="q/text"><paramList><param name="c" value="mgppdemo"/><param name="q" value="frog"/><param name="md" value="10"/><param name="s" value="1"/></paramList></request></message>
     118<message lang="en"><request type="action" action="q" subaction="text""><paramList><param name="c" value="mgppdemo"/><param name="q" value="frog"/><param name="md" value="10"/><param name="s" value="1"/></paramList></request></message>
    126119
    127120
Note: See TracChangeset for help on using the changeset viewer.