annotate doc/admin-manual/installation-webclient.tex @ 937:052b8bba4f41

Add first part of Documentation of the Sections of conf.xml doc/trunk@1078 c6561f87-3c4e-4783-a992-168aeb5c3f6f
author Tim Englich <tim.englich@intevation.de>
date Fri, 07 May 2010 10:19:28 +0000
parents 9d94bf77e442
children 17c3770e6c63
rev   line source
901
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
1 \subsection{GNV-WebClient}
921
fb1e051713cc Improved artifact, webclient and operations section
Hans Plum <hans.plum@intevation.de>
parents: 901
diff changeset
2 The last step of the installationprcess is to install the WebClient called
fb1e051713cc Improved artifact, webclient and operations section
Hans Plum <hans.plum@intevation.de>
parents: 901
diff changeset
3 GNV-Client. The GNV-Client is a web Application ARchive (WAR) which has to be published
fb1e051713cc Improved artifact, webclient and operations section
Hans Plum <hans.plum@intevation.de>
parents: 901
diff changeset
4 via Apache Tomcat.
901
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
5
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
6
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
7 \subsubsection*{Installation}
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
8
924
9d94bf77e442 Finalized documentation with references, unifying tools, adding logos.
Hans Plum <hans.plum@intevation.de>
parents: 922
diff changeset
9 Make sure, the Apache Tomcat is stopped. Deploying the
9d94bf77e442 Finalized documentation with references, unifying tools, adding logos.
Hans Plum <hans.plum@intevation.de>
parents: 922
diff changeset
10 WAR-file\footnote{There are several ways of deployment in Apache Tomcat.
9d94bf77e442 Finalized documentation with references, unifying tools, adding logos.
Hans Plum <hans.plum@intevation.de>
parents: 922
diff changeset
11 Background information can be found at
9d94bf77e442 Finalized documentation with references, unifying tools, adding logos.
Hans Plum <hans.plum@intevation.de>
parents: 922
diff changeset
12 \url{http://tomcat.apache.org/tomcat-5.5-doc/deployer-howto.html}}:
921
fb1e051713cc Improved artifact, webclient and operations section
Hans Plum <hans.plum@intevation.de>
parents: 901
diff changeset
13 \begin{lstlisting}
fb1e051713cc Improved artifact, webclient and operations section
Hans Plum <hans.plum@intevation.de>
parents: 901
diff changeset
14 cp -i gnv-\$VERSION.war /usr/share/tomcat5.5/webapps/gnv.war
fb1e051713cc Improved artifact, webclient and operations section
Hans Plum <hans.plum@intevation.de>
parents: 901
diff changeset
15 # Start Tomcat:
fb1e051713cc Improved artifact, webclient and operations section
Hans Plum <hans.plum@intevation.de>
parents: 901
diff changeset
16 /etc/init.d/tomcat5.5 start
fb1e051713cc Improved artifact, webclient and operations section
Hans Plum <hans.plum@intevation.de>
parents: 901
diff changeset
17 \end{lstlisting}
901
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
18
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
19
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
20 \subsubsection*{Configuration}
921
fb1e051713cc Improved artifact, webclient and operations section
Hans Plum <hans.plum@intevation.de>
parents: 901
diff changeset
21 \label{ref:webclient-config}
901
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
22
921
fb1e051713cc Improved artifact, webclient and operations section
Hans Plum <hans.plum@intevation.de>
parents: 901
diff changeset
23 As default, the GNV-Client looks for an artifact-server running on
fb1e051713cc Improved artifact, webclient and operations section
Hans Plum <hans.plum@intevation.de>
parents: 901
diff changeset
24 \verb+ http://localhost:8181/+. If this address needs not to be changed,
fb1e051713cc Improved artifact, webclient and operations section
Hans Plum <hans.plum@intevation.de>
parents: 901
diff changeset
25 there is nothing to do to considering the execution environment.
901
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
26
921
fb1e051713cc Improved artifact, webclient and operations section
Hans Plum <hans.plum@intevation.de>
parents: 901
diff changeset
27 If the address of the artifact-server has been changed (c.f.
924
9d94bf77e442 Finalized documentation with references, unifying tools, adding logos.
Hans Plum <hans.plum@intevation.de>
parents: 922
diff changeset
28 chapter~\ref{ref:artifact-server-install},
9d94bf77e442 Finalized documentation with references, unifying tools, adding logos.
Hans Plum <hans.plum@intevation.de>
parents: 922
diff changeset
29 p.\pageref{ref:artifact-server-install}), it can be adapted in the file {\tt
9d94bf77e442 Finalized documentation with references, unifying tools, adding logos.
Hans Plum <hans.plum@intevation.de>
parents: 922
diff changeset
30 WEB-INF/web.xml} for the parameter name
921
fb1e051713cc Improved artifact, webclient and operations section
Hans Plum <hans.plum@intevation.de>
parents: 901
diff changeset
31 \verb+de.intevation.gnv.artifactdatabase.client.ArtifactDatabase.url.1+.
fb1e051713cc Improved artifact, webclient and operations section
Hans Plum <hans.plum@intevation.de>
parents: 901
diff changeset
32
fb1e051713cc Improved artifact, webclient and operations section
Hans Plum <hans.plum@intevation.de>
parents: 901
diff changeset
33 As default log information is written into the file
fb1e051713cc Improved artifact, webclient and operations section
Hans Plum <hans.plum@intevation.de>
parents: 901
diff changeset
34 \verb+/usr/share/tomcat5.5/logs/gnv.log+. The log level can be adjusted
fb1e051713cc Improved artifact, webclient and operations section
Hans Plum <hans.plum@intevation.de>
parents: 901
diff changeset
35 in the file \verb+WEB-INF/classes/log4j.properties+. For further
fb1e051713cc Improved artifact, webclient and operations section
Hans Plum <hans.plum@intevation.de>
parents: 901
diff changeset
36 instructions look into the file.
fb1e051713cc Improved artifact, webclient and operations section
Hans Plum <hans.plum@intevation.de>
parents: 901
diff changeset
37
fb1e051713cc Improved artifact, webclient and operations section
Hans Plum <hans.plum@intevation.de>
parents: 901
diff changeset
38 {\em Hint: The changes need to be done within the compressed
fb1e051713cc Improved artifact, webclient and operations section
Hans Plum <hans.plum@intevation.de>
parents: 901
diff changeset
39 war-file because of the deployment mechanism of Apache Tomcat in case of
fb1e051713cc Improved artifact, webclient and operations section
Hans Plum <hans.plum@intevation.de>
parents: 901
diff changeset
40 a restart. Keep in mind to repackage the war-file for a solution
fb1e051713cc Improved artifact, webclient and operations section
Hans Plum <hans.plum@intevation.de>
parents: 901
diff changeset
41 surveiving a restart of Tomcat.}
fb1e051713cc Improved artifact, webclient and operations section
Hans Plum <hans.plum@intevation.de>
parents: 901
diff changeset
42
901
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
43
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
44 \subsubsection*{Test of the Installation}
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
45
921
fb1e051713cc Improved artifact, webclient and operations section
Hans Plum <hans.plum@intevation.de>
parents: 901
diff changeset
46 Testing the installation via Apache WebServer, mod\_jk and Apache Tomcat:
fb1e051713cc Improved artifact, webclient and operations section
Hans Plum <hans.plum@intevation.de>
parents: 901
diff changeset
47 \begin{lstlisting}
924
9d94bf77e442 Finalized documentation with references, unifying tools, adding logos.
Hans Plum <hans.plum@intevation.de>
parents: 922
diff changeset
48 curl "http://localhost/gnv/" -o gnv
921
fb1e051713cc Improved artifact, webclient and operations section
Hans Plum <hans.plum@intevation.de>
parents: 901
diff changeset
49 \end{lstlisting}
901
1ebde13e620f Moved all admin-manual specific files in new directory admin-manual
Hans Plum <hans.plum@intevation.de>
parents:
diff changeset
50
921
fb1e051713cc Improved artifact, webclient and operations section
Hans Plum <hans.plum@intevation.de>
parents: 901
diff changeset
51 The file \verb+gnv+ includes HTML describing the startpage of the
fb1e051713cc Improved artifact, webclient and operations section
Hans Plum <hans.plum@intevation.de>
parents: 901
diff changeset
52 GNV-WebClient.

http://dive4elements.wald.intevation.org