4. Configuration Files

When installing Cartoweb, the administrator of the application may want to adapt it to the environnement use. This can be easily done using configuration parameters.

Some are required and Cartoweb won't correctly work if they're not set. Others are optional but could hardly change the application behavior.

You'll also find specific config parameters in the plugins related chapters of this documentation.

4.1. Common client.ini and server.ini Options

Common options for both client and server. These parameters are available in client_conf/client.ini for client and server_conf/server.ini for server.

  • urlProvider = Miniproxy|Symlink: The kind of URL generated for resources, see Section 15.3, “Resources”
  • useWsdl = true|false: if true, WSDL will be used for sending SOAP requests. This will add some processing time but ensures that SOAP requests are well-structured.

Cache options. See Section 5.6, “Caches Configuration”.

Developer options. See Section 4.5, “Developer Specific Configuration”.

4.2.  client.ini

CartoServer access configuration:

  • cartoserverDirectAccess = true|false: toggles between SOAP and direct modes. Direct access gives enhanced performances, but is only available if CartoServer runs on the same server as CartoClient.
  • cartoclientUrl = "url" : base URL of the cartoclient-
  • cartoserverUrl = "url" : base URL of the cartoserver (i.e. path containing the cartoserver.wsdl.php file.

Mapfile configuration:

  • mapId = string
  • initialMapStateId = string

Tools configuration:

  • initialTool: indicates which tool is activated when in initial state. If not specified, the first tool in the toolbar is activated. Possible values are: zoom_in, zoom_out, pan, query, distance, surface.

Project handling configuration:

  • showProjectChooser = true|false: Shows a drop-down list for selecting the active project.
  • availableProjects = list: List of the project to show in the drop down list. If not set, all projects found will be used.

Plugins configuration:

  • loadPlugins = list: list of client plugins to load in addition to the core plugins. Note that most client plugins also have a corresponding server plugin that must be loaded on the server side. See Section, “ <myMap>.ini.


  • I18nClass = I18nDummy|I18nGettext. See Chapter 14, Internationalization for a description of the internationalization options and the corresponding configurations.
  • defaultLang = string: default language, possible values are the usual ISO locale codes (en, fr, de ...)

4.3. Server Configuration Files

4.3.1. Introduction

This page describes the configuration options of the CartoServer. There is a global configuration file (server.ini) directly in the server_conf folder. Then all specific configurations are stored in individual folders. Each configuration contains:

  • a Mapserver mapfile (myMap.map),
  • its annexes (symbols, fonts, images, data...),
  • a main configuration file (myMap.ini) that must have the same name as the .map
  • smaller configuration files for the plugins.

By default, CartoWeb comes with a fully functional test folder, that includes the necessary geometrical datas and allows one to run an out of the box demo.

4.3.2. Main Server Configuration File (server.ini)

  • imageUrl = string: Path where cartoserver generated images can be accessed. Using this will bypass Miniproxy !
  • reverseProxyUrl = string: The url of the reverse proxy, if used.

4.3.3. Map Configuration Files Introduction

The CartoServer has the ability to contains several different maps. These maps are represented by the mapserver mapfile, the CartoWeb configuration file for the map and each plugins configuration.

The file that contain the configuration information related to a map, is located in the same directory as the mapfile, but has a .ini extension. These files are in the directory server_conf/<myMap>.  <myMap>.ini Initial Mapstates

Initial map states set the initial aspects of the layers selection interface when starting using CartoClient: (un)folded nodes, selected layers... Some of these properties are not modifiable in the layers selection interface (hidden layers for instance) and thus stay unchanged throughout the session.

Several initial map states can be created in myMap.ini , but at least one must be present. Each one is identified by a unique initialMapStateId. The choice to activate one or another is done client-side in client_conf/client.ini.

Available properties and syntax for layers in "initial map states" are:

  • mapInfo.initialMapStates.initialMapStateId.layers.layerId. selected = true|false: if true, layer is initially selected.
  • mapInfo.initialMapStates.initialMapStateId.layers.layerId. unfolded = true|false: if true, the layerGroup is represented as an unfolded node (children layers are visible).
  • mapInfo.initialMapStates.initialMapStateId.layers.layerId. hidden = true|false: if true, this layer and its children are not shown in the layers list (but are still displayed on the map if they're activated).
  • mapInfo.initialMapStates.initialMapStateId.layers.layerId. frozen = true|false: if true, this layer (and its children as well) is listed in tree but without checkbox. Its selection status (defined by "selected" property) thus cannot be changed.

Example of Initial MapState:

mapInfo.initialMapStates.default.layers.polygon.selected = true
mapInfo.initialMapStates.default.layers.point.hidden = true

mapInfo.initialMapStates.map25.layers.polygon.selected = true
mapInfo.initialMapStates.map25.layers.polygon.unfolded = true

4.4. Ini Files for Plugins

Each plugin may have a configuration file associated with it. It is located in the same directory as the myMap.map and myMap.ini. They have the same name as the plugin and ends with .ini extension. For instance, the layers plugin has a configuration file named layers.ini.

All plugins configuration files are described in the next sections of this chapter.

4.5. Developer Specific Configuration

Some configuration parameters can be activated to retrieve more display information targetted to the developers, like special timing messages, or setting the Php configuration to display notices on the page. These configuration options are described below.


It is recommended that you set these parameters accordingly if you are doing development.

These parameters are available in client_conf/client.ini for client and server_conf/server.ini for server.

  • showDevelMessages = true|false: Shows developer messages
  • developerIniConfig = true|false: Sets ini parameters useful during development
  • allowTests = true|false: allows tests running through Web interface