diff doc/admin-manual/installation-webclient.tex @ 921:fb1e051713cc

Improved artifact, webclient and operations section doc/trunk@1058 c6561f87-3c4e-4783-a992-168aeb5c3f6f
author Hans Plum <hans.plum@intevation.de>
date Wed, 05 May 2010 10:07:24 +0000
parents 1ebde13e620f
children 237f3a809aee
line wrap: on
line diff
--- a/doc/admin-manual/installation-webclient.tex	Tue May 04 14:10:35 2010 +0000
+++ b/doc/admin-manual/installation-webclient.tex	Wed May 05 10:07:24 2010 +0000
@@ -1,41 +1,63 @@
 \subsection{GNV-WebClient}
-- Aim/Task
+The last step of the installationprcess is to install the WebClient called
+GNV-Client. The GNV-Client is a web Application ARchive (WAR) which has to be published
+via Apache Tomcat.
 
-The last step of the Installationprcess ist to install the Webfrontent called
-GNV-Client.
-the GNV-Client is a Web application ARchive (WAR) which have to be published
-using the Tomcat Applicationserver whe was installed in Section ??? FIXME.
 
 \subsubsection*{Installation}
-Copy the File gnv.war into /usr/share/tomcat5.5/webapps/
-* cp gnv.war /usr/share/tomcat5.5/webapps/
 
-If the Server does not publish the new Archive automatically you have to restart
-the Server.
+Make sure, the Apache Tomcat is stopped. Deploying the WAR-file:
+\begin{lstlisting}
+  cp -i gnv-\$VERSION.war /usr/share/tomcat5.5/webapps/gnv.war
+  # Start Tomcat:
+  /etc/init.d/tomcat5.5 start
+\end{lstlisting}
 
-* /etc/init.d/tomcat5.5 restart
 
 \subsubsection*{Configuration}
+\label{ref:webclient-config}
 
-FIXME: How to adapt the address/port of connection to REST-server.
+As default, the GNV-Client looks for an artifact-server running on
+\verb+ http://localhost:8181/+. If this address needs not to be changed,
+there is nothing to do to considering the execution environment.
 
-There is nothing to customize consider the execution Environment.
+If the address of the artifact-server has been changed (c.f.
+chapter~\ref{}, p.\pageref{}), it can be adapted in the file
+\verb+ WEB-INF/web.xml+ for the parameter name 
+\verb+de.intevation.gnv.artifactdatabase.client.ArtifactDatabase.url.1+.
+
+As default log information is written into the file
+\verb+/usr/share/tomcat5.5/logs/gnv.log+. The log level can be adjusted
+in the file \verb+WEB-INF/classes/log4j.properties+. For further
+instructions look into the file.
+
+{\em Hint: The changes need to be done within the compressed
+war-file because of the deployment mechanism of Apache Tomcat in case of
+a restart. Keep in mind to repackage the war-file for a solution
+surveiving a restart of Tomcat.}
+
 
 \subsubsection*{Test of the Installation}
 
-You are able to test the Installation by executing the following URl
-
-* curl http://localhost/gnv/version.do | grep Version
-
-The Response should include the Version of the GNV-Client.
+Testing the installation via Apache WebServer, mod\_jk and Apache Tomcat:
+\begin{lstlisting}
+  wget http://localhost/gnv/ -O gnv
+\end{lstlisting}
 
-\subsubsection*{Uninstall the GNV-Client}
-To uninstall teh GNV-Client you only have to remove the war-Archive.
-
-* rm /usr/share/tomcat5.5/webapps/gnv.war
+The file \verb+gnv+ includes HTML describing the startpage of the
+GNV-WebClient.
 
-The Tomcat Application Server should undeploy /remove the Application automatically.
+\subsubsection*{Uninstall the GNV-WebClient}
+To uninstall the GNV-Client, the war-Archive can be removed.
+\begin{lstlisting}
+  rm /usr/share/tomcat5.5/webapps/gnv.war
+\end{lstlisting}
 
-If not you can execute the following command aditional
+The Tomcat application server should undeploy /remove the application
+automatically. If not, execute the following commands additionally:
 
-* rm -rf /usr/share/tomcat5.5/webapps/gnv
+\begin{lstlisting}
+  /etc/init.d/tomcat5.5 stop
+  rm -rf /usr/share/tomcat5.5/webapps/gnv
+  /etc/init.d/tomcat5.5 start
+\end{lstlisting}

http://dive4elements.wald.intevation.org