source: trunk/docs/install/installation.rst @ 920

Last change on this file since 920 was 920, checked in by djay, 14 months ago

Fix documentation typos.

  • Property svn:keywords set to Date Author
  • Property svn:mime-type set to text/plain
File size: 15.4 KB
Line 
1.. _install-installation:
2
3Installation on Unix/Linux
4==========================
5
6To build and install ZOO-Project on your Web Server you will need 4
7steps :
8
9.. contents::
10    :local:
11    :depth: 1
12    :backlinks: top
13
14
15Build cgic
16----------
17
18Run the following commands from the ``thirds/cgic`` directory to build
19the cgic library.
20
21::
22
23   cd thirds/cgic
24   make
25
26The cgic library originaly come from `http://www.boutell.com/cgic
27<http://www.boutell.com/cgic>`_.
28
29.. warning::
30
31   You may need to edit the ``Makefile`` in case you are using a 64 bits
32   platform for building and your fcgi library is not located in ``/usr/lib64``.
33
34Install ZOO-Kernel
35------------------
36
37
38For the impatient
39.................
40
41Run the following commands from the directory where you :ref:`install-download` and extracted the ZOO Kernel source code in order to build the ``zoo_loader.cgi`` CGI program with default options.
42
43::
44
45   cd zoo-project/zoo-kernel
46   autoconf 
47   ./configure
48   make
49   make install
50
51This should produce executables for the *zoo_loader.cgi* CGI program
52(located per default in ``/usr/lib/cgi-bin/``) and a shared library
53``libzoo_service``  (located per default in ``/usr/local/lib``).
54
55.. warning::
56
57   Edit ZOO-Kernel installation settings in the ``main.cfg`` file (set
58   ``tmpPath`` and ``tmpUrl`` to fit your web server configuration).
59
60
61Configure options
62.................
63
64This section provides information on :ref:`kernel_index` configure options. It is recommanded to also read the :ref:`kernel_config` section for configuration technical details.
65
66
67Here is the list of available options in the same order as returned by
68``./configure --help`` command:
69
70.. contents::
71    :local:
72    :depth: 2
73    :backlinks: top
74
75Specific CGI Directory
76**********************
77
78In the case your ``cgi-bin`` is not located in ``/usr/lib/`` as it is
79assumed per default, then you can specify a specific target location
80by using the following option:
81
82.. code::
83
84    ./configure --with-cgi-dir=/Lbrary/WebServer/CGI-Executables
85
86This way, when you will run the ``make install`` command, the
87ZOO-Kernel will be deployed in the specified directory (so,
88`/Lbrary/WebServer/CGI-Executables`` in this example).
89
90Specific main.cfg location  (Optional)
91**************************************
92
93Per default, the ZOO-Kernel search for the ``main.cfg`` file from its
94installation directory but, in case you want to store this file in
95another place, then you can use the ``--with-etc-dir`` option so it
96will search for the ``main.cfg`` file in the ``sysconfdir`` directory.
97
98For instance, you can define that the directory to store the
99``main.cfg`` file is the ``/etc/zoo-project`` directory, by using the
100following command:
101
102.. code::
103
104    ./configure --with-etc-dir=yes --sysconfdir=/etc/zoo-project
105
106
107.. _zoo_install_db_backend:
108
109Use a Database Backend (Optional)
110**********************************
111
112If you want to share the ongoing informations of running services
113between various ZOO-Kernel instances then you should use this
114option: ``--with-db-backend``. This way, both the *GetStatus*,
115*GetResult* and *Dismiss* requests can be run from any host accessing
116the same database. Obviously, this will require that the ZOO-Kernel is
117able to access the Database server. To learn how to configure this
118connection and how to create this database please refer to :ref:`[1]
119<zoo_activate_db_backend>` and :ref:`[2] <zoo_create_db_backend>`
120respectively.
121
122.. note::
123    By now, the ZOO-Kernel is not able to handle correctly the
124    *Dismiss* request from any host. Nevertheless, it will provide
125    valid response from any host, but only the host which is really
126    handling the service will be able to stop it and remove all the
127    linked files.
128
129.. _zoo_create_db_backend:
130
131To create a new database to be used by the ZOO-Kernel, you have
132to load the `schema.sql
133<http://zoo-project.org/trac/browser/trunk/zoo-project/zoo-kernel/sql/schema.sql>`_
134file. For instance, you may run the following:
135
136.. code::
137
138    createdb zoo_project
139    psql zoo_project -f zoo-project/zoo-kernel/sql/schema.sql
140
141.. note::
142    You can choose another schema to store ZOO-Kernel specific
143    informations. In such a case, you would need to edit the
144    schema.sql file to uncomment line `33
145    <http://zoo-project.org/trac/browser/trunk/zoo-project/zoo-kernel/sql/schema.sql#L33>`_
146    and `34
147    <http://zoo-project.org/trac/browser/trunk/zoo-project/zoo-kernel/sql/schema.sql#L34>`_.
148
149.. _zoo_create_metadb:
150
151Metadata Database (Optional)
152*****************************
153
154
155It is possible to use a PostgreSQL database to store metadata
156information about WPS Services. This support is optional and require
157to be activated by using the ``--with-metadb=yes`` option.
158
159To create the database for storing the metadata informations about the
160WPS Services, you may use the following command:
161
162.. code::
163
164    createdb zoo_metadb
165    psql zoo_metadb -f zoo-project/zoo-kernel/sql/zoo_collectiondb.sql
166
167In case you want to convert an existing zcfg file then, you can use
168the ``zcfg2sql`` tool from the command line. It can be found in
169``thirds/zcfg2sql`` and can be build simply by running the ``make``
170command. After compilation you only need to give it the path of the
171zcfg file you want to obtain the SQL queries required to store the
172metadata informations in the database rather than in zcfg file.
173
174For instance you may use the following command:
175
176.. code::
177
178    #Direct import in the zoo_metadb database
179    ./zcfg2sql /Path/To/MyZCFGs/myService.zcfg | psql zoo_metadb
180    #Create a SQL file for a futur import
181    ./zcfg2sql /Path/To/MyZCFGs/myService.zcfg > myService.sql
182
183
184
185YAML Support (Optional)
186************************
187
188If ``yaml.h`` file is not found in your ``/usr/include`` directory and
189``libyaml.so`` is not found in ``/usr/lib``, a ``--with-yaml`` option
190can be used to specify its location. For instance, if the header file
191lies in ``/usr/local/include`` and the shared library is located in
192``/usr/local/lib``, you may use the following command:
193
194::
195
196  $ ./configure --with-yaml=/usr/local
197
198
199FastCGI Support (Required)
200***************************
201
202If your FastCGI library is not available in the default search path, a
203``--with-fastcgi`` option can be used to specify its location. For
204instance, if ``libfcgi.so`` lies in ``/usr/local/lib`` which is not in
205your ``LD_SEARCH_PATH``, you may use the following command:
206
207::
208
209  $ ./configure --with-fastcgi=/usr/local
210
211
212
213GDAL Support (Required)
214************************
215
216If gdal-config program is not found in your ``PATH``, a
217``--with-gdal-config`` option can be used to specify its location. For
218instance, if ``gdal-config`` lies in ``/usr/local/bin`` which is not in
219your ``PATH``, you may use the following command:
220
221::
222
223  $ ./configure --with-gdal-config=/usr/local/bin/gdal-config
224
225
226GEOS Support (Optional)
227************************
228
229If ``geos-config`` program is not found in your ``PATH``, a
230``--with-geosconfig`` option can be used to specify its location. For
231instance, if ``geos-config`` lies in ``/usr/local/bin`` which is not in
232your ``PATH``, you may use the following command:
233
234::
235
236  $ ./configure --with-geosconfig=/usr/local/bin/geos-config
237
238
239CGAL Support (Optional)
240************************
241
242If ``CGAL/Delaunay_triangulation_2.h`` program is not found in your
243``/usr/include`` directory, a ``--with-cgal`` option can be used to
244specify its location. For instance, if the file lies in
245``/usr/local/include`` which is not in your PATH, you may use the
246following command:
247
248::
249
250  $ ./configure --with-cgal=/usr/local
251
252
253
254MapServer Support (Optional)
255*****************************
256
257
258In order to activate the WMS, WFS and WCS output support using
259MapServer, the ``--with-mapserver`` option must be used. The path to
260``mapserver-config`` which is located in the source code of MapServer
261must also be set, using the following command:
262
263::
264
265  $ ./configure --with-mapserver=/path/to/your/mapserver_config/
266
267
268Read more about the :ref:`kernel-mapserver`.
269
270XML2 Support (Required)
271************************
272
273If xml2-config program is not found in PATH, a *--with-xml2config* option can be used  to specify its location. For instance, if xml2-config is installed in ``/usr/local/bin`` which is not in PATH, you may use the following command:
274
275::
276
277  $ ./configure --with-xml2config=/usr/local/bin/xml2-config
278
279Python Support (Optional)
280**************************
281
282The ``--with-python=yes`` option is required to activate the :ref:`kernel_index` Python support, using the following command:
283
284::
285
286  $ ./configure --with-python=yes
287
288This assumes that python-config is found in your ``PATH``. If not,
289then you can specify the Python installation directory using the
290following command (with Python installed in the ``/usr/local``
291directory):
292
293::
294
295  $ ./configure --with-python=/usr/local
296
297
298Python Version
299##############
300
301If multiple Python versions are available and you want to use a
302specific one, then you can use the ``--with-pyvers`` option as shown
303bellow:
304
305::
306
307  $ ./configure --with-pyvers=2.7
308
309
310.. _js-support:
311
312JavaScript Support (Optional)
313******************************
314
315In order to activate the JavaScript support for ZOO-Kernel,
316the ``--with-js=yes`` configure option must be specified. If you are using
317a "Debian-like" GNU/Linux distribution then  dpkg will be used to
318detect if the required packages are installed and you don't have to
319specify anything here. The following command is only needed (assuming
320that js_api.h and libmozjs.so are found in default directories):
321
322
323::
324
325  $ ./configure --with-js=yes
326
327If you want to use a custom installation of `SpiderMonkey
328<https://developer.mozilla.org/en/SpiderMonkey>`__ , or if you are not
329using a Debian packaging  system, then you'll have to specify the
330directory where it is installed. For  instance, if SpiderMonkey is in
331``/usr/local/``, then the following command must be used:
332
333::
334
335  $ ./configure --with-js=/usr/local
336
337
338PHP Support (Optional)
339***********************
340
341The ``--with-php=yes`` option is required to activate the
342:ref:`kernel_index` PHP support`, using the following command:
343
344::
345
346  $ ./configure --with-php=yes
347
348This assumes that ``php-config`` can be found in the ``<PATH>/bin``
349directory . So, supposing the your ``php-config`` can be found in
350``/usr/local/bin``, then use the following command:
351
352::
353
354  $ ./configure --with-php=/usr/local
355
356.. warning::
357    ZOO-Kernel optional PHP support requires a local PHP Embedded installation. Read more `here <http://zoo-project.org/trac/wiki/ZooKernel/Embed/PHP>`__.
358
359
360Java Support (Optional)
361************************
362
363In order to activate the Java support for ZOO-Kernel, the
364`--with-java` configure option must be specified and sets the
365installation path of your Java SDK. For instance,  if Java SDK is
366installed in the ``/usr/lib/jvm/java-6-sun-1.6.0.22/`` directory,
367then the following command can be used:
368
369::
370
371  $ ./configure --with-java=/usr/lib/jvm/java-6-sun-1.6.0.22/
372
373This assumes that the ``include/linux`` and ``jre/lib/i386/client/``
374subdirectories exist in ``/usr/lib/jvm/java-6-sun-1.6.0.22/``, and
375that the ``include/linux`` directory contains the ``jni.h`` headers file
376and that the ``jre/lib/i386/client/`` directory contains the ``libjvm.so``
377file.
378
379.. note::
380   You can use the `--with-java-rpath` option to produce a binary
381   aware of the libjvm location.
382
383
384.. note::
385   With Mac OS X you only have to set *macos* as the value for the
386   ``--with-java`` option to activate Java support. For example:
387
388   ::
389
390     $ ./configure --with-java=macos
391
392
393Perl Support (Optional)
394************************
395
396The ``--with-perl=yes`` option can be used for activating the
397ZOO-Kernel Perl support, as follow:
398
399::
400
401  $ ./configure --with-perl=yes
402
403This assumes that perl is found in your PATH. For instance, if Perl is
404installed in ``/usr/local`` and ``/usr/local/bin`` is not found in
405your ``PATH``, then the following command can be used (this assumes
406that ``/usr/local/bin/perl`` exists):
407
408::
409
410  $ ./configure --with-perl=/usr/local
411
412
413Orfeo Toolbox Support (Optional)
414*********************************
415
416In order to activate the optional Orfeo Toolbox support, the
417``--with-otb`` option must be used, using the following command:
418
419::
420
421  $ ./configure --with-otb=/path/to/your/otb/
422
423
424Read more about the :ref:`kernel-orfeotoolbox`.
425
426.. warning::
427    To build the Orfeo Toolbox support you will require ITK, the
428    default version of ITK is 4.5, in case you use another version,
429    please make sure to use the ``--with-itk-version`` to specificy
430    what is the version available on your system.
431
432SAGA GIS Support (Optional)
433****************************
434
435
436In order to activate the optional SAGA GIS support, the *--with-saga* option must be used, using the following command:
437
438::
439
440  $ ./configure --with-saga=/path/to/your/saga/
441
442
443Read more about the :ref:`kernel-sagagis`.
444
445.. warning::
446    In case wx-config is not in your ``PATH`` please, make sure to use
447    the ``--with-wx-config``  to specify its location.
448
449Translation support (Optional)
450******************************
451
452The ZOO-Kernel is able to translate the messages it produces in different
453natural languages. This requires that you download `the messages file
454<https://www.transifex.com/projects/p/zoo-kernel-internationalization/>`_
455translated in your language, if any. Then, for this translation
456support to work, you have to generate manually the requested file on
457your system. For instance for the French translation, you may use the
458following command:
459
460.. code::
461
462    msgfmt messagespo_fr_FR.utf8.po -o /usr/share/locale/fr/LC_MESSAGES/zoo-kernel.mo
463
464The ZOO-Kernel is also able to handle translation of
465ZOO-Services. Please, refer to :ref:`this document
466<service_translation>` for more details on the procedure to add new
467ZOO-Service translation files.
468
469.. warning::
470    The location of the final ``.mo`` file may vary depending on your
471    system setup.
472
473
474Install ZOO-Services
475--------------------
476
477.. warning::
478    We present here a global installation procedure for basics
479    ZOO-Services, for details about automatic installation of services
480    provided by :ref:`kernel-orfeotoolbox` or :ref:`kernel-sagagis`,
481    please refer to there specific documentations.
482
483Depending on the programming language used to implement the
484ZOO-Services you want to install, you will need to build a
485Services Provider. In the case of *C* and *Fotran*, you would create a
486shared library exporting the functions corresponding to all the
487ZOO-Services provided by this Services Provider. In case of *Java*,
488you will need to build a Java Class. In any other programming
489language, you should simply have to install the ServiceProvider and
490the zcfg files.
491
492If building a Shared library or a Java class is required, then you
493should find a ``Makefile`` in the service directory which is
494responsible to help you build this Services Provider. So you should
495simply run the `make` command from the Service directory to generate
496the required file.
497
498Then you simply need to copy the content of the ``cgi-env`` directory
499in ``cgi-bin``.
500
501To install the ``ogr/base-vect-ops`` Services Provider, supposing that
502your ``cgi-bin`` directory is ``/usr/local/lib`` use the following
503commands:
504
505.. code::
506
507    cd zoo-project/zoo-services/ogr/base-vect-ops
508    make
509    cp cgi-env/*.* /usr/lib/cgi-bin
510
511.. note::
512    You may also run ``make install`` directly after ``make``.
513
514
515To install the hello-py Services Provider, use the following commands:
516
517.. code::
518
519    cd zoo-project/zoo-services/hello-py/
520    cp cgi-env/* /usr/lib/cgi-bin
521
522
523Testing your installation
524-------------------------
525
526To test your installation yous should first be able to run the
527following command from the ``cgi-bin`` directory:
528
529.. code::
530
531    ./zoo_loader.cgi "request=GetCapabilities&service=WPS"
532
533
Note: See TracBrowser for help on using the repository browser.

Search

ZOO Sponsors

http://www.zoo-project.org/trac/chrome/site/img/geolabs-logo.pnghttp://www.zoo-project.org/trac/chrome/site/img/neogeo-logo.png http://www.zoo-project.org/trac/chrome/site/img/apptech-logo.png http://www.zoo-project.org/trac/chrome/site/img/3liz-logo.png http://www.zoo-project.org/trac/chrome/site/img/gateway-logo.png

Become a sponsor !

Knowledge partners

http://www.zoo-project.org/trac/chrome/site/img/ocu-logo.png http://www.zoo-project.org/trac/chrome/site/img/gucas-logo.png http://www.zoo-project.org/trac/chrome/site/img/polimi-logo.png http://www.zoo-project.org/trac/chrome/site/img/fem-logo.png http://www.zoo-project.org/trac/chrome/site/img/supsi-logo.png http://www.zoo-project.org/trac/chrome/site/img/cumtb-logo.png

Become a knowledge partner

Related links

http://zoo-project.org/img/ogclogo.png http://zoo-project.org/img/osgeologo.png