Mercurial > dive4elements > gnv-client
comparison doc/config-manual/administering_artifact-server.tex @ 938:2d84fc30ab58
Added more chapters in config-manual
doc/trunk@1079 c6561f87-3c4e-4783-a992-168aeb5c3f6f
| author | Hans Plum <hans.plum@intevation.de> |
|---|---|
| date | Sun, 09 May 2010 18:19:53 +0000 |
| parents | |
| children | 9a28846dfb9c |
comparison
equal
deleted
inserted
replaced
| 937:052b8bba4f41 | 938:2d84fc30ab58 |
|---|---|
| 1 \subsection{Configuring and Running the Artifact-Server} | |
| 2 | |
| 3 This section describes the possibilities to configure the | |
| 4 artifact-server. The following properties do affect mostly technical | |
| 5 funtions of the server. | |
| 6 | |
| 7 This section describes the possibilities in a kind of a reference | |
| 8 manual. Information for the process of installing and integration can be | |
| 9 found in the Administration Manual of the GNV-System (FIXME reference). | |
| 10 The following elements are covered here: | |
| 11 | |
| 12 \begin{lstlisting} | |
| 13 artifact-database | |
| 14 |-- geo-backend # pointing to database connection, SQL configuration | |
| 15 |-- rest-server # port, listen addresses | |
| 16 |-- database # internal database storing artifacts | |
| 17 |-- ehcache # pointing to cache configuration | |
| 18 |-- cleaner # time of cleanups FIXME | |
| 19 `-- export-secret # signing project files | |
| 20 \end{lstlisting} | |
| 21 | |
| 22 \paragraph*{geo-backend} | |
| 23 {\em Function}: The geo-backend encapsulates the logic for accessing the database | |
| 24 backend. At this time, the use of ESRI ArcSDE 9.3.1 is supported. | |
| 25 | |
| 26 At least, the following options for configuring the element {\tt | |
| 27 geo-backend} are required: | |
| 28 | |
| 29 \begin{itemize} | |
| 30 \item {\tt backend-configuration}: path to the file defining the | |
| 31 connection properties to the database backend, preconfigured to {\tt | |
| 32 arcsdeconnection.properties}. Normally, just the | |
| 33 connection parameters have to de adapted. Further information can be | |
| 34 found in the file itself. | |
| 35 | |
| 36 \item {\tt query-configuration}: path to the file listing a SQL | |
| 37 statements, preconfigured to {\tt queries.txt}. Further information can be | |
| 38 found at FIXME. | |
| 39 \end{itemize} | |
| 40 | |
| 41 | |
| 42 \paragraph*{rest-server} | |
| 43 {\em Function}: The REST-Server needs a HTTP binding configured via: | |
| 44 | |
| 45 \begin{itemize} | |
| 46 \item {\tt port}: port the server should listen on. Preconfigured on | |
| 47 8181. | |
| 48 \item {\tt listen}: for security reason the accessibility can be | |
| 49 limited. The parameter needs an IP-address or a hostname. | |
| 50 Accessibility to the entire network can be done by | |
| 51 removing/commenting out of the element. | |
| 52 \end{itemize} | |
| 53 | |
| 54 | |
| 55 \paragraph*{database} | |
| 56 {\em Function}: The internal database of the system for storing | |
| 57 artifacts representing a parameterisation of a client session. So fare, | |
| 58 the filebased database H2 is supported. Connecting to other backends can | |
| 59 be provided. | |
| 60 | |
| 61 \begin{itemize} | |
| 62 \item {\tt user}: database user for connecting to the | |
| 63 artifact-database. In new installations "SA" is used. | |
| 64 \item {\tt password}: password of the database user for | |
| 65 authentification. | |
| 66 \item {\tt url}: Connection URL to the database-files. | |
| 67 In the preconfiguration, they are written to | |
| 68 \verb| ${artifacts.config.dir}/../artifactdb| | |
| 69 \end{itemize} | |
| 70 | |
| 71 | |
| 72 \paragraph*{ehcache} | |
| 73 {\em Function}: The cache for storing result sets of the database. The | |
| 74 configuration in {\tt ehcache.xml} should not been adapted. Changing has | |
| 75 at least consequence to the system requirements. | |
| 76 | |
| 77 \begin{itemize} | |
| 78 \item {\tt configuration}: the path to the configuration file. | |
| 79 Preconfigured: \verb+${artifacts.config.dir}/ehcache.xml+ | |
| 80 \end{itemize} | |
| 81 | |
| 82 | |
| 83 \paragraph*{cleaner} | |
| 84 {\em Function}: Process for cleaning up the artifact-database. Artifacts | |
| 85 have a time-to-life. Died artifacts need to be removed. Changing the | |
| 86 interval has consequences to the size of the database. | |
| 87 | |
| 88 \begin{itemize} | |
| 89 \item {\tt sleep-time}: Time interval in milliseconds between 2 | |
| 90 checks. Preconfigured: 60000 (1 minute) | |
| 91 \end{itemize} | |
| 92 | |
| 93 | |
| 94 \paragraph*{export-secret} | |
| 95 {\em Function}: Signature for signing project files that were created by | |
| 96 the artifact-server instance. Before reading a projectfile the server | |
| 97 checks the file against that signature/check sum. | |
| 98 | |
| 99 {\bf Be aware, changing the signature of updating the source code of | |
| 100 artifacts will prevent of using existing project-files.} | |
| 101 | |
| 102 For setting up the secret, c.f. the tips in the admin manual. |