Default main.cfg

An example main.cfg file is given here as reference.

.. code-block:: guess
    :linenos:
    [headers]
    X-Powered-By=ZOO@ZOO-Project
    [main]
    version=1.0.0
    encoding=utf-8
    dataPath=/var/data
    tmpPath=/var/www/temp
    cacheDir=/var/www/cache
    sessPath=/tmp
    serverAddress=http://localhost/cgi-bin/zoo_loader.cgi
    lang=fr-FR,ja-JP
    language=en-US
    mapserverAddress=http://localhost/cgi-bin/mapserv.cgi
    msOgcVersion=1.0.0
    tmpUrl=http:/localhost/temp/
    [identification]
    keywords=t,ZOO-Project, ZOO-Kernel,WPS,GIS
    title=ZOO-Project demo instance
    abstract= This is ZOO-Project, the Open WPS platform.
    accessConstraints=none
    fees=None
    [provider]
    positionName=Developer
    providerName=GeoLabs SARL
    addressAdministrativeArea=False
    addressDeliveryPoint=1280, avenue des Platanes
    addressCountry=fr
    phoneVoice=+33467430995
    addressPostalCode=34970
    role=Dev
    providerSite=http://geolabs.fr
    phoneFacsimile=False
    addressElectronicMailAddress=gerald@geolabs.fr
    addressCity=Lattes
    individualName=Gerald FENOY

Main section

The main.cfg [main] section parameters are explained bellow.

• version: Supported WPS version.
• encoding: Default encoding of WPS Responses.
• dataPath: Path to the directory where data files are stored (used to store mapfiles and data when MapServer support is activated).
• tmpPath: Path to the directory where temporary files are stored (such as ExecuteResponse when storeExecuteResponse is set to true).
• cacheDir: Path to the directory where cached request files [1] are stored (optional).
• serverAddress: URL to the ZOO-Kernel instance.
• tmpUrl: URL of the temporary files directory.
• mapservAddress: URL to the MapServer instance (optional).
• msOgcVersion: Version of all supported OGC Web Services output [2] (optional).
• lang: Supported natural languages separated by a coma (the first is the default one),

Identification and Provider

The [identification] and [provider] sections are not ZOO-Project specific. They provide OGC metadata [3] and should be set according to the XML Schema Document which encodes the parts of ISO 19115 used by the common ServiceIdentification and ServiceProvider sections of the GetCapabilities operation response, known as the service metadata XML document.

Details of the common OWS 1.1.0 ServiceIdentification section can be found in this XML Schema Document.

Details of the common OWS 1.1.0 ServiceProvider section can be found in this XML Schema Document.

Headers section

The [headers] section can be set in order to define a specific HTTP Response header, which will be used for every response. As an example, you can check http://zoo-project.org using curl command line tool and notice the specific header X-Powered-By: Zoo-Project@Trac.

env section

The [env] section can be used to store specific environment variables to be set prior the loading of Services Provider and Service execution.

A typical example is when a Service requires the access to a X server running on framebuffer, which takes to set the DISPLAY environnement variable, as follow:

.. code-block:: guess
    :linenos:
    [env]
    DISPLAY=:1

lenv section

The lenv can be used to store runtime informations automatically set by ZOO-Kernel before and during the execution of a WPS service, with the following parameters:

• sid (r): The WPS Service unique identifier,
• status (rw): The current progress value ( a value between 0 and 100 in percent (%) ),
• cwd (r): The current working directory of ZOO-Kernel,
• message (rw): An error message used when SERVICE_FAILED is returned (optional),
• cookie (rw): The cookie to be returned to the client (for example for authentication purpose).

senv section

The senv section can be used to store sessions information on the server side. Such information can then be accessed automatically from the Service if the server is requested using a valid cookie (as defined in lenv section). ZOO-Kernel will store the values set in the senv maps on disk, load it and dynamically replace its content to the one in the main.cfg. The senv section must contain the following parameter at least:

• XXX: The session unique identifier where XXX is the name included in the cookie which is returned.

For instance, adding the following in the Service source code :

conf["lenv"]["cookie"]="XXX=XXX1000000; path=/"
conf["senv"]={"XXX": "XXX1000000","login": "demoUser"}

means that ZOO-Kernel will create a file named sess_XXX1000000.cfg in the cacheDir directory, and will return the specified cookie to the client. Each time the client will request ZOO-Kernel using this cookie, it will automatically load the value stored before the Service execution.

Database section

The database section allows to configure the :ref:`ZOO-Kernel optional database support <zoo_install_db_backend>`.

No macro or processor named 'guess' found

This will generate strings to be passed to GDAL to connect the database server:

No macro or processor named 'guess' found

With the previous database section, it will give the following:

No macro or processor named 'guess' found

To create a new database to be used by the ZOO-Kernel, you have to load the schema.sql file. For instance, you may run the following:

createdb zoo_project
psql zoo_project -f zoo-project/zoo-kernel/sql/schema.sql

Footnotes