source: trunk/zoo-kernel/README @ 112

Last change on this file since 112 was 112, checked in by djay, 13 years ago

Add a README File for the ZOO-Kernel and small fix in configure.ac for Perl support.

File size: 8.8 KB
Line 
1SUMMARY
2-------
3
4ZOO is a WPS (Web Processing Service) open source project released under the
5MIT/X-11 license. It provides an  OGC WPS compliant developer-friendly
6framework to create and chain WPS webservices. Its main goals are to gather
7existing open source librairies and to make them communicate in a standardized
8way, but also to simplify the end-developer's job by providing an easy method
9to create new webservices.
10
11For more information and complete documentation please visit:
12
13                         http://www.zoo-project.org
14
15Send comments and bug reports through http://zoo-project.org/trac/newticket. If
16you do make changes and/or enhancements, please let us know so that they might
17be incorporated into future releases.
18
19LICENSE
20-------
21
22Copyright © 2010-2011 GeoLabs
23
24Permission is hereby granted, free of charge, to any person obtaining a copy of
25this software and associated documentation files (the "Software"), to deal in
26the Software without restriction, including without limitation the rights to
27use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
28the Software, and to permit persons to whom the Software is furnished to do so,
29subject to the following conditions:
30
31The above copyright notice and this permission notice shall be included in all
32copies or substantial portions of the Software.
33
34THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
35IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
36FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
37AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
38LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
39OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
40SOFTWARE.
41
42COMPILATION
43-----------
44
45UNIX
46----
47
48For Unix users, ZOO-Kernel comes with a GNU autoconf "configure" script that
49should take care of (hopefully!) all compilation issues for you.
50
51The configure script won't work on Windows. See section WIN32 for details on
52compiling on Windows systems.
53
54For the impatient:
55------------------
56
57To build zoo_loader.cgi CGI program with the default options, go to the default
58options, go to the directory where you extracted the ZOO-Kernel source code
59package and use the following command:
60
61 $ cd zoo-kernel
62 $ ./configure
63 $ make
64
65Unless something went wrong, you should have executables in the current
66directory for the zoo_loader.cgi CGI program. You can copy the zoo_loader.cgi
67program and the main.cfg file to your HTTP server's CGI directory and start
68using it.
69
70At this step your ZOO-Kernel should work. Nevertheless, don't forget to correct
71the main.cfg settings to set tmpPath and tmpUrl to fit your web server
72configuration.
73
74configure options:
75------------------
76
77Here is the list of available options as returned by "./configure --help":
78
79  --with-gdal-config=FILE specify an alternative gdal-config file
80  --with-xml2config=FILE  specify an alternative xml2-config file
81  --with-python=PATH      To enabled python support or specify an alternative
82                          directory for python installation, disabled by
83                          default
84  --with-php=PATH         To enabled php support or specify an alternative
85                          directory for php installation, disabled by default
86  --with-perl=PATH        To enabled perl support or specify an alternative
87                          directory for perl installation, disabled by default
88  --with-java=PATH        To enabled java support, specify a JDK_HOME,
89                          disabled by default
90  --with-js=PATH          specify --with-js=path-to-js to enabled js support,
91                          specify --with-js on linux debian like, js support
92                          is disabled by default
93
94All the options are described in more details below.
95
96(Required) GDAL Support:
97------------------------
98
99If your gdal-config program is not found in your PATH then you can use the
100"--with-gdal-config" option to speficy its location. For instance, let suppose
101that your gdal-config was installed in /usr/local/bin and this directory is not
102in your PATH, then you can use the following command:
103
104 $ ./configure --with-gdal-config=/usr/local/bin/gdal-config
105
106(Required) XML2 Support:
107------------------------
108
109If your xml2-config program is not found in your PATH then you can use the
110"--with-xml2config" option to specify its location. For instance, let suppose
111that your xml2-config was installed in /usr/local/bin end this directory is not
112in you PATH, then you can use the following command:
113
114 $ ./configure --with-xml2config=/usr/local/bin/xml2-config
115
116(Optional) Python Support:
117--------------------------
118
119If you want to activate the Python Support for ZOO-Kernel then you will have to
120use the "--with-python" option. If your python-config program is found in your
121PATH then you don't have to specify the path where Python was installed, so
122using the following command:
123
124 $ ./configure --with-python
125
126This suppose that python-config is found in your PATH.
127
128In case your python-config is not found in your PATH, then you can set the
129Python installation directory you are using. For instance, let suppose that you
130installed Python in /usr/local, then you can use the following command:
131
132 $ ./configure --with-python=/usr/local
133
134This suppose that /usr/local/bin/python-config exists.
135 
136(Optional) PHP Support:
137-----------------------
138
139To be able to activate PHP Support for ZOO-Kernel you'll need to get a local
140PHP Embedded installation, for more informations about configure options to use
141to get such kind of PHP installation you can refer to this page :
142               http://zoo-project.org/trac/wiki/ZooKernel/Embed/PHP
143
144If you want to activate the PHP Support for ZOO-Kernel then you will have to
145use the "--with-php" option. If your php-config program is found in your PATH
146then you don't have to specify the path where PHP was installed, so using the
147following commnd:
148
149 $ ./configure --with-php
150
151This suppose that php-config is found in your PATH.
152
153In case your php-config is not found in your PATH, then you can set the PHP
154installation directory you are using. For instance, let suppose that you
155installed PHP in /usr/local, then you can use the following command:
156
157 $ ./configure --with-php=/usr/local
158
159This suppose that /usr/local/bin/php-config exists.
160
161(Optional) Perl Support:
162------------------------
163
164If you want to activate the Perl Support for ZOO-Kernel then you will have to
165use the "--with-perl" option. If you do not set any value to this option, then
166perl program will be searched in your PATH. So in such case, you can use the
167following command:
168
169 $ ./configure --with-perl
170
171This suppose that perl is found in your PATH.
172
173In other case, for custom Perl installation, you can set the installation
174directory. For instance, let suppose that you installed Perl in /usr/local
175and /usr/local/bin is not in your PATH, then you can use the following command:
176
177 $ ./configure --with-perl=/usr/local
178
179This suppose that /usr/local/bin/perl exists.
180
181(Optional) Java Support:
182------------------------
183
184If you want to activate the Java Support for ZOO-Kernel then you will have to
185use the "--with-java" option and set the installation path of your Java SDK.
186For instance, let suppose that your Java SDK was installed in
187/usr/lib/jvm/java-6-sun-1.6.0.22/ directory, then you can use the following
188command:
189
190 $ ./configure --with-java=/usr/lib/jvm/java-6-sun-1.6.0.22/
191
192This suppose that the include/linux and jre/lib/i386/client/ subdirectories
193exist in /usr/lib/jvm/java-6-sun-1.6.0.22/, include/linux contains the jni.h
194headers file and jre/lib/i386/client/ contains the libjvm.so file.
195
196Note that on MacOS X you only have to set macos as value for the "--with-java"
197option to get the Java Support for ZOO-Kernel activated. So using the following
198command:
199
200 $ ./configure --with-java=macos
201
202(Optional) JavaScript Support:
203------------------------------
204
205If you want to activate the JavaScript Support for ZOO-Kernel then you will
206have to use the "--with-js" option. If you are using a "Debian-like" GNU/Linux
207distribution then dpkg will be used to detect if the required packages was
208installed and you don't have to specify anything here, so you can use the
209following command:
210
211 $ ./configure --with-js
212
213This suppose that js_api.h and libmozjs.so are found in default directories.
214
215If you get a custom installation of SpiderMonkey or you are not using a Debian
216packaging system, then you'll have to specify the directory where you installed
217it. For instance, let suppose that you installed your SpiderMonkey in /usr,
218then you'll have to use the following command:
219
220 $ ./configure --with-js=/usr
221
222This suppose that the /usr/include/js exists and contains the js_api.h headers
223file and /usr/lib contains libmozjs.so file.
224
225WIN32
226-----
227
228To be written soon ...
Note: See TracBrowser for help on using the repository browser.

Search

Context Navigation

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