attribution¶

Adds an attribution (copyright) line to all WMS requests.

text

The text line of the attribution (e.g. some copyright notice, etc).

md¶

md is for metadata. These fields are used for the WMS GetCapabilities responses. See the example below for all supported keys.

srs¶

The srs option defines which SRS the WMS service supports.:

srs: ['EPSG:4326', 'CRS:84', 'EPSG:900913']

See axis order for further configuration that might be needed for WMS 1.3.0.

bbox_srs¶

New in version 1.3.0.

The bbox_srs option controls in which SRS the BBOX is advertised in the capabilities document. It should only contain SRS that are configured in the srs option.

You need to make sure that all layer extents are valid for these SRS. E.g. you can’t choose a local SRS like UTM if you’re using a global grid without limiting all sources with a coverage.

image_formats¶

A list of image mime types the server should offer.

featureinfo_types¶

A list of feature info types the server should offer. Available types are text, html and xml. The types then are advertised in the capabilities with the correct mime type.

featureinfo_xslt¶

You can define XSLT scripts to transform outgoing feature information. You can define scripts for different feature info types:

html

Define a script for INFO_FORMAT=text/html requests.

xml

Define a script for INFO_FORMAT=application/vnd.ogc.gml and INFO_FORMAT=text/xml requests.

See FeatureInformation for more informaiton.

strict¶

Some WMS clients do not send all required parameters in feature info requests, MapProxy ignores these errors unless you set strict to true.

on_source_errors¶

Configure what MapProxy should do when one or more sources return errors or no response at all (e.g. timeout). The default is notify, which adds a text line in the image response for each erroneous source, but only if a least one source was successful. When on_source_errors is set to raise, MapProxy will return an OGC service exception in any error case.

max_output_pixels¶

New in version 1.3.0.

The maximum output size for a WMS requests in pixel. MapProxy returns an WMS exception in XML format for requests that are larger. Defaults to [4000, 4000] which will limit the maximum output size to 16 million pixels (i.e. 5000x3000 is still allowed).

Full example¶

services:
  wms:
    srs: ['EPSG:4326', 'CRS:83', 'EPSG:900913']
    image_formats: ['image/png', 'image/jpeg']
    attribution:
      text: "© MyCompany"
    md:
      title: MapProxy WMS Proxy
      abstract: This is the fantastic MapProxy.
      online_resource: http://mapproxy.org/
      contact:
        person: Your Name Here
        position: Technical Director
        organization:
        address: Fakestreet 123
        city: Somewhere
        postcode: 12345
        country: Germany
        phone: +49(0)000-000000-0
        fax: +49(0)000-000000-0
        email: you@example.org
      access_constraints: This service is intended for private and evaluation use only.
      fees: 'None'

WMS-C¶

The MapProxy WMS service also supports the WMS Tiling Client Recommendation from OSGeo.

If you add tiled=true to the GetCapabilities request, MapProxy will add metadata about the internal tile structure to the WMS capabilities document. Clients that support WMS-C can use this information to request tiles at the exact tile boundaries. MapProxy can return the tile as-it-is for these requests, the performace is on par with the TMS service.

MapProxy will limit the WMS support when tiled=true is added to the GetMap requests and it will return WMS service exceptions for requests that do not match the exact tile boundaries or if the requested image size or format differs.

use_grid_names¶

New in version 1.5.0.

When set to true, MapProxy uses the actual name of the grid as the grid identifier instead of the SRS code. Tiles will then be available under /tms/1.0.0/mylayer/mygrid/ instead of /tms/1.0.0/mylayer/EPSG1234/ or /tms/1.0.0/mylayer_EPSG1234/.

Example¶

services:
  tms:
    use_grid_names: true

OpenLayers¶

When you create a map in OpenLayers with an explicit mapExtent, it will request only a single tile for the first (z=0) level. TMS begins with two or four tiles by default, depending on the SRS. MapProxy supports a different TMS mode to support this use-case. MapProxy will start with a single-tile level if you request /tiles instead of /tms.

Alternatively, you can use the OpenLayers TMS option zoomOffset to compensate the difference. The option is available since OpenLayers 2.10.

There is an example available at the configuration-examples section, which shows the use of OpenLayers in combination with an overlay of tiles on top of OpenStreetMap tiles.

Google Maps¶

The TMS standard counts tiles starting from the lower left corner of the tile grid, while Google Maps and compatible services start at the upper left corner. The /tiles service accepts an origin parameter that flips the y-axis accordingly. You can set it to either sw (south-west), the default, or to nw (north-west), required for Google Maps.

Example:

http://localhost:8080/tiles/osm_EPSG900913/1/0/1.png?origin=nw

New in version 1.5.0: You can use the origin option of the TMS service to change the default origin of the tiles service. If you set it to nw then you can leave the ?origin=nw parameter from the URL. This only works for the tiles service at /tiles, not for the TMS at /tms/1.0.0/.

Example:

services:
  tms:
    origin: 'nw'

use_grid_names¶

New in version 1.5.0.

When set to true, MapProxy uses the actual name of the grid as the grid identifier instead of the SRS code. Tiles will then be available under /kml/mylayer/mygrid/ instead of /kml/mylayer/EPSG1234/.

Example¶

services:
  kml:
    use_grid_names: true

KVP¶

MapProxy supports GetCapabilities and GetTile KVP requests. The KVP service is available at /service.

You can enable or disable the KVP service with the kvp option. It is enabled by default and you need to enable restful if you disable this one.

services:
  wmts:
    kvp: false
    restful: true

RESTful¶

New in version 1.3.0.

MapProxy supports RESTful WMTS requests with custom URL templates. The RESTful service capabilities are available at /wmts/1.0.0/WMTSCapabilities.xml.

You can enable or disable the RESTful service with the restful option. It is enabled by default and you need to enable kvp if you disable this one.

services:
  wmts:
    restful: false
    kvp: true

services:
  wmts:
    restful: true
    restful_template:
        '/1.0.0/{Layer}-{TileMatrixSet}/{TileMatrix}-{TileCol}-{TileRow}/tile'