Configuration Options

In this section, all valid configuration options and their interpretations are listed.

[core.system]

instance_id

Mandatory. The ID (name) of your instance. This is used on several locations throughout EOxServer and is inserted into a number of service responses.

logging_filename

Mandatory. The value of this option shall be a valid path to an existing file where all logs made by EOxServer will be saved. The process running EOxServer needs write permissions to that file.

logging_format

The format used to write each log entry to the log file. Since EOxServer uses the standard library logging for all logging purposes, the value of this parameter has to adhere to the logging format rules of the module.

logging_level

This parameter determines which logging levels are to be inserted into the logfile. The possible values are (from lowest priority to highest): DEBUG, INFO, WARNING, ERROR and CRITICAL whereas DEBUG is the default. Only messages with at least this level are actually written to the logfile.

[core.interfaces]

runtime_validation_level

The runtime validation level. Tells the core whether to include type checks at runtime. Possible values are ‘trust’, ‘warn’, ‘fail’. Defaults to ‘trust’.

[core.ipc]

In this section, options for controlling inter process communication will be added, once it is implemented.

[core.registry]

module_dirs

This parameter is currently not used.

modules

Mandatory. A comma-separated list of modules that contain implementations of EOxServer interfaces. Use module identifiers as with normal Python import statements.

system_modules

This parameter is currently not used.

[processing.gdal.reftools]

vrt_tmp_dir

A path to a directory for temporary files created during the orthorectification of referencial coverages. This configuration option defaults to the systems standard.

[backends.cache]

In future, options in this section will influence the behavior of caching of FTP and rasdaman data.

[resources.coverages.coverage_id]

reservation_time

Determines the time a coverage ID is reserved when inserting a coverage into the system. Needs to be in the following form: <days>:<hours>:<minutes>:<seconds> and defaults to 0:0:30:0.

[services.owscommon]

http_service_url

Mandatory. This parameter is the actual domain and path URL to the OWS services served with the EOxServer instance. This parameter is used in various contexts and is also included in several OWS service responses.

resampling_method

Which resampling method to use e.g. ‘near’, ‘bilinear’, ‘average’, etc. Default: ‘near’

[services.ows.wms]

supported_formats=<MIME type>[,<MIME type>[,<MIME type> ... ]]

A comma-separated list of MIME-types defining the raster file format supported by the WMS getMap() operation. The MIME-types used for this option must be defined in the Format Registry (see “Supported Raster File Formats and Their Configuration”).

supported_crs= <EPSG-code>[,<EPSG-code>[,<EPSG-code> ... ]]

List of common CRSes supported by the WMS getMap() operation (see also “Supported CRSs and Their Configuration”).

[services.ows.wcs]

supported_formats=<MIME type>[,<MIME type>[,<MIME type> ... ]]

A comma-separated list of MIME-types defining the raster file format supported by the WCS getCoverage() operation. The MIME-types used for this option must be defined in the Format Registry (see “Supported Raster File Formats and Their Configuration”).

supported_crs= <EPSG-code>[,<EPSG-code>[,<EPSG-code> ... ]]

List of common CRSes supported by the WCS getMap() operation. (see also “Supported CRSs and Their Configuration”).

[services.ows.wcs20]

paging_count_default

The maximum number of wcs:coverageDescription elements returned in a WCS 2.0 EOCoverageSetDescription. This also limits the count parameter. Defaults to 10.

default_native_format=<MIME-type>

The default native format cases when the source format cannot be used (read-only GDAL driver) and there is no explicit source-to-native format mapping. This option must be always set to a valid format (GeoTIFF by default). The MIME-type used for this option must be defined in the Format Registry (see “Supported Raster File Formats and Their Configuration”).

source_to_native_format_map=[<src.MIME-type,native-MIME-type>[,<src.MIME-type,native-MIME-type> ... ]]

The explicit source to native format mapping. As the name suggests, it defines mapping of the (zero, one, or more) source formats to a non-defaults native formats. The source formats are not restricted to the read-only ones. This option accepts comma-separated list of MIME-type pairs. The MIME-types used for this option must be defined in the Format Registry (see “Supported Raster File Formats and Their Configuration”).

[services.ows.wcst11]

allow_multiple_actions

This flag enables/disables mutiple actions per WCSt request. Defaults to False.

NOTE: It is safer to keep this feature disabled. In case of a failure of one of the multiple actions, an OWS exception is returned without any notification which of the actions were actually performed, and which have not been performed at all. Therefore, we recomend to use only one action per request.

allowed_actions

Comma-separated list of allowed actions. Each item is one of Add, Delete, UpdateAll, UpdateMetadata and UpdateDataPart. By default no action is allowed and each needs to be explicitly activated. Currently, only the Add and Delete actions are implemented by the EOxServer.

path_wcst_temp

Mandatory. A path to an existing directory for temporary data storage during the WCS-T request processing. This should be a directory which is not used in any other context, since it might be cleared under certain circumstances.

path_wcst_perm

Mandatory. A path to a directory for permanent storage of transacted data. This is the final location where transacted datasets will be stored. It is also a place where the Delete action (when enabled) is allowed to remove the stored data.

[services.auth.base]

For detailed information about authorization refer to the documentation of the Identity Management System.

pdb_type

Determine the Policy Decision Point type; defaults to ‘none’ which deactives authorization.

authz_service

URL of the Authorization Service.

attribute_mapping

Path to an attribute dictionary for user attributes.

serviceID

Sets a custom service identifier

allowLocal

Allows full local access to the EOxServer. Use with care!

[webclient]

The following configuration options affect the behavior of the Webclient interface.

preview_service
outline_service

The service type for the outline and the preview layer in the webclient map. One of wms (default) or wmts.

preview_url
outline_url

The URL of the preview and outline service. Defaults to the vaule of the services.owscommon.http_service_url configuration option.

[testing]

These configuration options are used within the context of the Autotest instance.

binary_raster_comparison_enabled

Enable/disable the binary comparison of rasters in test runs. If disabled these tests will be skipped. By default this feature is activated but might be turned off in order to prevent test failures originating on platform differences.

rasdaman_enabled

Enable/disable rasdaman test cases. If disabled these tests will be skipped. Defaults to false.