comparison doc/admin-manual/installation-artifact-server.tex @ 949:11d8cc2deb92 1.0

merged doc/1.0
author Thomas Arendsen Hein <thomas@intevation.de>
date Fri, 28 Sep 2012 12:13:58 +0200
parents 3b67f53ff57b
children 17c3770e6c63
comparison
equal deleted inserted replaced
899:3f9fc88aec2b 949:11d8cc2deb92
1 \subsection{Artifact-Server}
2 The Artifact-Server contains the entire business logic of the system.
3 The server provides a RESTful interface with a XML-based protocol to the
4 webclient. Technically the server is a standalone java process serving the
5 REST interface.
6
7 \subsubsection*{Installation}
8 \label{ref:artifact-server-install}
9
10 Running the server with its own user\footnote{Remark: A group with the
11 same name is created automatically.}:
12 \begin{lstlisting}
13 adduser artifacts
14 \end{lstlisting}
15
16 Setup and configuring logging:
17 \begin{lstlisting}
18 cd /var/log
19 mkdir artifacts
20 chmod 770 artifacts
21 chmod g+s artifacts
22 \end{lstlisting}
23
24 The log level can be adjusted in the file \verb+ conf/log4j.properties+.
25 Further information can be found there.
26
27 Integrate software of artifact-server into filesystem:
28 \begin{lstlisting}
29 cd /opt
30 tar xfvj /root/artifact-server-$VERSION.tar.bz2
31 ln -s artifact-server-$VERSION artifact-server
32 cd artifact-server
33 \end{lstlisting}
34
35 Setting the access rights:
36 \begin{lstlisting}
37 bin/setup.sh
38 \end{lstlisting}
39
40 Configure connection to database:
41 \begin{lstlisting}
42 cd /opt/artifact-server
43 vim conf/arcsdeconnectionpool.properties
44
45 # in conf/arcsdeconnectionpool.properties do:
46 server=xyz.server.com
47 username=guest
48 credentials=XYZ
49 port=5151
50 database=esri_sde
51 \end{lstlisting}
52
53 Configure address for finding the WMS-Server:
54 \begin{lstlisting}
55 cd /opt/artifact-server/
56 vim conf/conf.xml
57 # adapt the address in the element
58 # artifact-database/gnv/mapserver/server. This is
59 # the string the server uses to provide an address of the mapserver to enduser.
60 e.g. http://SERVER/cgi-bin/gnv-wms
61 \end{lstlisting}
62
63 The artifact server can export and import projects of the user's
64 parameterizations. In order to protect the server against invalid files,
65 configure a secret for signing artifacts.
66
67 {\em Hint: If the secret is changed, all files that were created before
68 are not valid anymore.}
69
70 \begin{lstlisting}
71 # generate a randomized string, e.g.
72 cd /opt/artifact-server/
73 pwgen -s 30
74 # populate the tag artifact-database/export-secret
75 \end{lstlisting}
76
77 Adapt TCP-port of artifact-server, if the default has to be changed
78 (default:8181):
79 \begin{lstlisting}
80 cd /opt/artifact-server
81 vim conf/conf.xml
82
83 # in conf/conf.xml edit the element artifact-database/rest-server/port
84 \end{lstlisting}
85
86 Integrate artifact-server in startup-process of operating system:
87 \begin{lstlisting}
88 cp -i /opt/artifact-server/bin/debian/artifact-server /etc/init.d/
89 chmod +x /etc/init.d/artifact-server
90 update-rc.d artifact-server defaults
91 \end{lstlisting}
92
93 The server can be started and stopped via
94 \begin{lstlisting}
95 /etc/init.d/artifact-server {start | stop}
96 \end{lstlisting}
97
98 The installation of the artifact-server is finished. It can be tested
99 now.
100
101 \subsubsection*{Test of the Installation}
102 \label{ref:artifact-server-testing}
103 Start the server:
104 \begin{lstlisting}
105 /etc/init.d/artifact-server start
106 \end{lstlisting}
107
108 1. Operating System: Check if the process of the server called "App"
109 is running:
110 \begin{lstlisting}
111 jps
112
113 # Example with list of java processes:
114 19252
115 19509 Jps
116 19441 App
117
118 cat /var/run/artifact-server
119 \end{lstlisting}
120
121 Task: Compare the running process numbers.
122
123 2. Network: Check if the artifact-server opens a TCP-port (default: 8181)
124 \begin{lstlisting}
125 netstat -nltp
126
127 # Check for an entry like:
128 tcp 0 0 127.0.0.1:8181 0.0.0.0:* LISTEN 18648/java
129 \end{lstlisting}
130
131 3. Artifact-Server ready for communication with client?
132 \begin{lstlisting}
133 curl "http://localhost:8181/factories" | xmllint --format -
134 \end{lstlisting}
135
136 Task: Check for a XML-document describing possible expert information
137 systems (FIS)

http://dive4elements.wald.intevation.org