changeset 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 (2010-05-05)
parents 63bc0044ff72
children 237f3a809aee
files doc/ChangeLog doc/admin-manual/installation-admin-manual.tex doc/admin-manual/installation-artefact-server.tex doc/admin-manual/installation-base.tex doc/admin-manual/installation-webclient.tex doc/admin-manual/operating-the-system.tex doc/admin-manual/overview.tex
diffstat 7 files changed, 304 insertions(+), 192 deletions(-) [+]
line wrap: on
line diff
--- a/doc/ChangeLog	Tue May 04 14:10:35 2010 +0000
+++ b/doc/ChangeLog	Wed May 05 10:07:24 2010 +0000
@@ -1,3 +1,14 @@
+2010-05-05  Hans Plum <hans@intevation.de>
+
+	* admin-manual/installation-admin-manual.tex,
+	admin-manual/overview.tex,
+	admin-manual/operating-the-system.tex,
+	admin-manual/installation-base.tex,
+	admin-manual/installation-webclient.tex,
+	admin-manual/installation-artefact-server.tex:
+	Improving artifact, webclient and operation section. Added hyperref
+	package.
+
 2010-05-04  Tim Englich <tim@intevation.de>
 	* config-manual/model_of_transitions.tex:
 	Fixed some typos. Do some document-styling.
--- a/doc/admin-manual/installation-admin-manual.tex	Tue May 04 14:10:35 2010 +0000
+++ b/doc/admin-manual/installation-admin-manual.tex	Wed May 05 10:07:24 2010 +0000
@@ -17,7 +17,8 @@
 \usepackage{lastpage}
 %\usepackage{proposal}
 \usepackage{listings}
-% FIXME hyperref config
+\usepackage[hyperindex=true, bookmarks=true, breaklinks=true,
+colorlinks=true, linkcolor=red,bookmarksopen]{hyperref}
 
 %----------------------------------------------
 % Document DATE and VERSION
--- a/doc/admin-manual/installation-artefact-server.tex	Tue May 04 14:10:35 2010 +0000
+++ b/doc/admin-manual/installation-artefact-server.tex	Wed May 05 10:07:24 2010 +0000
@@ -1,11 +1,19 @@
 \subsection{Artifact-Server}
-Aim/Task: see above
+The Artifact-Server contains the entire business logic of the system.
+The server provides a RESTful interface with a XML-based protocol to the
+webclient. Technically the server is a standalone java process serving the
+REST interface.
 
 \subsubsection*{Installation}
-Running the server with its own user: 
-  \verb+ # adduser artifacts+
+\label{ref:artifact-server-install}
 
-Prepare infrastructure for logging
+Running the server with its own user\footnote{Remark: A group with the
+same name is created automatically.}: 
+\begin{lstlisting}
+  adduser artifacts
+\end{lstlisting}
+
+Setup and configuring logging:
 \begin{lstlisting}
   cd /var/log
   mkdir artifacts
@@ -13,80 +21,120 @@
   chmod g+s artifacts
 \end{lstlisting}
 
-Integrate software of artefact-server into filesystem
+The log level can be adjusted in the file \verb+ conf/log4j.properties+.
+Further information can be found there.
+
+Integrate software of artifact-server into filesystem:
+\begin{lstlisting}
   cd /opt
-  tar xfvj /root/artifact-server-\$VERSION.tar.bz2
-  ln -s artifact-server-\$VERSION artifact-server
+  tar xfvj /root/artifact-server-$VERSION.tar.bz2
+  ln -s artifact-server-$VERSION artifact-server
   cd artifact-server
+\end{lstlisting}
 
-Setting the access rights
+Setting the access rights:
+\begin{lstlisting}
    bin/setup.sh
+\end{lstlisting}
 
-Configure connection to database
+Configure connection to database:
+\begin{lstlisting}
   cd /opt/artefact-server
   vim conf/arcsdeconnectionpool.properties
   
-  in conf/arcsdeconnectionpool.properties do:
-  \begin{lstlisting}
+  # in conf/arcsdeconnectionpool.properties do:
   server=xyz.server.com
   username=guest
   credentials=XYZ
   port=5151
   database=esri_sde
-  \end{lstlisting}
+\end{lstlisting}
 
-Configure address for finding the WMS-Server
-% FIXME
+Configure address for finding the WMS-Server:
+\begin{lstlisting}
+  cd /opt/artefact-server/
+  vim conf/conf.xml
+  # adapt the address in the element
+  # artifact-database/gnv/mapserver/server. This is
+  # the string the server uses to provide an address of the mapserver to enduser.
+  e.g. http://SERVER/cgi-bin/gnv-wrapper
+\end{lstlisting}
 
-Configure secret for signing artifacts
-% FIXME
+The artifact server can export and import projects of the user's
+parameterizations. In order to protect the server against invalid files,
+configure a secret for signing artifacts.
 
-Adapt TCP-port of artefact-server
+{\em Hint: If the secret is changed, all files that were created before
+are not valid anymore.}
+
+\begin{lstlisting}
+  # generate a randomized string, e.g.
+  cd /opt/artefact-server/
+  pwgen -s 30
+  # populate the tag artifact-database/export-secret
+\end{lstlisting}
+
+Adapt TCP-port of artefact-server, if the default has to be changed
+(default:8181):
+\begin{lstlisting}
   cd /opt/artefact-server
   vim conf/conf.xml
   
-  in conf.conf.xml:
-  adapt value of the element \verb+ rest-server/port+ (default: 8181)
+  # in conf/conf.xml edit the element artifact-database/rest-server/port
+\end{lstlisting}
 
-Integrate Artefact-Server in Init-Process of Operating System
-  mv /opt/artefact-server/bin/debian/artefact-server /etc/init.d/
-  cd /etc/init.d
-  chmod +x artifact-server
+Integrate artifact-server in startup-process of operating system:
+\begin{lstlisting}
+  cp -i /opt/artefact-server/bin/debian/artifact-server /etc/init.d/
+  chmod +x /etc/init.d/artifact-server
   update-rc.d artifact-server defaults
+\end{lstlisting}
 
-FIXME: Setting up credential for signing project files.
+The server can be started and stopped via
+\begin{lstlisting}
+  /etc/init.d/artifact-server {start | stop}
+\end{lstlisting}
 
-The installation of the artefact-server is finished. It can be tested
+The installation of the artifact-server is finished. It can be tested
 now.
 
 \subsubsection*{Test of the Installation}
+\label{ref:artifact-server-testing}
   Start the server:
+  \begin{lstlisting}
   /etc/init.d/artefact-server start
+  \end{lstlisting}
   
-  1. Operating System: Check if the process of the server is running
-  \verb+jps+
+  1. Operating System: Check if the process of the server called "App"
+  is running:
+  \begin{lstlisting}
+  jps
   
-  list of java processes:
-  \begin{lstlisting}
+  # Example with list of java processes:
   19252
   19509 Jps
   19441 App
+
+  cat /var/run/artefact-server
   \end{lstlisting}
 
-  \verb+ cat /var/run/artefact-server+
-
-  Task: Compare the running process numbers
+  Task: Compare the running process numbers.
 
   2. Network: Check if the artefact-server opens a TCP-port (default: 8181)
+  \begin{lstlisting}
   netstat -nltp
   
-  Check for an entry like
-  tcp        0      0 127.0.0.1:8181          0.0.0.0:*  LISTEN      18648/java
+  # Check for an entry like:
+  tcp        0      0 127.0.0.1:8181          0.0.0.0:*  LISTEN 18648/java
+  \end{lstlisting}
 
-  3. Artefact-Server ready for communication with client
+  3. Artefact-Server ready for communication with client?
+  \begin{lstlisting}
   wget -qO- http://localhost:8181/factories
+  \end{lstlisting}
   
-  Task: Check for a XML-document describing a possible FIS
+  Task: Check for a XML-document describing possible expert information
+  systems (FIS)
 
 
 \subsubsection*{Deinstallation}
--- a/doc/admin-manual/installation-base.tex	Tue May 04 14:10:35 2010 +0000
+++ b/doc/admin-manual/installation-base.tex	Wed May 05 10:07:24 2010 +0000
@@ -8,7 +8,8 @@
 rights} is needed.  If other permissions are needed, there will be a
 hint in this manual.
 
-% FIXME: Schreibweise bei Zeilen + und -
+If existing configurations have to be changed, the following notation will be used:
+\verb|+| for adding a line replacing the marked by \verb|-|.
 
 \subsection{Preconditions}
 
@@ -87,9 +88,11 @@
 For a better support of the native server technologies, the package
 \verb+libtcnative+ can be installed.
 
-\verb+ apt-get install libtcnative-1+
-
-% FIXME: Setzen des softlink
+\begin{lstlisting}
+  apt-get install libtcnative-1
+  cd /usr/lib/jvm/java-6-sun/jre/lib/i386/client
+  ln -s /usr/lib/libtcnative-1.so
+\end{lstlisting}
 
 \subsubsection*{Configuration}
 
@@ -150,9 +153,8 @@
 To install the Tomcat Application-Server and its dependencies, execute:
 
 \verb+ apt-get install tomcat5.5+
-% FIXME: check for depencenies
 
-\subsubsection{Configuration}
+\subsubsection*{Configuration}
 
 Adapt some run-time specific properties in
 \verb+/etc/default/tomcat5.5+:
@@ -217,142 +219,138 @@
 
 \subsection{Apache Webserver}
 This section describes the required steps for the installation and configuration 
-of the Apache Webserver Version 2.2.
+of the Apache Webserver Version 2.2. Apache WebServer controls all
+HTTP-Connections to the outside of the system. Apache Tomcat is
+integrated via mod\_jk.
 
 \subsubsection*{Installation}
 
 To install the Apache Webserver you have to execute the following command:
 
-* apt-get install apache2
-
-- Additional Modules
-To establish the Connection between the Tomcat Application Server and the 
-Apache Webserver we have to install an additional Module named Mod-JK
+\verb+ apt-get install apache2+
 
-* apt-get install libapache2-mod-jk
-
-- Configuration
+To establish the connection between the Tomcat application server and
+Apache Webserver an additional Module "mod\_jk" has to be installed.
 
--- Edit the Settings for mod-jk
+\verb+ apt-get install libapache2-mod-jk+
 
-Edit the Settings for mod-jk in File /etc/libapache2-mod-jk/workers.propertie
-as follows:
+\subsubsection*{Configuring mod\_jk}
+
+Edit the settings for mod\_jk in
+file \verb+ /etc/libapache2-mod-jk/workers.properties+:
+
 
 \begin{lstlisting}
   - workers.java_home= /usr/lib/jvm/java-gcj/
   + workers.java_home=/usr/lib/jvm/java-6-sun
 \end{lstlisting}
 
--- Enable mod-jk in Apache Webserver
-
-For this add the follwing Lines to File /etc/apache2/httpd.conf:
+In file \verb+ /etc/apache2/httpd.conf+:
 
 \begin{lstlisting}
   + JkWorkersFile "/etc/libapache2-mod-jk/workers.properties"
   + JkLogFile "/var/log/mod_jk.log"
 \end{lstlisting}
 
---Disable default Site of Apache Webserver
-
-* a2dissite default
-
---Enable the specific Site of GNV
+After finishing the configuration, enable the module in Apache
+WebServer: \verb+ a2enmod jk+ and restart the server 
+\verb+ /etc/init.d/apache restart+.
 
-* Copy File FIXME/gnv to /etc/apache2/sites-available
-
-%FIXME: Configure contact address for Webserver
 
-* a2ensite gnv
+\subsubsection*{Publish the site in Apache WebServer}
 
---Reload the Configuration of Apache Webserver
+Depending of the existing configuration of Apache WebServer, the
+following steps can differ. In this case, a vanilla configuration is
+assumed.
 
-* /etc/init.d/apache2 reload
+Disable default configuration
+\verb+ a2dissite default+
+
+Adapt eMail-address for configuration in 
+\verb+ $ARTIFACT_SERVER_HOME/install/debian/apache2/gnv+.
+
+Enable the specific site (VirtualHost) in Apache WebServer:
+\begin{lstlisting}
+  cp -i $ARTIFACT_SERVER_HOME/install/debian/apache2 to /etc/apache2/sites-available
+  # Activate site for GNV
+  a2ensite gnv
+  /etc/init.d/apache reload
+\end{lstlisting}
+
 
 \subsubsection*{Test of the Installation}
 
-You can test the Installation by executing the follwing url
+You can test the installation by executing the following url:
 
-* http://localhost/gnv/start.do
+\verb+ wget http://localhost/gnv/ -O test+
+
+After a successful installation, the file {test} will contain HTML describing
+the startpage of the GNV WebClient.
 
 
 \subsubsection*{Uninstalling the Apache Webserver}
-
-To uninstall the Apache Webserver you can use the following Command:
-* apt-get --purge remove apache2
-
-
-\subsection{Installation of UMN MapServer}
-
-\subsubsection*{Installation}
--- Remove the installed old mapserver-Version from the System
-
-* apt-get remove cgi-mapserve
-
--- Installing required Libraries
-
-* apt-get install ttf-freefont
-* apt-get install libming0 libfribidi0
+To uninstall the Apache Webserver and its configuration, you can use the
+following command:
+\verb+ apt-get purge apache2+
 
 
--- Installing mapserver-gp
-
-At first you have to configure the source for the Gispatcher-server where
-the Mapserverpackes are hosted by the Intevation.
-For this we have to add the followin line to File /etc/apt/sources.list
-
-  deb http://apt.gispatcher.com/ lenny gispatcher
-
-Then it is necessary to import the Key which is used to sign the Packages:
+\subsection{UMN MapServer: Installation and configuration}
+The UMN MapServer is part of the artifact server. It is responsible for
+rendering shapefiles produced by the artifact-server and publish them as
+OGC Web Map Service.
 
-  TODO: gpg --keyserver hkp://keys.gnupg.net --recv-keys EC70B1B8
-  TODO: gpg --export EC70B1B8 | apt-key add -
-
-Then install the mapserver-gp executing the follwong command
+\subsubsection*{Installation}
+It is recommended to use a more recent version than the one in Debian
+Lenny. In the installation package, there is a debian package of
+MapServer that should be installed.
 
-* apt-get install cgi-mapserv-gp
-
--- Installing mapserv-gp withou access to the Internet
-
-If there is no access to the Internet it is possible to install the Mapserver
-manually.
-For this do the following steps:
+In order to verify the integrity of the installation package, it is necessary to import 
+a GPG-Key which was used to sign the packages:
 
 \begin{lstlisting}
-* Copy the Packages of mapserver-gp via scp onto the Server
-* http://apt.gispatcher.com/dists/lenny/gispatcher/binary-i386/cgi-mapserver-gp_5.6.3-1~gp+1_i386.deb 
-* dpkg -i cgi-mapserver-gp_5.6.3-1~gp+1_i386.deb
+gpg --keyserver hkp://keys.gnupg.net --recv-keys EC70B1B8
+gpg --export EC70B1B8 | apt-key add -
 \end{lstlisting}
 
--- Make the Wrapper-Script available
-
-To use the UMN-Mapserver without putting the Mapfile-Path into each URL it is
-possible to use a Script which will do that.
+Installing the mapserver-gp and its dependencies, executing the following command:
 
-For this you have to copy TODO FIXME to /usr/lib/cgi-bin
-
-You also have to edit the Script and set the PATH where the Mapfile is stored
-by the Artifact-Server into the Script.
 \begin{lstlisting}
-- export MS_MAPFILE=/opt/artifacts/mapfiles/mapfile.map
-+ export MS_MAPFILE=/opt/artefact-server/mapfiles/mapfile.map // TODO FIXME
+cd $ARTIFACT_SERVER_HOME/install/debian/umn-mapserver
+dpkg -i cgi-mapserver-gp_5.6.3-1~gp+1_i386.deb
 \end{lstlisting}
 
-%FIXME ERROR_LOGGING
+Provide a possibility to integrate MapServer properly and transfer
+configurations to MapServer during runtime:
 
-% FIXME: Adapting contact data
+\begin{lstlisting}
+cd /usr/lib/cgi-bin
+cp -i $ARTIFACT_SERVER_HOME/install/debian/umn-mapserver/gnv-wrapper .
+\end{lstlisting}
+
+For setting proper contact details in the WMS Capabilities response,
+edit the file \verb+ $ARTIFACT_SERVER_HOME/conf/maptemplates/mapfile.vm+
+in the section WEB > METADATA.
 
 \subsubsection*{Test of installation}
-You can chack if the Installation was sucsessful executing the following URl:
-
-* curl http://localhost/cgi-bin/mapserv-gp
-
-The response should look like this:
+Check for a sucessful installation via:
 
-No query information to decode. \verb+QUERY_STRING+ is set, but empty.
-
-\subsubsection*{Uninstall UMN- Mapserver}
+\begin{lstlisting}
+cd root
+wget \
+"http://localhost/cgi-bin/gnv-wrapper?service=WMS&request=GetCapabilities&version=1.1.1" \
+-O mapserver
+\end{lstlisting}
 
-To uninstall the UMN-mapserver you have to execute the following commands.
+For a sucessful configuration, the response document \verb+ mapserver+
+contains a XML document describing the capabilities of the mapserver.
 
-* rm TODO FIXME wrapperscript
-*  apt-get --purge remove cgi-mapserv-gp
+
+\subsubsection*{Un-installing UMN- Mapserver}
+
+To uninstall the UMN-mapserver without its dependencies, execute the following:
+
+\begin{lstlisting}
+cd /usr/lib/cgi-bin
+rm -i gnv-wrapper
+apt-get purge cgi-mapserv-gp
+\end{lstlisting}
--- 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}
--- a/doc/admin-manual/operating-the-system.tex	Tue May 04 14:10:35 2010 +0000
+++ b/doc/admin-manual/operating-the-system.tex	Wed May 05 10:07:24 2010 +0000
@@ -1,51 +1,62 @@
 \section{Management of operational processes}
 
-Availability of the components
-  1. Database server 
-  2. Artefact-server
-  3. Apache Tomcat running the WebClient
-  4. Apache WebServer
+For running the entire GNV-system the following components have to be
+available in the described sequence:
+\begin{enumerate}
+  \item Database server 
+  \item Artefact-server
+  \item Apache Tomcat running the WebClient
+  \item Apache WebServer
+\end{enumerate}
 
 During a server startup the installed components get started
 automatically.
 
-\subsection{Managing the Artefact Server}
+\subsection{Managing the Artifact Server}
 
-\subsubsection*{Start Stop Restart}
+\subsubsection*{Starting and Stopping}
 
-The artefact server can be restarted without stopping the WebClient.
+The artifact-server can be restarted without stopping the WebClient.
 During the restart-process client accessing the server get an approriate
 message. Their session data will not be lost if the artefact database
 will remain untouched.
 
-  Stopping artefact server
-  \verb+ /etc/init.d/artefact-server stop+
+  Stopping artifact-server:
+  \begin{lstlisting}
+  /etc/init.d/artefact-server stop
+  \end{lstlisting}
 
-  Starting artefact server
-  \verb+ /etc/init.d/artefact-server start+
-
-  Restarting artefact server
-  \verb+ /etc/init.d/artefact-server restart+
+  Starting artifact server
+  \begin{lstlisting}
+  /etc/init.d/artefact-server start
+  \end{lstlisting}
+  
+  Restarting artifact server
+  \begin{lstlisting}
+  /etc/init.d/artefact-server restart
+  \end{lstlisting}
 
 \subsubsection*{Monitoring the System}
 
-C.f. Testing the installation for the levels: operating system,
-network and service availability
+C.f. Chapter~\ref{ref:artifact-server-testing},
+p.~\pageref{ref:artifact-server-testing} for testing the installation on
+different levels: operating system, network and service availability.
 
 \subsubsection*{Troubleshooting}
 
-Database problems
-For checking problems for problems with the connection to the database
-server, check the logfile of the artefact-server (c.f. FIXME
-installation) look for entries like FIXME.
+\paragraph*{Database problems}
+For checking problems with the connection to the database server, check
+the logfile of the artifact-server (c.f.
+chapter~\chapter{ref:artifact-server-install},
+p.~pageref{ref:artifact-server-install}.
 
-In most cases, a restart of the artefact-server will help to solve
-problems in the artefact-server. If you still encounter problems, check
+In most cases, a restart of the artifact-server will help to solve
+problems in the artifact-server. If you still encounter problems, check
 for the network connection to the database server and the maturity of
 the database server.
 
-
-Inconsistencies between original data and cached data
+\paragraph*{Caching problems}
+Inconsistencies between original data and cached data:
 The artefact-server stores result sets of the database in a cache and
 provides maps via configuration files for MapServer based on shapefiles.
 In case of inconsistencies showing up for longer than twice the
@@ -54,7 +65,7 @@
 
 \begin{lstlisting}
   /etc/init.d/artefact-server stop
-  rm -ri \$ARTEFACT-SERVER-HOME/cache/*
+  rm -ri $ARTEFACT-SERVER-HOME/cache/*
   /etc/init.d/artefact-server start
 \end{lstlisting}
 
@@ -64,16 +75,24 @@
 The GNV-WebClient can be managed by controlling Apache Tomcat instance:
 
  Status GNV-WebClient
- \verb+ /etc/init.d/tomcat5.5 status+
+ \begin{lstlisting}
+   /etc/init.d/tomcat5.5 status
+ \end{lstlisting}
 
  Stopping GNV-WebClient
- \verb+ /etc/init.d/tomcat5.5 stop+
+ \begin{lstlisting}
+   /etc/init.d/tomcat5.5 stop
+ \end{lstlisting}
 
  Starting GNV-WebClient
- \verb+ /etc/init.d/tomcat5.5 start+
+ \begin{lstlisting}
+   /etc/init.d/tomcat5.5 start
+ \end{lstlisting}
 
  Restarting GNV-WebClient
- \verb+ /etc/init.d/tomcat5.5 restart+
+ \begin{lstlisting}
+   /etc/init.d/tomcat5.5 restart
+ \end{lstlisting}
 
 \subsubsection*{Monitoring the System}
 
@@ -81,14 +100,17 @@
 
 \subsubsection*{Troubleshooting}
 
-The GNV-WebClient can not accessed through the Apache WebServer, do the
+If the GNV-WebClient can not be accessed through the Apache WebServer, do the
 following:
-1. \verb+ /etc/init.d/apache2 restart+
-2. Check in your browser at \verb+ http://\$SERVERNAME/gnv+
+\begin{lstlisting}
+  1. /etc/init.d/apache2 restart
+  2. Check in your browser at http://$SERVERNAME/gnv
+\end{lstlisting}
 
 If you still encounter problems, follow the next these steps:
+
 {\bf Caution: The entire application will be down until the WebServer is
-back up}
+back up.}
 \begin{lstlisting}
   /etc/init.d/apache2 stop
   /etc/init.d/tomcat5.5 stop
@@ -97,18 +119,22 @@
   /etc/init.d/apache2 start
 \end{lstlisting}
 
-For further information, you look into the Logging during the use of the
+For further information, you look into the log information during the use of the
 GNV WebClient
-\verb+ tail -f -n 50 /usr/share/tomcat5.5/logs/gnv.log+
+\begin{lstlisting}
+  tail -f -n 50 /usr/share/tomcat5.5/logs/gnv.log
+\end{lstlisting}
 
 To get even more logging, do the following:
 
 {\bf Caution: The entire application will be down until the Apache Tomcat
-has started properly; the higher log-level can affect the
-runtime-behaviour of the client}
+has been started properly; the higher log-level can affect the
+runtime-behaviour of the client. For further instructions, c.f.
+Chapter~\ref{ref:webclient-config}, p.~\pageref{ref:webclient-config}.}
+
 \begin{lstlisting}
   /etc/init.d/tomcat5.5 stop
-  Set logging to DEBUG (FIXME)
+  Set logging to DEBUG 
   vim /usr/share/tomcat5.5/webapps/gnv/WEB-INF/classes/log4j.properties
   /etc/init.d/tomcat5.5 start # wait until tomcat is up
   tail -f -n 50 /usr/share/tomcat5.5/logs/gnv.log
@@ -118,6 +144,5 @@
 part has been found.
 
 \section{Lists of References}
-FIXME
+%% TODO: List of references
 
-FIXME: How to adapt the address/port of connection to REST-server.E
--- a/doc/admin-manual/overview.tex	Tue May 04 14:10:35 2010 +0000
+++ b/doc/admin-manual/overview.tex	Wed May 05 10:07:24 2010 +0000
@@ -3,7 +3,7 @@
 The GNV systems consists of the mainly 4 components, serving the
 following tasks:
 
-% FIXME: Add architecture of the system in english
+% TODO: Add architecture of the system in english
 
 \begin{enumerate}
 \item Artefact-Server

http://dive4elements.wald.intevation.org