Changeset 10826
- Timestamp:
- 2005-11-02T15:22:08+13:00 (18 years ago)
- Location:
- trunk/gsdl3/docs/manual
- Files:
-
- 2 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/gsdl3/docs/manual/manual.tex
r10777 r10826 93 93 \begin{gsc} 94 94 \item \gsdlhome/web/WEB-INF/web.xml 95 \item \gsdlhome/ comms/jakarta/tomcat/conf/server.xml95 \item \gsdlhome/packages/tomcat/conf/server.xml 96 96 \end{gsc} 97 97 \item any classes or jar files used by the servlets 98 98 \end{bulletedlist} 99 99 \noindent Note: stdout and stderr for the servlets (on Linux and Mac OS X) both go to\\ 100 \gst{\gsdlhome/ comms/jakarta/tomcat/logs/catalina.out}100 \gst{\gsdlhome/packages/tomcat/logs/catalina.out} 101 101 102 102 … … 121 121 & Source code lives here \\ 122 122 greenstone3/src/java/ 123 & java source code \\ 124 greenstone3/packages 125 & Imported packages from other systems e.g. MG, MGPP \\ 123 & main greenstone 3 java source code \\ 124 greenstone3/src/packages 125 & Imported source packages from other systems e.g. MG, MGPP \\ 126 greenstone3/extensions 127 & Extensions to greenstone 3 core functionality, eg, Vishnu visualizer, Alerting service \\ 126 128 greenstone3/lib 127 129 & Shared library files\\ 128 130 greenstone3/lib/java 129 & Java jar files\\ 131 & Java jar files not needed in the greenstone 3 runtime\\ 132 greenstone3/lib/jni 133 & Jar files and shared library files (.so, .jnilib, .dll) needed for JNI components \\ 130 134 greenstone3/resources 131 135 & any resources that may be needed\\ 132 greenstone3/resources/java133 & properties files for java resource bundles - used to handle all the language specific text This directory is on the class path, so any other Java resources can be placed here \\134 136 greenstone3/resources/soap 135 137 & soap service description files \\ 136 greenstone3/resources/dtd137 & \gsiii\ has trouble locating DTD files sometimes. They can go here\\138 138 greenstone3/bin 139 139 & executable stuff lives here\\ 140 140 greenstone3/bin/script 141 141 & some Perl and/or shell building scripts\\ 142 greenstone3/ comms143 & Communication packages: Tomcat and SOAP\\142 greenstone3/packages 143 & External packages that may be installed as part of greenstone, e.g. Tomcat, Mysql \\ 144 144 greenstone3/docs 145 145 & Documentation\\ … … 150 150 & The web.xml file lives here (servlet configuration information for Tomcat)\\ 151 151 greenstone3/web/WEB-INF/classes 152 & Servlet classes go in here\\ 152 & Individual class files needed by the servlet go in here, also properties files for java resource bundles - used to handle all the language specific text. This direcotry is on the servlet classpath\\ 153 greenstone3/web/WEB-INF/lib 154 & jar files needed by the servlets go here \\ 153 155 greenstone3/web/sites 154 156 & Contains directories for different sites---a site is a set of collections and services served by a single MessageRouter (MR). The MR may have connections (e.g. soap) to other sites\\ … … 169 171 greenstone3/web/interfaces/default/transforms 170 172 & The XSLT files for the default interface\\ 173 greenstone3/web/applet 174 & jar files needed by applets can go here \\ 171 175 \hline 172 176 \end{tabular}} … … 233 237 Figure~\ref{fig:siteconfig} shows two example site configuration files. The first example is for a rudimentary site with no site-wide services, 234 238 which does not connect to any external sites. The second example is for a site with one site-wide service cluster - a collection building cluster. It also connects to the first site using SOAP. 235 These two sites happen to be running on the same machine, which is why they can use \gst{localhost} in the address. For site \gst{gsdl1} to talk to site \gst{localsite}, a SOAP server must be run for \gst{localsite}. The address of the SOAP server, in this case, is \gst{http://localhost:8080/ soap/servlet/rpcrouter}.239 These two sites happen to be running on the same machine, which is why they can use \gst{localhost} in the address. For site \gst{gsdl1} to talk to site \gst{localsite}, a SOAP server must be run for \gst{localsite}. The address of the SOAP server, in this case, is \gst{http://localhost:8080/greenstone3/services/localsite}. 236 240 237 241 … … 265 269 <siteList> 266 270 <site name="org.greenstone.localsite" 267 address="http://localhost:8080/ soap/servlet/rpcrouter"271 address="http://localhost:8080/greenstone3/services/localsite" 268 272 type="soap"/> 269 273 </siteList> … … 1100 1104 <siteList> 1101 1105 <site name='org.greenstone.gsdl1' 1102 address='http://localhost:8080/ soap/servlet/rpcrouter'1106 address='http://localhost:8080/greenstone3/services/localsite' 1103 1107 type='soap' /> 1104 1108 </siteList> … … 2213 2217 Greenstone is built and installed using Ant (Apache's Java based build tool, 2214 2218 http://ant.apache.org). You will need a Java Development 2215 Environment (1.4 or higher), and Ant installed to use Greenstone. You can download Ant from http://ant.apache.org/bindownload.cgi.2219 Environment (1.4 or higher), and Ant installed to use Greenstone. You can download Ant from \\\gst{http://ant.apache.org/bindownload.cgi}. 2216 2220 2217 2221 In the greenstone3 directory, you can run 'ant' which will give you a help message. … … 2228 2232 ant -Dproperties.accepted=yes -logfile build.log install 2229 2233 2230 Under Linux, Java and C/C++ compilation is carried out. For windows, since Visual Studio is not a standard component, only Java compilation is carried out. Pre-compiled binaries are provided for the C/C++ components ( packages and Greenstone 2 style building). If you have Visual Studio installed (version 6), you can run the compile-windows-c++ targets to compile the code locally. (Don't forget to setup the Visual Studio environment first, by running, e.g. C:/Program Files/Microsoft Visual Studio/VC98/Bin/VCVARS32.BAT or equivalent.)2234 Under Linux, Java and C/C++ compilation is carried out. For windows, since Visual Studio is not a standard component, only Java compilation is carried out. Pre-compiled binaries are provided for the C/C++ components (source packages and Greenstone 2 style building). If you have Visual Studio installed (version 6), you can run the compile-windows-c++ targets to compile the code locally. (Don't forget to setup the Visual Studio environment first, by running, e.g. C:/Program Files/Microsoft Visual Studio/VC98/Bin/VCVARS32.BAT or equivalent.) 2231 2235 2232 2236 … … 2247 2251 Tomcat is a servlet container, and Greenstone 3 runs as a servlet inside it. 2248 2252 2249 The file \gst{\gsdlhome/ comms/jakarta/tomcat/conf/server.xml} is the Tomcat configuration file. The installation process adds a context for \gsiii\ servlets (\gst{\gsdlhome/web})---this tells Tomcat where to find the web.xml file, and what URL (\gst{/greenstone3}) to give it. Anything inside the context directory is accessible via Tomcat\footnote{can we use .htaccess files to restrict access??}. For example, the index.html file that lives in \gst{\gsdlhome/web} can be accessed through the URL \gst{localhost:8080/greenstone3/index.html}. The demo collection's images can be accessed through \\2253 The file \gst{\gsdlhome/packages/tomcat/conf/server.xml} is the Tomcat configuration file. The installation process adds a context for \gsiii\ servlets (\gst{\gsdlhome/web})---this tells Tomcat where to find the web.xml file, and what URL (\gst{/greenstone3}) to give it. Anything inside the context directory is accessible via Tomcat\footnote{can we use .htaccess files to restrict access??}. For example, the index.html file that lives in \gst{\gsdlhome/web} can be accessed through the URL \gst{localhost:8080/greenstone3/index.html}. The demo collection's images can be accessed through \\ 2250 2254 \gst{localhost:8080/greenstone3/sites/localsite/collect/demo/images/}. 2251 2255 … … 2257 2261 \begin{gsc} 2258 2262 \item \gsdlhome/web/WEB-INF/web.xml 2259 \item \gsdlhome/ comms/jakarta/tomcat/conf/server.xml2263 \item \gsdlhome/packages/tomcat/conf/server.xml 2260 2264 \end{gsc} 2261 2265 \item any classes or jar files used by the servlets 2262 2266 \end{bulletedlist} 2263 2267 \noindent Note: stdin and stdout for the servlets (on linux) both go to\\ 2264 \gst{\gsdlhome/ comms/jakarta/tomcat/logs/catalina.out}2268 \gst{\gsdlhome/packages/tomcat/logs/catalina.out} 2265 2269 2266 2270 On startup, the servlet loads in its collections and services. If the site or collection configuration files are changed, these changes will not take effect until the site/collection is reloaded. This can be done through the reconfiguration messages (see Section~\ref{sec:runtime-config}), or by restarting Tomcat. 2267 2271 2268 We have set up Tomcat to follow symlinks. To disable this feature, remove the \gst{<Resources>} element from the greenstone3 context in \\\gst{\$GSDL3HOME/ comms/jakarta/tomcat/conf/server.xml}:2272 We have set up Tomcat to follow symlinks. To disable this feature, remove the \gst{<Resources>} element from the greenstone3 context in \\\gst{\$GSDL3HOME/packages/tomcat/conf/server.xml}: 2269 2273 2270 2274 \begin{quote}\begin{gsc} … … 2275 2279 \end{gsc}\end{quote} 2276 2280 2277 By default, Tomcat allows directory listings. To disable this, change the 'listings' paramter to false in the default servlet definition, in Tomcat's web.xml file (\gst{\$GSDL3HOME/ comms/jakarta/tomcat/conf/web.xml}):2281 By default, Tomcat allows directory listings. To disable this, change the 'listings' paramter to false in the default servlet definition, in Tomcat's web.xml file (\gst{\$GSDL3HOME/packages/tomcat/conf/web.xml}): 2278 2282 2279 2283 We have set the greenstone context to be reloadable. This means that if a class or resource file in web/WEB-INF/lib or web/WEB-INF/classes changes, the servlet will be reloaded. This is useful for development, but should be turned off for production mode (set the reloadable attribute to false). 2280 2284 2281 2285 Tomcat uses a Manager to handle HTTP session information. This may be stored between restarts if possible. To use a persistent session handling manager, uncomment the \gst{<Manager>} element in \\ 2282 \gst{\$GSDL3HOME/ comms/jakarta/tomcat/conf/server.xml}. For the default manager, session information is stored in the work directory:\\2283 \gst{\$GSDL3HOME/ comms/jakarta/tomcat/work/Standalone/localhost/greenstone3/SESSIONS.ser}. Delete this file to clear the cached session info. Note that Tomcat needs to be shutdown to delete this file.2286 \gst{\$GSDL3HOME/packages/tomcat/conf/server.xml}. For the default manager, session information is stored in the work directory:\\ 2287 \gst{\$GSDL3HOME/packages/tomcat/work/Standalone/localhost/greenstone3/SESSIONS.ser}. Delete this file to clear the cached session info. Note that Tomcat needs to be shutdown to delete this file. 2284 2288 2285 2289 \subsection{Proxying Tomcat with apache} … … 2322 2326 To run it, type: 2323 2327 2324 \begin{quote}\gst{java -cp <path to greenstone3>/comms/soap/axis/lib/axis.jar \\2328 \begin{quote}\gst{java -cp \$GSDL3HOME/web/WEB-INF/lib/axis.jar \\ 2325 2329 org.apache.axis.utils.tcpmon} 2326 2330 \end{quote}
Note:
See TracChangeset
for help on using the changeset viewer.