Configuration reference

This section formally describes the GBD WebSuite configuration, which is nested key-value structure. The keys are always strings, the values should belong to one of the types listed below.

The top-level configuration is of type application.Config.

Basic types

Fundamental data types, as used in the Python language.

str string, must be in the UTF-8 encoding
bool boolean true or false
int integer number
float real number
dict generic key-value object
[ Type ] list (array) of elements of type Type

Access

Access rights definition for authorization roles

Properties:

name type   required default
role str a role to which this rule applies yes  
type AccessType access type (deny or allow) yes  
uid str unique ID no  

AccessType

One of:

  • "allow"
  • "deny"

AttributeType

One of:

  • "bool"
  • "bytes"
  • "date"
  • "datetime"
  • "float"
  • "geometry"
  • "int"
  • "list"
  • "str"
  • "text"
  • "time"

Crs

CRS code like “EPSG:3857

Date

ISO date like “2019-01-30”

DirPath

Valid readable directory path on the server

Duration

String like “1w 2d 3h 4m 5s” or a number of seconds

Extent

An array of 4 elements representing extent coordinates [minx, miny, maxx, maxy]

FilePath

Valid readable file path on the server

FormatStr

String with {attribute} placeholders

GeometryType

One of:

  • "curve"
  • "geomcollection"
  • "geometry"
  • "linestring"
  • "multicurve"
  • "multilinestring"
  • "multipoint"
  • "multipolygon"
  • "multisurface"
  • "point"
  • "polygon"
  • "polyhedralsurface"
  • "surface"

Point

Point coordinates [x, y]

Regex

Regular expression, as used in Python

StyleType

One of:

  • "css"
  • "cssSelector"

TemplateQualityLevel

Properties:

name type   required default
dpi int   yes  
name str   yes  

Url

Http or https URL

action.alkisgeocoder.Config

ALKIS Geocoder action.

Properties:

name type   required default
access [ Access ] access rights no  
type str object type yes  
uid str unique ID no  

action.alkissearch.BuchungConfig

Access to the Grundbuch (register) information

Properties:

name type   required default
access [ Access ] access rights no  
uid str unique ID no  

action.alkissearch.Config

Flurstückssuche (cadaster parlcels search) action

Properties:

name type   required default
access [ Access ] access rights no  
buchung action.alkissearch.BuchungConfig access to the Grundbuch (register) information no  
eigentuemer action.alkissearch.EigentuemerConfig access to the Eigentümer (owner) information no  
export helper.alkis.util.export.Config csv export configuration no  
helper str ALKIS helper uid no  
limit int search results limit no 100
printTemplate template.Config template for printed Flurstueck details no  
templates [ template.Config ] templates for on-screen Flurstueck details no  
type str object type yes  
ui action.alkissearch.UiConfig ui options no  
uid str unique ID no  

action.alkissearch.EigentuemerConfig

Access to the Eigentümer (owner) information

Properties:

name type   required default
access [ Access ] access rights no  
controlMode bool restricted mode enabled no false
controlRules [ str ] regular expression for the restricted input control no  
logTable str data access protocol table name no  
uid str unique ID no  

action.alkissearch.UiBblattSearchMode

One of:

  • "any"
  • "end"
  • "exact"
  • "start"

action.alkissearch.UiConfig

Flurstückssuche UI configuration.

Properties:

name type   required default
autoSpatialSearch bool activate spatial search after submit no false
bblattSearchMode action.alkissearch.UiBblattSearchMode buchungsblatt search mode no "any"
gemarkungListMode action.alkissearch.UiGemarkungListMode gemarkung list mode no "combined"
searchSelection bool search in selection enabled no false
searchSpatial bool spatial search enabled no false
strasseListMode action.alkissearch.UiStrasseListMode strasse list entry format no "plain"
strasseSearchMode action.alkissearch.UiStrasseSearchMode strasse search mode no "start"
uid str unique ID no  
useExport bool export function enabled no false
usePick bool pick mode enabled no false
useSelect bool select mode enabled no false

action.alkissearch.UiGemarkungListMode

One of:

  • "combined"
  • "none"
  • "plain"
  • "tree"

action.alkissearch.UiStrasseListMode

One of:

  • "plain"
  • "withGemarkung"
  • "withGemarkungIfRepeated"
  • "withGemeinde"
  • "withGemeindeIfRepeated"

action.alkissearch.UiStrasseSearchMode

One of:

  • "any"
  • "start"

action.asset.Config

Asset generation action

Properties:

name type   required default
access [ Access ] access rights no  
type str object type yes  
uid str unique ID no  

action.auth.Config

Authorization action

Properties:

name type   required default
access [ Access ] access rights no  
type str object type yes  
uid str unique ID no  

action.bplan.AdministrativeUnitConfig

Properties:

name type   required default
access [ Access ] access rights no  
name str   yes  
uid str   yes  

action.bplan.Config

Construction plans management action

Properties:

name type   required default
access [ Access ] access rights no  
administrativeUnits [ action.bplan.AdministrativeUnitConfig ] Administrative Units yes  
crs Crs CRS for the bplan data yes  
dataDir DirPath data directory yes  
db str database provider ID no  
exportDataModel model.Config data model for csv export no  
imageQuality int palette size for optimized images no 24
metaTable db.SqlTableConfig meta table configuration yes  
planTable db.SqlTableConfig plan table configuration yes  
planTypes [ action.bplan.PlanTypeConfig ] Plan Types yes  
templates [ template.Config ] templates yes  
type str object type yes  
uid str unique ID no  
uploadChunkSize int upload chunk size in mb yes  

action.bplan.PlanTypeConfig

Properties:

name type   required default
color str   yes  
name str   yes  
srcName str   yes  
uid str   yes  

action.dimension.Config

Dimension action

Properties:

name type   required default
access [ Access ] access rights no  
layers [ str ] target layer uids no  
pixelTolerance int pixel tolerance no 10
type str object type yes  
uid str unique ID no  

action.dprocon.Config

D-Procon connector action

Properties:

name type   required default
access [ Access ] access rights no  
cacheTime Duration request cache life time no "24h"
dataTableName str table to store consolidated results yes  
dataTablePattern str pattern for result tables to consolidate yes  
gemeindeFilter [ str ] gemeinde (AU) ids to keep in the index no  
infoTitle str information box title no  
requestTableName str table to store outgoing requests yes  
requestUrl Url main program url, with the placholder {REQUEST_ID} yes  
templates [ template.Config ] feature formatting templates no  
type str object type yes  
uid str unique ID no  

action.edit.Config

Feature edit action

Properties:

name type   required default
access [ Access ] access rights no  
type str object type yes  
uid str unique ID no  

action.fs.Config

File system action

Properties:

name type   required default
access [ Access ] access rights no  
root DirPath file system root yes  
type str object type yes  
uid str unique ID no  

action.fsinfo.Config

FSInfo action

Properties:

name type   required default
access [ Access ] access rights no  
dataTable db.SqlTableConfig   yes  
db str database provider uid no  
documentTable db.SqlTableConfig   yes  
templates [ template.Config ] client templates no  
type str object type yes  
uid str unique ID no  

action.gekos.Config

GekoS action

Properties:

name type   required default
access [ Access ] access rights no  
crs Crs CRS for gekos data no  
db str database provider uid no  
position action.gekos.PositionConfig position correction for points no  
sources [ action.gekos.SourceConfig ] gek-online instances no  
table db.SqlTableConfig sql table configuration yes  
templates [ template.Config ] feature formatting templates no  
type str object type yes  
uid str unique ID no  

action.gekos.PositionConfig

Properties:

name type   required default
angle int angle for points repelling no 0
distance int radius for points repelling no 0
offsetX int x-offset for points yes  
offsetY int y-offset for points yes  
uid str unique ID no  

action.gekos.SourceConfig

Properties:

name type   required default
instance str instance name for this source yes  
params dict additional parameters for gek-online calls yes  
uid str unique ID no  
url Url gek-online base url yes  

action.map.Config

Map rendering action

Properties:

name type   required default
access [ Access ] access rights no  
type str object type yes  
uid str unique ID no  

action.ows.Config

OWS server action

Properties:

name type   required default
access [ Access ] access rights no  
services [ ows.service.Config ] services configuration no  
type str object type yes  
uid str unique ID no  

action.printer.Config

Print action

Properties:

name type   required default
access [ Access ] access rights no  
type str object type yes  
uid str unique ID no  

action.project.Config

Project information action

Properties:

name type   required default
access [ Access ] access rights no  
type str object type yes  
uid str unique ID no  

action.search.Config

Search action

Properties:

name type   required default
access [ Access ] access rights no  
limit int search results limit no 1000
type str object type yes  
uid str unique ID no  

action.storage.Config

Storage action

Properties:

name type   required default
access [ Access ] access rights no  
type str object type yes  
uid str unique ID no  

action.tabedit.Config

Table Editor action

Properties:

name type   required default
access [ Access ] access rights no  
db str database provider uid no  
tables [ action.tabedit.TableConfig ]   yes  
type str object type yes  
uid str unique ID no  

action.tabedit.TableConfig

Properties:

name type   required default
dataModel model.Config table data model no  
disableAddButton bool disable the ‘add’ button no  
sort str sort expression no  
table db.SqlTableConfig sql table configurations yes  
title str   no  
uid str unique ID no  
widths [ int ] column widths, 0 to exclude no  
withFilter bool use filter boxes no  

api.Config

Server actions

Properties:

name type   required default
access [ Access ] access rights no  
actions [ action.Config ] available actions no  
uid str unique ID no  

application.Config

Main application configuration

Properties:

name type   required default
access [ Access ] access rights no  
api api.Config system-wide server actions no  
auth auth.Config authorization methods and options no  
client client.Config gws client configuration no  
db application.DbConfig database configuration no  
developer dict developer options no  
fonts application.FontConfig fonts configuration no  
helpers [ helper.Config ] helpers configurations no  
locales [ str ] default locales for all projects no  
meta metadata.Config application metadata no  
projectDirs [ DirPath ] directories with additional projects no  
projectPaths [ FilePath ] additional project paths no  
projects [ project.Config ] project configurations no  
seeding application.SeedingConfig configuration for seeding jobs no  
server server.Config server engine options no  
timeZone str timezone for this server no "UTC"
uid str unique ID no  
web application.WebConfig webserver configuration no  

application.DbConfig

Database configuration

Properties:

name type   required default
providers [ db.provider.Config ] database providers yes  
uid str unique ID no  

application.FontConfig

Fonts configuration.

Properties:

name type   required default
dir DirPath directory with custom fonts yes  
uid str unique ID no  

application.SSLConfig

SSL configuration

Properties:

name type   required default
crt FilePath crt bundle location yes  
key FilePath key file location yes  
uid str unique ID no  

application.SeedingConfig

Cache seeding options

Properties:

name type   required default
concurrency int number of concurrent seeding jobs no 1
maxTime Duration max. time for a seeding job no 600
uid str unique ID no  

application.WebConfig

Web server configuration

Properties:

name type   required default
sites [ web.site.Config ] configured sites no  
ssl application.SSLConfig ssl configuration no  
uid str unique ID no  

auth.Config

Authentication and authorization options

Properties:

name type   required default
methods [ auth.method.Config ] authorization methods no  
providers [ auth.provider.Config ] authorization providers yes  
sessionLifeTime Duration session life time no 1200
sessionStorage str session storage engine no "sqlite"
uid str unique ID no  

auth.method.basic.Config

HTTP-basic authorization options

Properties:

name type   required default
secure bool use only with SSL no true
type str object type yes  
uid str unique ID no  

auth.method.web.Config

Web-based authorization options

Properties:

name type   required default
cookieName str name for the cookie no "auth"
cookiePath str cookie path no "/"
secure bool use only with SSL no true
type str object type yes  
uid str unique ID no  

auth.provider.file.Config

File-based authorization provider

Properties:

name type   required default
allowedMethods [ str ] allowed authorization methods no  
path FilePath path to the users json file yes  
type str object type yes  
uid str unique ID no  

auth.provider.ldap.Config

LDAP authorization provider

Properties:

name type   required default
activeDirectory bool true if the LDAP server is ActiveDirectory no true
allowedMethods [ str ] allowed authorization methods no  
bindDN str bind DN yes  
bindPassword str bind password yes  
displayNameFormat FormatStr format for user’s display name no "{dn}"
timeout Duration LDAP server timeout no 30
type str object type yes  
uid str unique ID no  
url str LDAP server url “ldap://host:port/baseDN?searchAttribute” yes  
users [ auth.provider.ldap.UserSpec ] map LDAP filters to gws roles yes  

auth.provider.ldap.UserSpec

Map LDAP filters to authorization roles

Properties:

name type   required default
matches str LDAP filter the account has to match no  
memberOf str LDAP group the account has to be a member of no  
roles [ str ] role names yes  

client.Config

GWS client configuration

Properties:

name type   required default
access [ Access ] access rights no  
addElements [ client.ElementConfig ] add elements to the parent element list no  
elements [ client.ElementConfig ] client UI elements no  
options dict client options no  
removeElements [ client.ElementConfig ] remove elements from the parent element list no  
uid str unique ID no  

client.ElementConfig

GWS client UI element configuration

Properties:

name type   required default
access [ Access ] access rights no  
after str insert after this tag no  
before str insert before this tag no  
tag str element tag yes  
uid str unique ID no  

db.SqlTableConfig

SQL database table

Properties:

name type   required default
geometryColumn str geometry column name no  
keyColumn str primary key column name no  
name str table name yes  
searchColumn str column to be searched for no  
uid str unique ID no  

db.provider.Config

One of:

db.provider.postgres.Config

Postgres/Postgis database provider

Properties:

name type   required default
connectTimeout Duration connect timeout no 0
database str database name no  
host str database host no "localhost"
password str password yes  
port int database port no 5432
timeout Duration query timeout no 0
type str object type yes  
uid str unique id yes  
user str username yes  

gis.source.LayerFilter

Source layer filter

Properties:

name type   required default
level int match only layers at this level no 0
names [ str ] match these layer names (top-to-bottom order) no  
pattern Regex match layers whose full path matches a pattern no  
uid str unique ID no  

gis.zoom.Config

Zoom levels and resolutions

Properties:

name type   required default
initResolution float initial resolution no  
initScale float initial scale no  
maxResolution float maximal resolution no  
maxScale float maximal scale no  
minResolution float minimal resolution no  
minScale float minimal scale no  
resolutions [ float ] allowed resolutions no  
scales [ float ] allowed scales no  
uid str unique ID no  

helper.alkis.Config

ALKIS helper.

Properties:

name type   required default
crs Crs CRS for the ALKIS data yes  
dataSchema str schema where ALKIS tables are stored no "public"
db str database provider ID no  
excludeGemarkung [ str ] Gemarkung (Administrative Unit) IDs to exclude from search no  
indexSchema str schema to store GWS internal indexes no "gws"
type str object type yes  
uid str unique ID no  

helper.alkis.util.export.Config

CSV Export configuration

Properties:

name type   required default
access [ Access ] access rights no  
groups [ helper.alkis.util.export.GroupConfig ] export groups no  
uid str unique ID no  

helper.alkis.util.export.GroupConfig

Export group configuration

Properties:

name type   required default
buchung bool include Grundbuch (register) data no false
dataModel model.Config data model for this group no  
eigentuemer bool include Eigentuemer (owner) data no false
title str title for this group yes  
uid str unique ID no  

helper.csv.Config

CSV format settings

Properties:

name type   required default
decimal str decimal sign no "."
delimiter str field delimiter no ","
encoding str encoding for CSV files no "utf8"
formulaHack bool prepend numeric strings with an equal sign no true
precision int precision for floats no 2
quoteAll bool quote all fields no false
quote str quote sign no "\""
rowDelimiter str row delimiter no "\n"
type str object type yes  
uid str unique ID no  

helper.storage.Backend

One of:

  • "sqlite"

helper.storage.Config

Storage helper

Properties:

name type   required default
backend helper.storage.Backend backend type yes  
path str path to the storage file no  
permissions [ helper.storage.PermissionRule ] permission rules no  
type str object type yes  
uid str unique ID no  

helper.storage.Mode

One of:

  • "all"
  • "read"
  • "write"

helper.storage.PermissionRule

Permission rule for a storage category

Properties:

name type   required default
access [ Access ] access rights no  
category str storage category name yes  
mode helper.storage.Mode allowed mode (read/write) yes  
uid str unique ID no  

helper.xml.Config

XML settings

Properties:

name type   required default
namespaces [ helper.xml.NamespaceConfig ] custom namespaces no  
type str object type yes  
uid str unique ID no  

helper.xml.NamespaceConfig

XML namespace configuration

Properties:

name type   required default
name str namespace name yes  
schemaLocation Url namespace schema location no  
uri Url namespace uri yes  

layer.CacheConfig

Cache configuration

Properties:

name type   required default
enabled bool cache is enabled no false
maxAge Duration cache max. age no "7d"
maxLevel int max. zoom level to cache no 1
uid str unique ID no  

layer.ClientOptions

Client options for a layer

Properties:

name type   required default
exclusive bool only one of this layer’s children is visible at a time no false
expanded bool the layer is expanded in the list view no false
listed bool the layer is displayed in this list view no true
selected bool the layer is intially selected no false
unfolded bool the layer is not listed, but its children are no false
visible bool the layer is intially visible no true

layer.CustomConfig

Properties:

name type   required default
access [ Access ] access rights no  
applyTo gis.source.LayerFilter source layers this configuration applies to no  
clientOptions layer.ClientOptions options for the layer display in the client no  
dataModel model.Config layer data model no  
display layer.DisplayMode layer display mode no  
edit layer.EditConfig editing permissions no  
extentBuffer int extent buffer no  
extent Extent layer extent no  
legend layer.LegendConfig legend configuration no  
meta metadata.Config layer meta data no  
opacity float layer opacity no  
ows layer.OwsConfig OWS services options no  
search search.Config layer search configuration no  
templates [ template.Config ] client templates no  
title str layer title no  
uid str unique ID no  
zoom gis.zoom.Config layer resolutions and scales no  

layer.DisplayMode

Layer display mode

One of:

  • "box"
  • "client"
  • "tile"

layer.EditConfig

Edit access for a layer

Properties:

name type   required default
access [ Access ] access rights no  
uid str unique ID no  

layer.FlattenConfig

Layer hierarchy flattening

Properties:

name type   required default
level int flatten level yes  
uid str unique ID no  
useGroups bool use group names (true) or image layer names (false) no false

layer.GridConfig

Grid configuration for caches and tiled data

Properties:

name type   required default
metaBuffer int pixel buffer no 0
metaSize int number of meta-tiles to fetch no 0
origin str position of the first tile (nw or sw) no "nw"
tileSize int tile size no 256
uid str unique ID no  

layer.ImageFormat

Image format

One of:

  • "png24"
  • "png8"

layer.LegendConfig

Layer legend confuguration.

Properties:

name type   required default
enabled bool the legend is enabled no true
options dict provider-dependent legend options no  
path FilePath path of the legend image no  
template template.Config template for an HTML legend no  
uid str unique ID no  
url Url url of the legend image no  

layer.OwsConfig

OWS services confuguration

Properties:

name type   required default
enabledServices layer.OwsEnabledServicesConfig enabled OWS services no  
enabled bool enable this layer for ows services no true
featureName str feature name for ows services no  
name str layer name for ows services no  
uid str unique ID no  

layer.OwsEnabledServicesConfig

Configuration for enabled OWS services

Properties:

name type   required default
pattern Regex pattern for enabled service uids no  
uid str unique ID no  
uids [ str ] enabled services uids no  

layer.geojson.Config

GeoJson layer

Properties:

name type   required default
access [ Access ] access rights no  
clientOptions layer.ClientOptions options for the layer display in the client no  
dataModel model.Config layer data model no  
display layer.DisplayMode layer display mode no "client"
editDataModel model.Config data model for input data no  
editStyle style.Config style for features being edited no  
edit layer.EditConfig editing permissions no  
extentBuffer int extent buffer no  
extent Extent layer extent no  
keyProp str property name for unique ids no "id"
legend layer.LegendConfig legend configuration no  
loadingStrategy str loading strategy for features (‘all’, ‘bbox’) no "all"
meta metadata.Config layer meta data no  
opacity float layer opacity no 1
ows layer.OwsConfig OWS services options no  
path FilePath geojson file yes  
search search.Config layer search configuration no  
style style.Config style for features no  
templates [ template.Config ] client templates no  
title str layer title no  
type str object type yes  
uid str unique ID no  
zoom gis.zoom.Config layer resolutions and scales no  

layer.group.Config

Group layer

Properties:

name type   required default
access [ Access ] access rights no  
clientOptions layer.ClientOptions options for the layer display in the client no  
dataModel model.Config layer data model no  
display layer.DisplayMode layer display mode no "box"
edit layer.EditConfig editing permissions no  
extentBuffer int extent buffer no  
extent Extent layer extent no  
layers [ layer.Config ] layers in this group yes  
legend layer.LegendConfig legend configuration no  
meta metadata.Config layer meta data no  
opacity float layer opacity no 1
ows layer.OwsConfig OWS services options no  
search search.Config layer search configuration no  
templates [ template.Config ] client templates no  
title str layer title no  
type str object type yes  
uid str unique ID no  
zoom gis.zoom.Config layer resolutions and scales no  

layer.postgres.Config

Postgres layer

Properties:

name type   required default
access [ Access ] access rights no  
clientOptions layer.ClientOptions options for the layer display in the client no  
dataModel model.Config layer data model no  
db str database provider uid no  
display layer.DisplayMode layer display mode no "client"
editDataModel model.Config data model for input data no  
editStyle style.Config style for features being edited no  
edit layer.EditConfig editing permissions no  
extentBuffer int extent buffer no  
extent Extent layer extent no  
legend layer.LegendConfig legend configuration no  
loadingStrategy str loading strategy for features (‘all’, ‘bbox’) no "all"
meta metadata.Config layer meta data no  
opacity float layer opacity no 1
ows layer.OwsConfig OWS services options no  
search search.Config layer search configuration no  
style style.Config style for features no  
table db.SqlTableConfig sql table configuration yes  
templates [ template.Config ] client templates no  
title str layer title no  
type str object type yes  
uid str unique ID no  
zoom gis.zoom.Config layer resolutions and scales no  

layer.qgis.Config

QGIS Project layer

Properties:

name type   required default
access [ Access ] access rights no  
cache layer.CacheConfig cache configuration no  
clientOptions layer.ClientOptions options for the layer display in the client no  
dataModel model.Config layer data model no  
directRender [ str ] QGIS providers that should be rendered directly no  
directSearch [ str ] QGIS providers that should be searched directly no  
display layer.DisplayMode layer display mode no "box"
edit layer.EditConfig editing permissions no  
excludeLayers gis.source.LayerFilter source layers to exclude no  
extentBuffer int extent buffer no  
extent Extent layer extent no  
flattenLayers layer.FlattenConfig flatten the layer hierarchy no  
grid layer.GridConfig grid configuration no  
imageFormat layer.ImageFormat image format no "png8"
layerConfig [ layer.CustomConfig ] custom configurations for specific layers no  
legend layer.LegendConfig legend configuration no  
meta metadata.Config layer meta data no  
opacity float layer opacity no 1
ows layer.OwsConfig OWS services options no  
path FilePath path to a qgs project file yes  
rootLayers gis.source.LayerFilter source layers to use as roots no  
search search.Config layer search configuration no  
templates [ template.Config ] client templates no  
title str layer title no  
type str object type yes  
uid str unique ID no  
zoom gis.zoom.Config layer resolutions and scales no  

layer.qgisflat.Config

QGIS direct layer

Properties:

name type   required default
access [ Access ] access rights no  
cache layer.CacheConfig cache configuration no  
clientOptions layer.ClientOptions options for the layer display in the client no  
dataModel model.Config layer data model no  
display layer.DisplayMode layer display mode no "box"
edit layer.EditConfig editing permissions no  
extentBuffer int extent buffer no  
extent Extent layer extent no  
grid layer.GridConfig grid configuration no  
imageFormat layer.ImageFormat image format no "png8"
legend layer.LegendConfig legend configuration no  
meta metadata.Config layer meta data no  
opacity float layer opacity no 1
ows layer.OwsConfig OWS services options no  
path FilePath qgis project path yes  
search search.Config layer search configuration no  
sourceLayers gis.source.LayerFilter source layers to use no  
templates [ template.Config ] client templates no  
title str layer title no  
type str object type yes  
uid str unique ID no  
zoom gis.zoom.Config layer resolutions and scales no  

layer.tile.Config

Tile layer

Properties:

name type   required default
access [ Access ] access rights no  
cache layer.CacheConfig cache configuration no  
clientOptions layer.ClientOptions options for the layer display in the client no  
dataModel model.Config layer data model no  
display layer.DisplayMode layer display mode no "tile"
edit layer.EditConfig editing permissions no  
extentBuffer int extent buffer no  
extent Extent layer extent no  
grid layer.GridConfig grid configuration no  
imageFormat layer.ImageFormat image format no "png8"
legend layer.LegendConfig legend configuration no  
maxRequests int max concurrent requests to this source no 0
meta metadata.Config layer meta data no  
opacity float layer opacity no 1
ows layer.OwsConfig OWS services options no  
search search.Config layer search configuration no  
service layer.tile.ServiceConfig service configuration no  
templates [ template.Config ] client templates no  
title str layer title no  
type str object type yes  
uid str unique ID no  
url Url rest url with placeholders {x}, {y} and {z} yes  
zoom gis.zoom.Config layer resolutions and scales no  

layer.tile.ServiceConfig

Tile service configuration

Properties:

name type   required default
crs Crs service CRS no "EPSG:3857"
extent Extent service extent no  
origin str position of the first tile (nw or sw) no "nw"
tileSize int tile size no 256

layer.wfs.Config

WFS layer

Properties:

name type   required default
access [ Access ] access rights no  
capsCacheMaxAge Duration max cache age for capabilities documents no "1d"
clientOptions layer.ClientOptions options for the layer display in the client no  
dataModel model.Config layer data model no  
display layer.DisplayMode layer display mode no "client"
editDataModel model.Config data model for input data no  
editStyle style.Config style for features being edited no  
edit layer.EditConfig editing permissions no  
extentBuffer int extent buffer no  
extent Extent layer extent no  
invertAxis [ Crs ] projections that have an inverted axis (yx) no  
legend layer.LegendConfig legend configuration no  
loadingStrategy str loading strategy for features (‘all’, ‘bbox’) no "all"
maxRequests int max concurrent requests to this source no 0
meta metadata.Config layer meta data no  
opacity float layer opacity no 1
ows layer.OwsConfig OWS services options no  
params dict extra query params no  
search search.Config layer search configuration no  
sourceLayers gis.source.LayerFilter source layers to use no  
style style.Config style for features no  
templates [ template.Config ] client templates no  
title str layer title no  
type str object type yes  
uid str unique ID no  
url Url service url yes  
zoom gis.zoom.Config layer resolutions and scales no  

layer.wms.Config

WMS layer

Properties:

name type   required default
access [ Access ] access rights no  
cache layer.CacheConfig cache configuration no  
capsCacheMaxAge Duration max cache age for capabilities documents no "1d"
capsLayersBottomUp bool layers are listed from bottom to top in the GetCapabilities document no false
clientOptions layer.ClientOptions options for the layer display in the client no  
dataModel model.Config layer data model no  
display layer.DisplayMode layer display mode no "box"
edit layer.EditConfig editing permissions no  
extentBuffer int extent buffer no  
extent Extent layer extent no  
getCapabilitiesParams dict additional parameters for GetCapabilities requests no  
getMapParams dict additional parameters for GetMap requests no  
grid layer.GridConfig grid configuration no  
imageFormat layer.ImageFormat image format no "png8"
invertAxis [ Crs ] projections that have an inverted axis (yx) no  
legend layer.LegendConfig legend configuration no  
maxRequests int max concurrent requests to this source no 0
meta metadata.Config layer meta data no  
opacity float layer opacity no 1
ows layer.OwsConfig OWS services options no  
search search.Config layer search configuration no  
sourceLayers gis.source.LayerFilter source layers to use no  
templates [ template.Config ] client templates no  
title str layer title no  
type str object type yes  
uid str unique ID no  
url Url service url yes  
zoom gis.zoom.Config layer resolutions and scales no  

layer.wmstree.Config

WMS layer

Properties:

name type   required default
access [ Access ] access rights no  
cache layer.CacheConfig cache configuration no  
capsCacheMaxAge Duration max cache age for capabilities documents no "1d"
capsLayersBottomUp bool layers are listed from bottom to top in the GetCapabilities document no false
clientOptions layer.ClientOptions options for the layer display in the client no  
dataModel model.Config layer data model no  
display layer.DisplayMode layer display mode no "box"
edit layer.EditConfig editing permissions no  
excludeLayers gis.source.LayerFilter source layers to exclude no  
extentBuffer int extent buffer no  
extent Extent layer extent no  
flattenLayers layer.FlattenConfig flatten the layer hierarchy no  
getCapabilitiesParams dict additional parameters for GetCapabilities requests no  
getMapParams dict additional parameters for GetMap requests no  
grid layer.GridConfig grid configuration no  
imageFormat layer.ImageFormat image format no "png8"
invertAxis [ Crs ] projections that have an inverted axis (yx) no  
layerConfig [ layer.CustomConfig ] custom configurations for specific layers no  
legend layer.LegendConfig legend configuration no  
maxRequests int max concurrent requests to this source no 0
meta metadata.Config layer meta data no  
opacity float layer opacity no 1
ows layer.OwsConfig OWS services options no  
rootLayers gis.source.LayerFilter source layers to use as roots no  
search search.Config layer search configuration no  
templates [ template.Config ] client templates no  
title str layer title no  
type str object type yes  
uid str unique ID no  
url Url service url yes  
zoom gis.zoom.Config layer resolutions and scales no  

layer.wmts.Config

WMTS layer

Properties:

name type   required default
access [ Access ] access rights no  
cache layer.CacheConfig cache configuration no  
capsCacheMaxAge Duration max cache age for capabilities documents no "1d"
clientOptions layer.ClientOptions options for the layer display in the client no  
dataModel model.Config layer data model no  
display layer.DisplayMode layer display mode no "tile"
edit layer.EditConfig editing permissions no  
extentBuffer int extent buffer no  
extent Extent layer extent no  
grid layer.GridConfig grid configuration no  
imageFormat layer.ImageFormat image format no "png8"
legend layer.LegendConfig legend configuration no  
maxRequests int max concurrent requests to this source no 0
meta metadata.Config layer meta data no  
opacity float layer opacity no 1
ows layer.OwsConfig OWS services options no  
params dict query string parameters no  
search search.Config layer search configuration no  
sourceLayer str WMTS layer name no  
sourceStyle str WMTS style name no  
templates [ template.Config ] client templates no  
title str layer title no  
type str object type yes  
uid str unique ID no  
url Url service url yes  
zoom gis.zoom.Config layer resolutions and scales no  

log.Level

One of:

  • "ALL"
  • "CRITICAL"
  • "DEBUG"
  • "ERROR"
  • "INFO"
  • "NOTSET"
  • "WARN"

map.Config

Map configuration

Properties:

name type   required default
center Point map center no  
coordinatePrecision int precision for coordinates no  
crs Crs crs for this map no "EPSG:3857"
extentBuffer int extent buffer no  
extent Extent map extent no  
layers [ layer.Config ] collection of layers for this map yes  
skipInvalidLayers bool remove invalid layers from the map no false
title str map title no  
uid str unique id no  
zoom gis.zoom.Config map scales and resolutions no  

metadata.Config

Object metadata configuration

Properties:

name type   required default
abstract str object abstract description no  
accessConstraints str   no  
attribution str attribution (copyright) string no  
authorityIdentifier str   no  
authorityName str   no  
authorityUrl Url   no  
catalogCitationUid str catalog citation identifier no  
catalogUid str catalog identifier no  
contact metadata.ContactConfig contact information no  
dateBegin Date temporal extent begin no  
dateCreated Date publication date no  
dateEnd Date temporal extent end no  
dateUpdated Date modification date no  
fees str   no  
image Url image (logo) url no  
insipreKeywords [ metadata.MetaInspireMandatoryKeyword ]   no  
insipreMandatoryKeyword metadata.MetaInspireMandatoryKeyword   no  
inspireDegreeOfConformity metadata.MetaInspireDegreeOfConformity   no  
inspireResourceType metadata.MetaInspireResourceType   no  
inspireSpatialDataServiceType metadata.MetaInspireSpatialDataServiceType   no  
inspireSpatialScope metadata.MetaInspireSpatialScope   no  
inspireTheme metadata.MetaInspireTheme   no  
isoMaintenanceFrequencyCode metadata.MetaIsoMaintenanceFrequencyCode   no  
isoQualityConformance [ metadata.MetaIsoQualityConformance ]   no  
isoQualityLineage metadata.MetaIsoQualityLineage   no  
isoRestrictionCode metadata.MetaIsoRestrictionCode   no  
isoScopeName str ISO-19139 scope name no  
isoScope metadata.MetaIsoScope ISO-19139 scope code no  
isoSpatialRepresentationType metadata.MetaIsoSpatialRepresentationType ISO-19139 spatial type no  
isoTopicCategory metadata.MetaIsoTopicCategory ISO-19139 topic category no  
keywords [ str ] keywords no []
language str object language no  
license str   no  
links [ metadata.LinkConfig ] additional links no []
name str object internal name no  
serviceUrl Url service url no  
title str object title no  
uid str unique ID no  
urlFormat str metadata url mime type no  
urlType str metadata url type like “TC211” no  
url Url metadata url no  

metadata.ContactConfig

Contact metadata configuration

Properties:

name type   required default
address str   no  
area str   no  
city str   no  
country str   no  
email str   no  
fax str   no  
organization str   no  
person str   no  
phone str   no  
position str   no  
uid str unique ID no  
url Url   no  
zip str   no  

metadata.LinkConfig

Object link configuration

Properties:

name type   required default
formatName str link format no  
formatVersion str link format version no  
function metadata.MetaIsoOnLineFunction ISO-19115 function no  
scheme str link scheme no  
uid str unique ID no  
url Url link url yes  

metadata.MetaInspireDegreeOfConformity

Inspire degreeOfConformity, see http://inspire.ec.europa.eu/schemas/common/1.0/common.xsd

One of:

  • "conformant"
  • "notConformant"
  • "notEvaluated"

metadata.MetaInspireMandatoryKeyword

Inspire keyword, see http://inspire.ec.europa.eu/schemas/common/1.0/common.xsd

One of:

  • "chainDefinitionService"
  • "comEncodingService"
  • "comGeographicCompressionService"
  • "comGeographicFormatConversionService"
  • "comMessagingService"
  • "comRemoteFileAndExecutableManagement"
  • "comService"
  • "comTransferService"
  • "humanCatalogueViewer"
  • "humanChainDefinitionEditor"
  • "humanFeatureGeneralizationEditor"
  • "humanGeographicDataStructureViewer"
  • "humanGeographicFeatureEditor"
  • "humanGeographicSpreadsheetViewer"
  • "humanGeographicSymbolEditor"
  • "humanGeographicViewer"
  • "humanInteractionService"
  • "humanServiceEditor"
  • "humanWorkflowEnactmentManager"
  • "infoCatalogueService"
  • "infoCoverageAccessService"
  • "infoFeatureAccessService"
  • "infoFeatureTypeService"
  • "infoGazetteerService"
  • "infoManagementService"
  • "infoMapAccessService"
  • "infoOrderHandlingService"
  • "infoProductAccessService"
  • "infoRegistryService"
  • "infoSensorDescriptionService"
  • "infoStandingOrderService"
  • "metadataGeographicAnnotationService"
  • "metadataProcessingService"
  • "metadataStatisticalCalculationService"
  • "spatialCoordinateConversionService"
  • "spatialCoordinateTransformationService"
  • "spatialCoverageVectorConversionService"
  • "spatialDimensionMeasurementService"
  • "spatialFeatureGeneralizationService"
  • "spatialFeatureManipulationService"
  • "spatialFeatureMatchingService"
  • "spatialImageCoordinateConversionService"
  • "spatialImageGeometryModelConversionService"
  • "spatialOrthorectificationService"
  • "spatialPositioningService"
  • "spatialProcessingService"
  • "spatialProximityAnalysisService"
  • "spatialRectificationService"
  • "spatialRouteDeterminationService"
  • "spatialSamplingService"
  • "spatialSensorGeometryModelAdjustmentService"
  • "spatialSubsettingService"
  • "spatialTilingChangeService"
  • "subscriptionService"
  • "taskManagementService"
  • "temporalProcessingService"
  • "temporalProximityAnalysisService"
  • "temporalReferenceSystemTransformationService"
  • "temporalSamplingService"
  • "temporalSubsettingService"
  • "thematicChangeDetectionService"
  • "thematicClassificationService"
  • "thematicFeatureGeneralizationService"
  • "thematicGeocodingService"
  • "thematicGeographicInformationExtractionService"
  • "thematicGeoparsingService"
  • "thematicGoparameterCalculationService"
  • "thematicImageManipulationService"
  • "thematicImageProcessingService"
  • "thematicImageSynthesisService"
  • "thematicImageUnderstandingService"
  • "thematicMultibandImageManipulationService"
  • "thematicObjectDetectionService"
  • "thematicProcessingService"
  • "thematicReducedResolutionGenerationService"
  • "thematicSpatialCountingService"
  • "thematicSubsettingService"
  • "workflowEnactmentService"

metadata.MetaInspireResourceType

Inspire resourceType, see http://inspire.ec.europa.eu/schemas/common/1.0/common.xsd

One of:

  • "dataset"
  • "series"
  • "service"

metadata.MetaInspireSpatialDataServiceType

Inspire spatialDataServiceType, see http://inspire.ec.europa.eu/schemas/common/1.0/common.xsd

One of:

  • "discovery"
  • "download"
  • "invoke"
  • "other"
  • "transformation"
  • "view"

metadata.MetaInspireSpatialScope

Inspire spatialScope, see https://inspire.ec.europa.eu/metadata-codelist/SpatialScope

One of:

  • "european"
  • "global_"
  • "local"
  • "national"
  • "regional"

metadata.MetaInspireTheme

Inspire theme, see http://inspire.ec.europa.eu/theme/

One of:

  • "ac"
  • "ad"
  • "af"
  • "am"
  • "au"
  • "br"
  • "bu"
  • "cp"
  • "ef"
  • "el"
  • "er"
  • "ge"
  • "gg"
  • "gn"
  • "hb"
  • "hh"
  • "hy"
  • "lc"
  • "lu"
  • "mf"
  • "mr"
  • "nz"
  • "of"
  • "oi"
  • "pd"
  • "pf"
  • "ps"
  • "rs"
  • "sd"
  • "so"
  • "sr"
  • "su"
  • "tn"
  • "us"

metadata.MetaIsoMaintenanceFrequencyCode

ISO-19139 MD_MaintenanceFrequencyCode, see https://standards.iso.org/iso/19139/resources/gmxCodelists.xml

One of:

  • "annually"
  • "asNeeded"
  • "biannually"
  • "continual"
  • "daily"
  • "fortnightly"
  • "irregular"
  • "monthly"
  • "notPlanned"
  • "quarterly"
  • "unknown"
  • "weekly"

metadata.MetaIsoOnLineFunction

ISO-19139 CI_OnLineFunctionCode, see https://standards.iso.org/iso/19139/resources/gmxCodelists.xml

One of:

  • "download"
  • "information"
  • "offlineAccess"
  • "order"
  • "search"

metadata.MetaIsoQualityConformance

Properties:

name type   required default
explanation str   no  
qualityPass bool   yes  
specificationDate str   yes  
specificationTitle str   yes  

metadata.MetaIsoQualityLineage

Properties:

name type   required default
sourceScale int   yes  
source str   yes  
statement str   yes  

metadata.MetaIsoRestrictionCode

ISO-19139 MD_RestrictionCode, see https://standards.iso.org/iso/19139/resources/gmxCodelists.xml

One of:

  • "copyright"
  • "intellectualPropertyRights"
  • "license"
  • "otherRestrictions"
  • "patent"
  • "patentPending"
  • "restricted"
  • "trademark"

metadata.MetaIsoScope

ISO-19139 MD/MX_ScopeCode, see https://standards.iso.org/iso/19139/resources/gmxCodelists.xml

One of:

  • "attribute"
  • "attributeType"
  • "collectionHardware"
  • "collectionSession"
  • "dataset"
  • "dimensionGroup"
  • "feature"
  • "featureType"
  • "fieldSession"
  • "initiative"
  • "model"
  • "nonGeographicDataset"
  • "otherAggregate"
  • "platformSeries"
  • "productionSeries"
  • "propertyType"
  • "sensor"
  • "sensorSeries"
  • "series"
  • "service"
  • "software"
  • "stereomate"
  • "tile"
  • "transferAggregate"

metadata.MetaIsoSpatialRepresentationType

ISO-19139 MD_SpatialRepresentationTypeCode, see https://standards.iso.org/iso/19139/resources/gmxCodelists.xml

One of:

  • "grid"
  • "stereoModel"
  • "textTable"
  • "tin"
  • "vector"
  • "video"

metadata.MetaIsoTopicCategory

ISO-19139 MD_TopicCategoryCode, see https://standards.iso.org/iso/19139/resources/gmxCodelists.xml

One of:

  • "biota"
  • "boundaries"
  • "climatologyMeteorologyAtmosphere"
  • "economy"
  • "elevation"
  • "environment"
  • "farming"
  • "geoscientificInformation"
  • "health"
  • "imageryBaseMapsEarthCover"
  • "inlandWaters"
  • "intelligenceMilitary"
  • "location"
  • "oceans"
  • "planningCadastre"
  • "society"
  • "structure"
  • "transportation"
  • "utilitiesCommunication"

model.Config

Data model

Properties:

name type   required default
crs Crs CRS for this model no  
geometryType GeometryType specific geometry type no  
rules [ model.ModelRule ] attribute conversion rules yes  
uid str unique ID no  

model.ModelRule

Attribute conversion rule

Properties:

name type   required default
editable bool attribute is editable no true
expression str attribute conversion expression no  
format FormatStr attribute formatter no  
name str target attribute name no  
source str source attribute name no  
title str target attribute title no  
type AttributeType target attribute type no "str"
value str constant value no  

ows.service.csw.Config

CSW Service configuration

Properties:

name type   required default
access [ Access ] access rights no  
forceFeatureName str   no  
meta metadata.Config service metadata no  
name str service name no  
profile ows.service.csw.Profile metadata profile no "ISO"
root str root layer uid no  
strictParams bool strict parameter parsing no false
supportedCrs [ Crs ] supported CRS for this service no  
templates [ template.Config ] service XML templates no  
type str object type yes  
uid str unique ID no  
updateSequence str service update sequence no  
withInspireMeta bool use INSPIRE Metadata no false

ows.service.csw.Profile

One of:

  • "DCMI"
  • "ISO"

ows.service.wcs.Config

WCS Service configuration

Properties:

name type   required default
access [ Access ] access rights no  
forceFeatureName str   no  
meta metadata.Config service metadata no  
name str service name no  
root str root layer uid no  
strictParams bool strict parameter parsing no false
supportedCrs [ Crs ] supported CRS for this service no  
templates [ template.Config ] service XML templates no  
type str object type yes  
uid str unique ID no  
updateSequence str service update sequence no  
withInspireMeta bool use INSPIRE Metadata no false

ows.service.wfs.Config

WFS Service configuration

Properties:

name type   required default
access [ Access ] access rights no  
forceFeatureName str   no  
meta metadata.Config service metadata no  
name str service name no  
root str root layer uid no  
strictParams bool strict parameter parsing no false
supportedCrs [ Crs ] supported CRS for this service no  
templates [ template.Config ] service XML templates no  
type str object type yes  
uid str unique ID no  
updateSequence str service update sequence no  
withInspireMeta bool use INSPIRE Metadata no false

ows.service.wms.Config

WMS Service configuration

Properties:

name type   required default
access [ Access ] access rights no  
forceFeatureName str   no  
meta metadata.Config service metadata no  
name str service name no  
root str root layer uid no  
strictParams bool strict parameter parsing no false
supportedCrs [ Crs ] supported CRS for this service no  
templates [ template.Config ] service XML templates no  
type str object type yes  
uid str unique ID no  
updateSequence str service update sequence no  
withInspireMeta bool use INSPIRE Metadata no false

ows.service.wmts.Config

WMTS Service configuration

Properties:

name type   required default
access [ Access ] access rights no  
forceFeatureName str   no  
meta metadata.Config service metadata no  
name str service name no  
root str root layer uid no  
strictParams bool strict parameter parsing no false
supportedCrs [ Crs ] supported CRS for this service no  
templates [ template.Config ] service XML templates no  
type str object type yes  
uid str unique ID no  
updateSequence str service update sequence no  
withInspireMeta bool use INSPIRE Metadata no false

printer.Config

Printer configuration

Properties:

name type   required default
templates [ template.Config ] print templates yes  
uid str unique ID no  

project.Config

Project configuration

Properties:

name type   required default
access [ Access ] access rights no  
api api.Config project-specific actions no  
assets web.site.DocumentRootConfig project-specific assets options no  
client client.Config project-specific gws client configuration no  
locales [ str ] project locales no  
map map.Config Map configuration no  
meta metadata.Config project metadata no  
overviewMap map.Config Overview map configuration no  
printer printer.Config printer configuration no  
search search.Config project-wide search configuration no  
templates [ template.Config ] project info templates no  
title str project title no  
uid str unique id no  

search.Config

Properties:

name type   required default
enabled bool search is enabled no true
providers [ search.provider.Config ] search prodivers no  

search.provider.SearchSpatialContext

One of:

  • "map"
  • "view"

search.provider.nominatim.Config

Nominatim (OSM) search provider

Properties:

name type   required default
access [ Access ] access rights no  
country str country to limit the search no  
dataModel model.Config feature data model no  
defaultContext search.provider.SearchSpatialContext default spatial context no "map"
language str language to return the results in no  
templates [ template.Config ] feature formatting templates no  
title str provider title no  
tolerance str tolerance, in pixels or map units no "10px"
type str object type yes  
uid str unique ID no  
withGeometry bool enable geometry search no true
withKeyword bool enable keyword search no true

search.provider.postgres.Config

Postgres search

Properties:

name type   required default
access [ Access ] access rights no  
dataModel model.Config feature data model no  
db str database provider uid no  
defaultContext search.provider.SearchSpatialContext default spatial context no "map"
sort str sort expression no  
table db.SqlTableConfig sql table configuration yes  
templates [ template.Config ] feature formatting templates no  
title str provider title no  
tolerance str tolerance, in pixels or map units no "10px"
type str object type yes  
uid str unique ID no  
withGeometry bool enable geometry search no true
withKeyword bool enable keyword search no true

search.provider.qgispostgres.Config

Qgis/Postgres automatic search provider

Properties:

name type   required default
access [ Access ] access rights no  
dataModel model.Config feature data model no  
dataSource dict qgis data source yes  
defaultContext search.provider.SearchSpatialContext default spatial context no "map"
templates [ template.Config ] feature formatting templates no  
title str provider title no  
tolerance str tolerance, in pixels or map units no "10px"
type str object type yes  
uid str unique ID no  
withGeometry bool enable geometry search no true
withKeyword bool enable keyword search no true

search.provider.qgiswms.Config

Qgis/Postgres automatic search provider

Properties:

name type   required default
access [ Access ] access rights no  
dataModel model.Config feature data model no  
defaultContext search.provider.SearchSpatialContext default spatial context no "map"
path FilePath project path yes  
sourceLayers gis.source.LayerFilter source layers to use no  
templates [ template.Config ] feature formatting templates no  
title str provider title no  
tolerance str tolerance, in pixels or map units no "10px"
type str object type yes  
uid str unique ID no  
withGeometry bool enable geometry search no true
withKeyword bool enable keyword search no true

search.provider.wfs.Config

WFS search

Properties:

name type   required default
access [ Access ] access rights no  
capsCacheMaxAge Duration max cache age for capabilities documents no "1d"
dataModel model.Config feature data model no  
defaultContext search.provider.SearchSpatialContext default spatial context no "map"
invertAxis [ Crs ] projections that have an inverted axis (yx) no  
maxRequests int max concurrent requests to this source no 0
params dict extra query params no  
sourceLayers gis.source.LayerFilter source layers to use no  
templates [ template.Config ] feature formatting templates no  
title str provider title no  
tolerance str tolerance, in pixels or map units no "10px"
type str object type yes  
uid str unique ID no  
url Url service url yes  
withGeometry bool enable geometry search no true
withKeyword bool enable keyword search no true

search.provider.wms.Config

WMS search

Properties:

name type   required default
access [ Access ] access rights no  
capsCacheMaxAge Duration max cache age for capabilities documents no "1d"
capsLayersBottomUp bool layers are listed from bottom to top in the GetCapabilities document no false
dataModel model.Config feature data model no  
defaultContext search.provider.SearchSpatialContext default spatial context no "map"
getCapabilitiesParams dict additional parameters for GetCapabilities requests no  
getMapParams dict additional parameters for GetMap requests no  
invertAxis [ Crs ] projections that have an inverted axis (yx) no  
maxRequests int max concurrent requests to this source no 0
sourceLayers gis.source.LayerFilter source layers to use no  
templates [ template.Config ] feature formatting templates no  
title str provider title no  
tolerance str tolerance, in pixels or map units no "10px"
type str object type yes  
uid str unique ID no  
url Url service url yes  
withGeometry bool enable geometry search no true
withKeyword bool enable keyword search no true

server.Config

Server module configuation

Properties:

name type   required default
autoRun str shell command to run before server start no  
logLevel log.Level logging level no "INFO"
log str log path no  
mapproxy server.MapproxyConfig bundled Mapproxy module no  
monitor server.MonitorConfig monitor configuation no  
qgis server.QgisConfig bundled Qgis module no  
spool server.SpoolConfig spool server module no  
timeout Duration server timeout no 60
uid str unique ID no  
web server.WebConfig web server module no  

server.MapproxyConfig

Mapproxy server module

Properties:

name type   required default
enabled bool the module is enabled no true
host str host to run the module on no "localhost"
port int port number no 5000
threads int number of threads for this module no 0
uid str unique ID no  
workers int number of processes for this module no 4

server.MonitorConfig

Properties:

name type   required default
enabled bool the module is enabled no true
frequency Duration filesystem changes check frequency no 30
ignore [ Regex ] ignore paths that match these regexes no  
uid str unique ID no  

server.QgisConfig

Bundled QGIS server module

Properties:

name type   required default
debug int QGIS_DEBUG (env. variable) no 0
enabled bool the module is enabled no true
host str host to run the module on no "localhost"
legend dict default legend settings no  
maxCacheLayers int MAX_CACHE_LAYERS (env. variable) no 4000
maxRequests int max concurrent requests to this server no 6
port int port number no 4000
searchPathsForSVG [ DirPath ] searchPathsForSVG (ini setting) no  
serverCacheSize int QGIS_SERVER_CACHE_SIZE (env. variable) no 10000000
serverLogLevel int QGIS_SERVER_LOG_LEVEL (env. variable) no 2
threads int number of threads for this module no 0
uid str unique ID no  
workers int number of processes for this module no 4

server.SpoolConfig

Spool server module

Properties:

name type   required default
enabled bool the module is enabled no true
jobFrequency Duration background jobs checking frequency no 3
threads int number of threads for this module no 0
uid str unique ID no  
workers int number of processes for this module no 4

server.WebConfig

Web server module

Properties:

name type   required default
enabled bool the module is enabled no true
maxRequestLength int max request length in megabytes no 10
threads int number of threads for this module no 0
uid str unique ID no  
workers int number of processes for this module no 4

style.Config

Feature style

Properties:

name type   required default
name str style name no  
text str raw style content no  
type StyleType style type yes  
uid str unique ID no  
values dict style values no  

template.html.Config

HTML template

Properties:

name type   required default
dataModel model.Config user-editable template attributes no  
mimeTypes [ str ] mime types this template can generate no  
path FilePath path to a template file no  
qualityLevels [ TemplateQualityLevel ] quality levels supported by the template no  
subject str template purpose no  
text str template content no  
title str template title no  
type str object type yes  
uid str unique ID no  

template.qgis.Config

Qgis print template

Properties:

name type   required default
dataModel model.Config user-editable template attributes no  
mimeTypes [ str ] mime types this template can generate no  
path FilePath   yes  
qualityLevels [ TemplateQualityLevel ] quality levels supported by the template no  
subject str template purpose no  
text str template content no  
title str template title no  
type str object type yes  
uid str unique ID no  

template.text.Config

text-only template

Properties:

name type   required default
dataModel model.Config user-editable template attributes no  
mimeTypes [ str ] mime types this template can generate no  
path FilePath path to a template file no  
qualityLevels [ TemplateQualityLevel ] quality levels supported by the template no  
subject str template purpose no  
text str template content no  
title str template title no  
type str object type yes  
uid str unique ID no  

template.xml.Config

XML template

Properties:

name type   required default
dataModel model.Config user-editable template attributes no  
mimeTypes [ str ] mime types this template can generate no  
path FilePath path to a template file no  
qualityLevels [ TemplateQualityLevel ] quality levels supported by the template no  
subject str template purpose no  
text str template content no  
title str template title no  
type str object type yes  
uid str unique ID no  

web.site.Config

Site (virtual host) configuration

Properties:

name type   required default
assets web.site.DocumentRootConfig assets location and options no  
cors web.site.CorsConfig cors configuration no  
errorPage template.Config error page template no  
host str host name no "*"
reversedHost str hostname for reversed rewriting no  
reversedRewrite [ web.site.RewriteRule ] reversed rewrite rules no  
rewrite [ web.site.RewriteRule ] rewrite rules no  
root web.site.DocumentRootConfig document root location and options yes  
uid str unique ID no  

web.site.CorsConfig

Properties:

name type   required default
allowCredentials bool Access-Control-Allow-Credentials header no false
allowHeaders [ str ] Access-Control-Allow-Headers header no  
allowOrigin str Access-Control-Allow-Origin header no "*"
uid str unique ID no  

web.site.DocumentRootConfig

Base directory for assets

Properties:

name type   required default
allowMime [ str ] allowed mime types no  
denyMime [ str ] disallowed mime types (from the standard list) no  
dir DirPath directory path yes  
uid str unique ID no  

web.site.RewriteRule

Properties:

name type   required default
match Regex expression to match the url against yes  
options dict additional options no  
target str target url with placeholders yes