base¶

You can split a configuration into multiple files with the base option. The base option loads the other files and merges the loaded configuration dictionaries together – it is not a literal include of the other files.

For example:

base: [mygrids.yaml, mycaches_sources.yaml]
service: ...
layers: ...

Changed in version 1.4.0: Support for recursive imports and for multiple files.

name¶

The name of the layer. You can omit the name for group layers (e.g. layers with layers), in this case the layer is not addressable in WMS and used only for grouping.

title¶

Readable name of the layer, e.g WMS layer title.

layers¶

Each layer can contain another layers configuration. You can use this to build group layers and to build a nested layer tree.

For example:

layers:
  - name: root
    title: Root Layer
    layers:
      - name: layer1
        title: Title of Layer 1
        layers:
          - name: layer1a
            title: Title of Layer 1a
            sources: [source1a]
          - name: layer1b
            title: Title of Layer 1b
            sources: [source1b]
      - name: layer2
        title: Title of Layer 2
        sources: [cache2]

root and layer1 is a group layer in this case. The WMS service will render layer1a and layer1b if you request layer1. Note that sources is optional if you supply layers. You can still configure sources for group layers. In this case the group sources will replace the sources of the child layers.

MapProxy will wrap all layers into an unnamed root layer, if you define multiple layers on the first level.

sources¶

A list of data sources for this layer. You can use sources defined in the sources and caches section. MapProxy will merge multiple sources from left (bottom) to right (top).

WMS and Mapserver sources also support tagged names (wms:lyr1,lyr2). See Tagged source names.

min_res, max_res or min_scale, max_scale¶

Limit the layer to the given min and max resolution or scale. MapProxy will return a blank image for requests outside of these boundaries (min_res is inclusive, max_res exclusive). You can use either the resolution or the scale values, missing values will be interpreted as unlimited. Resolutions should be in meters per pixel.

The values will also apear in the capabilities documents (i.e. WMS ScaleHint and Min/MaxScaleDenominator).

Pleas read scale vs. resolution for some notes on scale.

legendurl¶

Configure a URL to an image that should be returned as the legend for this layer. Local URLs (file://) are also supported. MapProxy ignores the legends from the sources of this layer if you configure a legendurl here.

md¶

New in version 1.4.0.

Add additional metadata for this layer. This metadata appears in the WMS 1.3.0 capabilities documents. Refer to the OGC 1.3.0 specification for a description of each option.

Here is an example layer with extended layer capabilities:

layers:
  - name: md_layer
    title: WMS layer with extended capabilities
    sources: [wms_source]
    md:
      abstract: Some abstract
      keyword_list:
        - vocabulary: Name of the vocabulary
          keywords:   [keyword1, keyword2]
        - vocabulary: Name of another vocabulary
          keywords:   [keyword1, keyword2]
        - keywords:   ["keywords without vocabulary"]
      attribution:
        title: My attribution title
        url:   http://example.org/
      logo:
         url:    http://example.org/logo.jpg
         width:  100
         height: 100
         format: image/jpeg
      identifier:
        - url:    http://example.org/
          name:   HKU1234
          value:  Some value
      metadata:
        - url:    http://example.org/metadata2.xml
          type:   INSPIRE
          format: application/xml
        - url:    http://example.org/metadata2.xml
          type:   ISO19115:2003
          format: application/xml
      data:
        - url:    http://example.org/datasets/test.shp
          format: application/octet-stream
        - url:    http://example.org/datasets/test.gml
          format: text/xml; subtype=gml/3.2.1
      feature_list:
        - url:    http://example.org/datasets/test.pdf
          format: application/pdf

dimensions¶

New in version 1.6.0.

Configure the dimensions that this layer supports. Dimensions should be a dictionary with one entry for each dimension. Each dimension is another dictionary with a list of values and an optional default value. When the default value is omitted, the last value will be used.

layers:
  - name: dimension_layer
    title: layer with dimensions
    sources: [cache]
    dimensions:
      time:
        values:
          - "2012-11-12T00:00:00"
          - "2012-11-13T00:00:00"
          - "2012-11-14T00:00:00"
          - "2012-11-15T00:00:00"
        default: "2012-11-15T00:00:00"
      elevation:
        values:
          - 0
          - 1000
          - 3000

sources¶

A list of data sources for this cache. You can use sources defined in the sources and caches section. This parameter is required. MapProxy will merge multiple sources from left (bottom) to right (top) before they are stored on disk.

WMS and Mapserver sources also support tagged names (wms:lyr1,lyr2). See Tagged source names.

format¶

The internal image format for the cache. Available options are image/png, image/jpeg etc. and mixed. The default is image/png.

New in version 1.5.0.

With the mixed format, MapProxy stores tiles as either PNG or JPEG, depending on the transparency of each tile. Images with transparency will be stored as PNG, fully opaque images as JPEG. You need to set the request_format to image/png when using mixed-mode:

caches:
  mixed_mode_cache:
    format: mixed
    request_format: image/png
    ...

request_format¶

MapProxy will try to use this format to request new tiles, if it is not set format is used. This option has no effect if the source does not support that format or the format of the source is set explicitly (see suported_format or format for sources).

link_single_color_images¶

If set to true, MapProxy will not store tiles that only contain a single color as a separate file. MapProxy stores these tiles only once and uses symbolic links to this file for every occurrence. This can reduce the size of your tile cache if you have larger areas with no data (e.g. water areas, areas with no roads, etc.).

minimize_meta_requests¶

If set to true, MapProxy will only issue a single request to the source. This option can reduce the request latency for uncached areas (on demand caching).

By default MapProxy requests all uncached meta tiles that intersect the requested bbox. With a typical configuration it is not uncommon that a requests will trigger four requests each larger than 2000x2000 pixel. With the minimize_meta_requests option enabled, each request will trigger only one request to the source. That request will be aligned to the next tile boundaries and the tiles will be cached.

watermark¶

Add a watermark right into the cached tiles. The watermark is thus also present in TMS or KML requests.

text

The watermark text. Should be short.

opacity

The opacity of the watermark (from 0 transparent to 255 full opaque). Use a value between 30 and 100 for unobtrusive watermarks.

font_size

Font size of the watermark text.

color

Color of the watermark text. Default is grey which works good for vector images. Can be either a list of color values ([255, 255, 255]) or a hex string (#ffffff).

spacing

Configure the spacing between repeated watermarks. By default the watermark will be placed on every tile, with wide the watermark will be placed on every second tile.

grids¶

You can configure one or more grids for each cache. MapProxy will create one cache for each grid.

grids: ['my_utm_grid', 'GLOBAL_MERCATOR']

MapProxy supports on-the-fly transformation of requests with different SRSs. So it is not required to add an extra cache for each supported SRS. For best performance only the SRS most requests are in should be used.

There is some special handling for layers that need geographical and projected coordinate systems. For example, if you set one grid with EPSG:4326 and one with EPSG:3857 then all requests for projected SRS will access the EPSG:3857 cache and requests for geographical SRS will use EPSG:4326.

meta_size and meta_buffer¶

Change the meta_size and meta_buffer of this cache. See global cache options for more details.

image¶

See below for all image options.

use_direct_from_level and use_direct_from_res¶

You can limit until which resolution MapProxy should cache data with these two options. Requests below the configured resolution or level will be passed to the underlying source and the results will not be stored. The resolution of use_direct_from_res should use the units of the first configured grid of this cache. This takes only effect when used in WMS services.

disable_storage¶

If set to true, MapProxy will not store any tiles for this cache. MapProxy will re-request all required tiles for each incoming request, even if the there are matching tiles in the cache. See seed_only if you need an offline mode.

cache_dir¶

Directory where MapProxy should store tiles for this cache. Uses the value of globals.cache.base_dir by default. MapProxy will store each cache in a subdirectory named after the cache and the grid SRS (e.g. cachename_EPSG1234). See directory option on how configure a complete path.

cache¶

New in version 1.2.0.

Configure the type of the background tile cache. You configure the type with the type option. The default type is file and you can leave out the cache option if you want to use the file cache. Read Caches for a detailed list of all available cache backends.

Example caches configuration¶

caches:
 simple:
   source: [mysource]
   grids: [mygrid]
 fullexample:
   source: [mysource, mysecondsource]
   grids: [mygrid, mygrid2]
   meta_size: [8, 8]
   meta_buffer: 256
   watermark:
     text: MapProxy
   request_format: image/tiff
   format: image/jpeg
   cache:
     type: file
     directory_layout: tms

name¶

Overwrite the name of the grid used in WMTS URLs. The name is also used in TMS and KML URLs when the use_grid_names option of the services is set to true.

srs¶

The spatial reference system used for the internal cache, written as EPSG:xxxx.

tile_size¶

The size of each tile. Defaults to 256x256 pixel.

tile_size: [512, 512]

res¶

A list with all resolutions that MapProxy should cache.

res: [1000, 500, 200, 100]

res_factor¶

Here you can define a factor between each resolution. It should be either a number or the term sqrt2. sqrt2 is a shorthand for a resolution factor of 1.4142, the square root of two. With this factor the resolution doubles every second level. Compared to the default factor 2 you will get another cached level between all standard levels. This is suited for free zooming in vector-based layers where the results might look to blurry/pixelated in some resolutions.

For requests with no matching cached resolution the next best resolution is used and MapProxy will transform the result.

threshold_res¶

A list with resolutions at which MapProxy should switch from one level to another. MapProxy automatically tries to determine the optimal cache level for each request. You can tweak the behavior with the stretch_factor option (see below).

If you need explicit transitions from one level to another at fixed resolutions, then you can use the threshold_res option to define these resolutions. You only need to define the explicit transitions.

Example: You are caching at 1000, 500 and 200m/px resolutions and you are required to display the 1000m/px level for requests with lower than 700m/px resolutions and the 500m/px level for requests with higher resolutions. You can define that transition as follows:

res: [1000, 500, 200]
threshold_res: [700]

Requests with 1500, 1000 or 701m/px resolution will use the first level, requests with 700 or 500m/px will use the second level. All other transitions (between 500 an 200m/px in this case) will be calculated automatically with the stretch_factor (about 416m/px in this case with a default configuration).

bbox¶

The extent of your grid. You can use either a list or a string with the lower left and upper right coordinates. You can set the SRS of the coordinates with the bbox_srs option. If that option is not set the srs of the grid will be used.

bbox: [0, 40, 15, 55]
  or
bbox: "0,40,15,55"

bbox_srs¶

The SRS of the grid bbox. See above.

origin¶

New in version 1.3.0.

The default origin (x=0, y=0) of the tile grid is the lower left corner, similar to TMS. WMTS defines the tile origin in the upper left corner. MapProxy can translate between services and caches with different tile origins, but there are some limitations for grids with custom BBOX and resolutions that are not of factor 2. You can only use one service in these cases and need to use the matching origin for that service.

The following values are supported:

ll or sw:

If the x=0, y=0 tile is in the lower-left/south-west corner of the tile grid. This is the default.

ul or nw:

If the x=0, y=0 tile is in the upper-left/north-west corner of the tile grid.

num_levels¶

The total number of cached resolution levels. Defaults to 20, except for grids with sqrt2 resolutions. This option has no effect when you set an explicit list of cache resolutions.

min_res and max_res¶

The the resolutions of the first and the last level.

stretch_factor¶

MapProxy chooses the optimal cached level for requests that do not exactly match any cached resolution. MapProxy will stretch or shrink images to the requested resolution. The stretch_factor defines the maximum factor MapProxy is allowed to stretch images. Stretched images result in better performance but will look blurry when the value is to large (> 1.2).

Example: Your MapProxy caches 10m and 5m resolutions. Requests with 9m resolution will be generated from the 10m level, requests for 8m from the 5m level.

max_shrink_factor¶

This factor only applies for the first level and defines the maximum factor that MapProxy will shrink images.

Example: Your MapProxy layer starts with 1km resolution. Requests with 3km resolution will get a result, requests with 5km will get a blank response.

base¶

With this option, you can base the grid on the options of another grid you already defined.

Defining Resolutions¶

There are multiple options that influence the resolutions MapProxy will use for caching: res, res_factor, min_res, max_res, num_levels and also bbox and tile_size. We describe the process MapProxy uses to build the list of all cache resolutions.

If you supply a list with resolution values in res then MapProxy will use this list and will ignore all other options.

If min_res is set then this value will be used for the first level, otherwise MapProxy will use the resolution that is needed for a single tile (tile_size) that contains the whole bbox.

If you have max_res and num_levels: The resolutions will be distributed between min_res and max_res, both resolutions included. The resolutions will be logarithmical, so you will get a constant factor between each resolution. With resolutions from 1000 to 10 and 6 levels you would get 1000, 398, 158, 63, 25, 10 (rounded here for readability).

If you have max_res and res_factor: The resolutions will be multiplied by res_factor until larger then max_res.

If you have num_levels and res_factor: The resolutions will be multiplied by res_factor for up to num_levels levels.

Example grids configuration¶

grids:
  localgrid:
    srs: EPSG:31467
    bbox: [5,50,10,55]
    bbox_srs: EPSG:4326
    min_res: 10000
    res_factor: sqrt2
  localgrid2:
    base: localgrid
    srs: EPSG:25832
    tile_size: [512, 512]

image¶

Here you can define some options that affect the way MapProxy generates image results.

resampling_method

The resampling method used when results need to be rescaled or transformed. You can use one of nearest, bilinear or bicubic. Nearest is the fastest and bicubic the slowest. The results will look best with bilinear or bicubic. Bicubic enhances the contrast at edges and should be used for vector images.

With bilinear you should get about 2/3 of the nearest performance, with bicubic 1/3.

See the examples below:

nearest:

bilinear:

bicubic:

paletted

Enable paletted (8bit) PNG images. It defaults to true for backwards compatibility. You should set this to false if you need 24bit PNG files. You can enable 8bit PNGs for single caches with a custom format (colors: 256).

formats

Modify existing or define new image formats. See below for all image format options.

cache¶

New in version 1.6.0: tile_lock_dir

meta_size

MapProxy does not make a single request for every tile but will request a large meta-tile that consist of multiple tiles. meta_size defines how large a meta-tile is. A meta_size of [4, 4] will request 16 tiles in one pass. With a tile size of 256x256 this will result in 1024x1024 requests to the source WMS.

meta_buffer

MapProxy will increase the size of each meta-tile request by this number of pixels in each direction. This can solve cases where labels are cut-off at the edge of tiles.

base_dir

The base directory where all cached tiles will be stored. The path can either be absolute (e.g. /var/mapproxy/cache) or relative to the mapproxy.yaml file. Defaults to ./cache_data.

lock_dir

MapProxy uses locking to limit multiple request to the same service. See concurrent_requests. This option defines where the temporary lock files will be stored. The path can either be absolute (e.g. /tmp/lock/mapproxy) or relative to the mapproxy.yaml file. Defaults to ./cache_data/tile_locks.

tile_lock_dir

MapProxy uses locking to prevent that the same tile gets created multiple times. This option defines where the temporary lock files will be stored. The path can either be absolute (e.g. /tmp/lock/mapproxy) or relative to the mapproxy.yaml file. Defaults to ./cache_data/dir_of_the_cache/tile_locks.

concurrent_tile_creators

This limits the number of parallel requests MapProxy will make to a source WMS. This limit is per request and not for all MapProxy requests. To limit the requests MapProxy makes to a single server use the concurrent_requests option.

Example: A request in an uncached region requires MapProxy to fetch four meta-tiles. A concurrent_tile_creators value of two allows MapProxy to make two requests to the source WMS request in parallel. The splitting of the meta tile and the encoding of the new tiles will happen in parallel to.

srs¶

proj_data_dir

MapProxy uses Proj4 for all coordinate transformations. If you need custom projections or need to tweak existing definitions (e.g. add towgs parameter set) you can point MapProxy to your own set of proj4 init files. The path should contain an epsg file with the EPSG definitions.

The configured path can be absolute or relative to the mapproxy.yaml.

axis_order_ne and axis_order_en

The axis ordering defines in which order coordinates are given, i.e. lon/lat or lat/lon. The ordering is dependent to the SRS. Most clients and servers did not respected the ordering and everyone used lon/lat ordering. With the WMS 1.3.0 specification the OGC emphasized that the axis ordering of the SRS should be used.

Here you can define the axis ordering of your SRS. This might be required for proper WMS 1.3.0 support if you use any SRS that is not in the default configuration.

By default MapProxy assumes lat/long (north/east) order for all geographic and x/y (east/north) order for all projected SRS.

You need to add the SRS name to the appropriate parameter, if that is not the case for your SRS.:

srs:
  # for North/East ordering
  axis_order_ne: ['EPSG:9999', 'EPSG:9998']
  # for East/North ordering
  axis_order_en: ['EPSG:0000', 'EPSG:0001']

If you need to override one of the default values, then you need to define both axis order options, even if one is empty.

http¶

HTTP related options.

http:
  ssl_ca_certs: /etc/ssl/certs/ca-certificates.crt

http:
  ssl_no_cert_checks: True

http:
  method: GET

http:
  headers:
    My-Header: header value

tiles¶

Configuration options for the TMS/Tile service.

expires_hours

The number of hours a Tile is valid. TMS clients like web browsers will cache the tile for this time. Clients will try to refresh the tiles after that time. MapProxy supports the ETag and Last-Modified headers and will respond with the appropriate HTTP ‘304 Not modified’ response if the tile was not changed.

mapserver¶

Options for the Mapserver source.

Options¶

Available options are:

format

The mime-type of this image format. The format defaults to the name of the image configuration.

mode

One of RGB for 24bit images, RGBA 32bit images with alpha, P for paletted images or I for integer images.

colors

The number of colors to reduce the image before encoding. Use 0 to disable color reduction (quantizing) for this format and 256 for paletted images. See also globals.image.paletted.

transparent

true if the image should have an alpha channel.

resampling_method

The resampling method used for scaling or reprojection. One of nearest, bilinear or bicubic.

encoding_options

Options that modify the way MapProxy encodes (saves) images. These options are format dependent. See below.

opacity

Configures the opacity of a layer or cache. This value is used when the source or cache is placed on other layers and it can be used to overlay non-transparent images. It does not alter the image itself, and only effects when multiple layers are merged to one image. The value should be between 0.0 (full transparent) and 1.0 (opaque, i.e. the layers below will not be rendered).

Global¶

You can configure image formats globally with the image.formats option. Each format has a name and one or more options from the list above. You can choose any name, but you need to specify a format if the name is not a valid mime-type (e.g. myformat instead of image/png).

Here is an example that defines a custom format:

globals:
  image:
    formats:
      my_format:
        format: image/png
        mode: P
        transparent: true

You can also modify existing image formats:

globals:
  image:
    formats:
      image/png:
        encoding_options:
          quantizer: fastoctree

MapProxy will use your image formats when you are using the format name as the format of any source or cache.

For example:

caches:
  mycache:
    format: my_format
    sources: [source1, source2]
    grids: [my_grid]

Local¶

You can change all options individually for each cache or source. You can do this by choosing a base format and changing some options:

caches:
  mycache:
    format: image/jpeg
    image:
      encoding_options:
        jpeg_quality: 80
    sources: [source1, source2]
    grids: [my_grid]

You can also configure the format from scratch:

caches:
  mycache:
    image:
      format: image/jpeg
      resampling_method: nearest
    sources: [source1, source2]
    grids: [my_grid]

Scale vs. resolution¶

Scale is the ratio of a distance on a map and the corresponding distance on the ground. This implies that the map distance and the ground distance are measured in the same unit. For MapProxy a map is just a collection of pixels and the pixels do not have any size/dimension. They do correspond to a ground size but the size on the map is depended of the physical output format. MapProxy can thus only work with resolutions (pixel per ground unit) and not scales.

This applies to all servers and the OGC WMS standard as well. Some neglect this fact and assume a fixed pixel dimension (like 72dpi), the OCG WMS 1.3.0 standard uses a pixel size of 0.28 mm/px (around 91dpi). But you need to understand that a scale will differ if you print a map (200, 300 or more dpi) or if you show it on a computer display (typical 90-120 dpi, but there are mobile devices with more than 300 dpi).

You can convert between scales and resolutions with the mapproxy-util scales tool.

MapProxy will use the OCG value (0.28mm/px) if it’s necessary to use a scale value (e.g. MinScaleDenominator in WMS 1.3.0 capabilities), but you should always use resolutions within MapProxy.