diff doc/admin-manual/installation-base.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-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}

http://dive4elements.wald.intevation.org