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 ApplicationConfig.

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`	Floating-point number
`dict`	Generic key-value object
[`T`…]	List (array) of elements of type `T`

Special types¶

The values of these types are strings and numbers assoicated with a special semantics.

`crsref`	CRS code like “EPSG:3857”
`dirpath`	Valid readable directory path on the server
`duration`	String like “1w 2d 3h 4m 5s” or a number of seconds
`filepath`	Valid readable file path on the server
`formatstr`	String with {attribute} placeholders
`regex`	Regular expression, as used in Python
`url`	An http or https URL

ApplicationConfig¶

Application configuration

Properties:

name	type		required	default
access	[AccessRuleConfig…]	default access mode	no
api	ApiConfig	system-wide server actions	no
auth	AuthConfig	authorization methods and options	no
client	ClientConfig	gws client configuration	no
csv	CsvConfig	csv format options	no
db	ApplicationDbConfig	database configuration	no
fonts	ApplicationFontConfig	fonts configuration	no
locales	[`str`…]	default locales for all projects	no
projectDirs	[`dirpath`…]	directories with additional projects	no
projectPaths	[`filepath`…]	additional project paths	no
projects	[ProjectConfig…]	project configurations	no
seeding	ApplicationSeedingConfig	configuration for seeding jobs	no
server	ServerConfig	server engine options	no
storage	StorageConfig	storage configuration	no
timeZone	`str`	timezone for this server	no	“UTC”
web	ApplicationWebConfig	webserver configuration	no

AccessRuleConfig¶

Access rights definition for authorization roles

Properties:

name	type		required	default
role	`str`	a roles to which this rule applies	yes
type	AccessType	access type (deny or allow)	yes

ActionAlkisBuchungConfig¶

Access to the Grundbuch (register) information

Properties:

name	type		required	default
access	[AccessRuleConfig…]	access rights	yes

ActionAlkisConfig¶

Flurstückssuche (cadaster parlcels search) action

Properties:

name	type		required	default
access	[AccessRuleConfig…]	access rights	no
alkisSchema	`str`	schema where ALKIS tables are stored, must be readable	no	“public”
buchung	ActionAlkisBuchungConfig	access to the Grundbuch (register) information	no
db	`str`	database provider ID	no
disableApi	`bool`	disable external access to this extension	no	false
eigentuemer	ActionAlkisEigentuemerConfig	access to the Eigentümer (owner) information	no
excludeGemarkung	[`str`…]	Gemarkung (AU) IDs to exclude from search	no
featureFormat	FormatConfig	template for on-screen Flurstueck details	no
indexSchema	`str`	schema to store gws internal indexes, must be writable	no	“gws”
limit	`int`	search results limit	no	100
printTemplate	TemplateConfig	template for printed Flurstueck details	no
type	`str`	“alkis”	yes
ui	ActionAlkisUiConfig	ui options	no

ActionAlkisEigentuemerConfig¶

Access to the Eigentümer (owner) information

Properties:

name	type		required	default
access	[AccessRuleConfig…]	access rights	yes
controlMode	`bool`	restricted mode enabled	no	false
controlRules	[`str`…]	list of regular expression for the restricted input control	no
logTable	`str`	data access protocol table name	no

ActionAlkisUiConfig¶

Flurstückssuche UI configuration.

Properties:

name	type		required	default
autoSpatialSearch	`bool`	activate spatial search after submit	no	false
gemarkungListMode	`str`	plain = only “gemarkung”, combined = “gemarkung(gemeinde)”, tree = “gemeinde”, then “gemarkung”	no	“combined”
searchSelection	`bool`	search in selection enabled	no	false
searchSpatial	`bool`	spatial search enabled	no	false
useExport	`bool`	export function enabled	no	false
usePick	`bool`	pick mode enabled	no	false
useSelect	`bool`	select mode enabled	no	false

ActionAssetConfig¶

Asset generation action

Properties:

name	type		required	default
access	[AccessRuleConfig…]	access rights	no
type	`str`	“asset”	yes

ActionAuthConfig¶

Authorization action

Properties:

name	type		required	default
access	[AccessRuleConfig…]	access rights	no
type	`str`	“auth”	yes

ActionDimensionConfig¶

Dimension action

Properties:

name	type		required	default
access	[AccessRuleConfig…]	access rights	no
layers	[`str`…]	target layer uids	no
pixelTolerance	`int`	pixel tolerance	no	10
type	`str`	“dimension”	yes

ActionDproconConfig¶

D-Procon action

Properties:

name	type		required	default
access	[AccessRuleConfig…]	access rights	no
alkisSchema	`str`	schema where ALKIS tables are stored, must be readable	no	“public”
cacheTime	`duration`		no	“24h”
crs	`crsref`		no
dataTable	SqlTableConfig	table to store consolidated results	yes
dataTablePattern	`str`	pattern for result tables to consolidate	yes
db	`str`		no
indexSchema	`str`	schema to store gws internal indexes, must be writable	no	“gws”
infoTitle	`str`		no
requestTable	SqlTableConfig	table to store outgoing requests	yes
requestUrl	`url`		yes
type	`str`	“dprocon”	yes

ActionEditConfig¶

Feature edit action

Properties:

name	type		required	default
access	[AccessRuleConfig…]	access rights	no
type	`str`	“edit”	yes

ActionGekosConfig¶

GekoS action

Properties:

name	type		required
access	[AccessRuleConfig…]	access rights	no
crs	`crsref`	CRS for gekos data	no
db	`str`	database provider uid	no
instances	[`str`…]	gek-online instances	no
params	`dict`	additional parameters for gek-online calls	yes
position	ActionGekosPositionConfig	position correction for points	no
table	SqlTableConfig	sql table configuration	yes
type	`str`	“gekos”	yes
url	`url`	gek-online base url	yes

ActionGekosPositionConfig¶

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

ActionGeorisksAarteLinkConfig¶

AarteLink system configuration

Properties:

name	type		required
serviceLogin	`str`	service login	yes
servicePassword	`str`	service password	yes
serviceUrl	`str`	service url	yes
systemKey	`str`	systemKey for the aarteLink connector	yes

ActionGeorisksConfig¶

Georisks action

Properties:

name	type		required
aarteLink	ActionGeorisksAarteLinkConfig	AarteLink system configuration	yes
access	[AccessRuleConfig…]	access rights	no
db	`str`	database provider uid	no
report	ActionGeorisksReportConfig	report function config	yes
type	`str`	“georisks”	yes

ActionGeorisksReportConfig¶

Configuration for the report function

Properties:

name	type		required	default
imageQuality	`int`	jpeg quality level	no	75
maxImageLength	`int`	max image size in megabytes	no	5
maxImageSize	`int`	max image size in pixels	no	1000
privacyPolicyLink	`dict`	url of the privacy policy document	no

ActionMapConfig¶

Map rendering action

Properties:

name	type		required	default
access	[AccessRuleConfig…]	access rights	no
type	`str`	“map”	yes

ActionOwsConfig¶

OWS server action

Properties:

name	type		required
access	[AccessRuleConfig…]	access rights	no
templates	ActionOwsTemplatesConfig		no
type	`str`	“ows”	yes

ActionOwsTemplatesConfig¶

Properties:

name	type		required	default
wfsGetCapabilities	TemplateConfig		no
wmsGetCapabilities	TemplateConfig		no

ActionPrinterConfig¶

Print action

Properties:

name	type		required	default
access	[AccessRuleConfig…]	access rights	no
type	`str`	“printer”	yes

ActionProjectConfig¶

Project information action

Properties:

name	type		required	default
access	[AccessRuleConfig…]	access rights	no
type	`str`	“project”	yes

ActionRemoteadminConfig¶

Remote administration action

Properties:

name	type		required	default
access	[AccessRuleConfig…]	access rights	no
passwordFile	`str`	path to the password file	no	“/gws-var/.remoteadmin”
type	`str`	“remoteadmin”	yes

ActionSearchConfig¶

Search action

Properties:

name	type		required	default
access	[AccessRuleConfig…]	access rights	no
limit	`int`	search results limit	no	1000
pixelTolerance	`int`	pixel tolerance for geometry searches	no	5
type	`str`	“search”	yes

ActionStorageConfig¶

Storage action

Properties:

name	type		required	default
access	[AccessRuleConfig…]	access rights	no
type	`str`	“storage”	yes

ApiConfig¶

Server actions

Properties:

name	type		required	default
access	[AccessRuleConfig…]	default access mode	no
actions	[ActionConfig…]	available actions	no

ApplicationDbConfig¶

Database configuration

Properties:

name	type		required	default
providers	[DbProviderConfig…]		yes

ApplicationFontConfig¶

Fonts configuration.

Properties:

name	type		required	default
dir	`dirpath`	directory with custom fonts	yes

ApplicationSSLConfig¶

SSL configuration

Properties:

name	type		required	default
crt	`filepath`	crt file location	yes
key	`filepath`	key file location	yes

ApplicationSeedingConfig¶

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

ApplicationWebConfig¶

Web server configuration

Properties:

name	type		required	default
sites	[WebSiteConfig…]	configured sites	no
ssl	ApplicationSSLConfig	ssl configuration	no

AttributeConfig¶

Attribute configuration

Properties:

name	type		required
name	`str`	internal name	no
title	`str`	title	no
type	`str`	type	no

AuthConfig¶

Authentication and authorization options

Properties:

name	type		required	default
cookie	AuthCookieConfig	session cookie parameters	no
httpEnabled	`bool`	http authorization enabled	no	true
httpsOnly	`bool`	http authorization via ssl only	no	false
providers	[AuthProviderConfig…]	authorization providers	yes
session	AuthSessionConfig	session configuration	no

AuthCookieConfig¶

Session cookie parameters

Properties:

name	type		required	default
name	`str`	name for the cookie	no	“auth”
path	`str`	cookie path	no	“/”

AuthProviderFileConfig¶

File-based authorization provider

Properties:

name	type		required	default
path	`filepath`	path to the users json file	yes
type	`str`	“file”	yes

AuthProviderLdapConfig¶

LDAP authorization provider

Properties:

name	type		required	default
activeDirectory	`bool`	true if the LDAP server is ActiveDirectory	no	true
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`	“ldap”	yes
url	`str`	LDAP server url “ldap://host:port/baseDN?searchAttribute”	yes
users	[AuthProviderLdapUserSpec…]	map LDAP filters to gws roles	yes

AuthProviderLdapUserSpec¶

Map LDAP filters to authorization roles

Properties:

name	type		required
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`…]	gws role names	yes

AuthSessionConfig¶

Session configuration

Properties:

name	type		required	default
heartBeat	`bool`	refresh sessions automatically	no	false
lifeTime	`duration`	session life time	no	1200
storage	`str`	session storage engine	no	“sqlite”

ClientConfig¶

GWS client configuration

Properties:

name	type		required
access	[AccessRuleConfig…]	access rights	no
addElements	[ClientElementConfig…]	add elements to the parent element list	no
elements	[ClientElementConfig…]	client UI elements	no
options	`dict`	client options	no
removeElements	[ClientElementConfig…]	remove elements from the parent element list	no

ClientElementConfig¶

GWS client UI element configuration

Properties:

name	type		required
access	[AccessRuleConfig…]	access rights	no
after	`str`	insert after this tag	no
before	`str`	insert before this tag	no
tag	`str`	element tag	yes

CsvConfig¶

CSV export settings

Properties:

name	type		required	default
decimal	`str`		no	“.”
delimiter	`str`	field delimiter	no	“,”
encoding	`str`	encoding for CSV files	no	“utf8”
quote	`str`	quote sign	no	“””

DbProviderPostgresConfig¶

Postgres/Postgis database provider

Properties:

name	type		required	default
connectTimeout	`duration`	connection 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`	“postgres”	yes
uid	`str`	unique id	yes
user	`str`	username	yes

DocumentRootConfig¶

Base directory for assets

Properties:

name	type		required
allowMime	[`str`…]	allowed mime types	no
denyMime	[`str`…]	disallowed mime types (from the standard list)	no
dir	`dirpath`	directory path	yes

Extent¶

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

FormatConfig¶

Feature format

Properties:

name	type		required
category	TemplateConfig	feature category	no
dataModel	[AttributeConfig…]	attribute metadata	no
description	TemplateConfig	template for feature descriptions	no
label	TemplateConfig	feature label on the map	no
teaser	TemplateConfig	template for feature teasers (short descriptions)	no
title	TemplateConfig	feature title	no

LayerCacheConfig¶

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

LayerClientOptions¶

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

LayerEditConfig¶

Properties:

name	type		required	default
access	[AccessRuleConfig…]		yes

LayerFlattenConfig¶

Flatten the layer hierarchy.

Properties:

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

LayerGridConfig¶

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

LayerGroupConfig¶

Group layer

Properties:

name	type		required	default
access	[AccessRuleConfig…]	access rights	no
clientOptions	LayerClientOptions	options for the layer display in the client	no
description	TemplateConfig	template for the layer description	no
edit	LayerEditConfig	editing permissions	no
extent	Extent	layer extent	no
extentBuffer	`int`	extent buffer	no
featureFormat	FormatConfig	feature formatting options	no
layers	[LayerConfig…]	layers in this group	yes
legend	LayerLegendConfig	legend configuration	no
meta	MetaConfig	layer meta data	no
opacity	`float`	layer opacity	no	1
search	SearchConfig	layer search configuration	no
services	LayerServicesConfig	OWS services options	no
title	`str`	layer title	no
type	`str`	“group”	yes
uid	`str`	layer unique id	no
zoom	ZoomConfig	layer resolutions and scales	no

LayerLegendConfig¶

Properties:

name	type		required	default
enabled	`bool`		no	true
url	`url`		no

LayerOsmConfig¶

Properties:

name	type		required	default
access	[AccessRuleConfig…]	access rights	no
clientOptions	LayerClientOptions	options for the layer display in the client	no
description	TemplateConfig	template for the layer description	no
edit	LayerEditConfig	editing permissions	no
extent	Extent	layer extent	no
extentBuffer	`int`	extent buffer	no
featureFormat	FormatConfig	feature formatting options	no
legend	LayerLegendConfig	legend configuration	no
meta	MetaConfig	layer meta data	no
opacity	`float`	layer opacity	no	1
search	SearchConfig	layer search configuration	no
services	LayerServicesConfig	OWS services options	no
title	`str`	layer title	no
type	`str`	“osm”	yes
uid	`str`	layer unique id	no
zoom	ZoomConfig	layer resolutions and scales	no

LayerQgisConfig¶

Automatic QGIS layer

Properties:

name	type		required	default
access	[AccessRuleConfig…]	access rights	no
cache	LayerCacheConfig	cache configuration	no
clientOptions	LayerClientOptions	options for the layer display in the client	no
description	TemplateConfig	template for the layer description	no
directRender	[`str`…]	QGIS providers that should be rendered directly	no
directSearch	[`str`…]	QGIS providers that should be searched directly	no
display	LayerDisplayMode	layer display mode	no	“box”
edit	LayerEditConfig	editing permissions	no
extent	Extent	layer extent	no
extentBuffer	`int`	extent buffer	no
featureFormat	FormatConfig	feature formatting options	no
flatten	LayerFlattenConfig	flatten the layer hierarchy	no
grid	LayerGridConfig	grid configuration	no
imageFormat	LayerImageFormat	image format	no	“png8”
legend	LayerLegendConfig	legend configuration	no
meta	MetaConfig	layer meta data	no
opacity	`float`	layer opacity	no	1
path	`filepath`	path to a qgs project file	yes
search	SearchConfig	layer search configuration	no
services	LayerServicesConfig	OWS services options	no
sourceLayers	SourceLayerFilterConfig	source layers to use as roots	no
title	`str`	layer title	no
type	`str`	“qgis”	yes
uid	`str`	layer unique id	no
zoom	ZoomConfig	layer resolutions and scales	no

LayerQgiswmsConfig¶

WMS layer from a Qgis project

Properties:

name	type		required	default
access	[AccessRuleConfig…]	access rights	no
cache	LayerCacheConfig	cache configuration	no
clientOptions	LayerClientOptions	options for the layer display in the client	no
description	TemplateConfig	template for the layer description	no
display	`str`		no	“box”
edit	LayerEditConfig	editing permissions	no
extent	Extent	layer extent	no
extentBuffer	`int`	extent buffer	no
featureFormat	FormatConfig	feature formatting options	no
grid	LayerGridConfig	grid configuration	no
imageFormat	LayerImageFormat	image format	no	“png8”
legend	LayerLegendConfig	legend configuration	no
meta	MetaConfig	layer meta data	no
opacity	`float`	layer opacity	no	1
path	`filepath`	qgis project path	yes
search	SearchConfig	layer search configuration	no
services	LayerServicesConfig	OWS services options	no
sourceLayers	SourceLayerFilterConfig	source layers to use	no
title	`str`	layer title	no
type	`str`	“qgiswms”	yes
uid	`str`	layer unique id	no
zoom	ZoomConfig	layer resolutions and scales	no

LayerServicesConfig¶

Properties:

name	type		required	default
wmsEnabled	`bool`	enable this layer for the WMS service	no	true

LayerSqlConfig¶

SQL-based layer

Properties:

name	type		required	default
access	[AccessRuleConfig…]	access rights	no
clientOptions	LayerClientOptions	options for the layer display in the client	no
dataModel	[AttributeConfig…]		no
db	`str`	database provider uid	no
description	TemplateConfig	template for the layer description	no
edit	LayerEditConfig	editing permissions	no
editStyle	StyleProps	style for features being edited	no
extent	Extent	layer extent	no
extentBuffer	`int`	extent buffer	no
featureFormat	FormatConfig	feature formatting options	no
legend	LayerLegendConfig	legend configuration	no
loadingStrategy	`str`	loading strategy for features (‘all’, ‘bbox’)	no	“all”
meta	MetaConfig	layer meta data	no
opacity	`float`	layer opacity	no	1
search	SearchConfig	layer search configuration	no
services	LayerServicesConfig	OWS services options	no
style	StyleProps	style for features	no
table	SqlTableConfig	sql table configuration	yes
title	`str`	layer title	no
type	`str`	“sql”	yes
uid	`str`	layer unique id	no
zoom	ZoomConfig	layer resolutions and scales	no

LayerTileConfig¶

Tile layer

Properties:

name	type		required	default
access	[AccessRuleConfig…]	access rights	no
cache	LayerCacheConfig	cache configuration	no
clientOptions	LayerClientOptions	options for the layer display in the client	no
description	TemplateConfig	template for the layer description	no
display	LayerDisplayMode	layer display mode	no	“tile”
edit	LayerEditConfig	editing permissions	no
extent	Extent	layer extent	no
extentBuffer	`int`	extent buffer	no
featureFormat	FormatConfig	feature formatting options	no
grid	LayerGridConfig	grid configuration	no
imageFormat	LayerImageFormat	image format	no	“png8”
legend	LayerLegendConfig	legend configuration	no
maxRequests	`int`	max concurrent requests to this source	no	0
meta	MetaConfig	layer meta data	no
opacity	`float`	layer opacity	no	1
search	SearchConfig	layer search configuration	no
service	LayerTileServiceConfig	service configuration	no
services	LayerServicesConfig	OWS services options	no
title	`str`	layer title	no
type	`str`	“tile”	yes
uid	`str`	layer unique id	no
url	`url`	rest url with placeholders {x}, {y} and {z}	yes
zoom	ZoomConfig	layer resolutions and scales	no

LayerTileServiceConfig¶

Tile service configuration

Properties:

name	type		required	default
crs	`crsref`	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

LayerWfsConfig¶

WFS layer

Properties:

name	type		required	default
access	[AccessRuleConfig…]	access rights	no
capsCacheMaxAge	`duration`	max cache age for capabilities documents	no	“1d”
clientOptions	LayerClientOptions	options for the layer display in the client	no
dataModel	[AttributeConfig…]		no
description	TemplateConfig	template for the layer description	no
edit	LayerEditConfig	editing permissions	no
editStyle	StyleProps	style for features being edited	no
extent	Extent	layer extent	no
extentBuffer	`int`	extent buffer	no
featureFormat	FormatConfig	feature formatting options	no
invertAxis	[`crsref`…]	projections that have an inverted axis (yx)	no
legend	LayerLegendConfig	legend configuration	no
loadingStrategy	`str`	loading strategy for features (‘all’, ‘bbox’)	no	“all”
maxRequests	`int`	max concurrent requests to this source	no	0
meta	MetaConfig	layer meta data	no
opacity	`float`	layer opacity	no	1
search	SearchConfig	layer search configuration	no
services	LayerServicesConfig	OWS services options	no
sourceLayers	SourceLayerFilterConfig	source layers to use	no
style	StyleProps	style for features	no
title	`str`	layer title	no
type	`str`	“wfs”	yes
uid	`str`	layer unique id	no
url	`url`	service url	yes
zoom	ZoomConfig	layer resolutions and scales	no

LayerWmsConfig¶

WMS layer

Properties:

name	type		required	default
access	[AccessRuleConfig…]	access rights	no
cache	LayerCacheConfig	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	LayerClientOptions	options for the layer display in the client	no
description	TemplateConfig	template for the layer description	no
display	LayerDisplayMode	layer display mode	no	“box”
edit	LayerEditConfig	editing permissions	no
extent	Extent	layer extent	no
extentBuffer	`int`	extent buffer	no
featureFormat	FormatConfig	feature formatting options	no
getMapParams	`dict`	additional parameters for GetMap requests	no
grid	LayerGridConfig	grid configuration	no
imageFormat	LayerImageFormat	image format	no	“png8”
invertAxis	[`crsref`…]	projections that have an inverted axis (yx)	no
legend	LayerLegendConfig	legend configuration	no
maxRequests	`int`	max concurrent requests to this source	no	0
meta	MetaConfig	layer meta data	no
opacity	`float`	layer opacity	no	1
search	SearchConfig	layer search configuration	no
services	LayerServicesConfig	OWS services options	no
sourceLayers	SourceLayerFilterConfig	source layers to use	no
title	`str`	layer title	no
type	`str`	“wms”	yes
uid	`str`	layer unique id	no
url	`url`	service url	yes
zoom	ZoomConfig	layer resolutions and scales	no

LayerWmtsConfig¶

WMTS layer

Properties:

name	type		required	default
access	[AccessRuleConfig…]	access rights	no
cache	LayerCacheConfig	cache configuration	no
capsCacheMaxAge	`duration`	max cache age for capabilities documents	no	“1d”
clientOptions	LayerClientOptions	options for the layer display in the client	no
description	TemplateConfig	template for the layer description	no
display	LayerDisplayMode	layer display mode	no	“tile”
edit	LayerEditConfig	editing permissions	no
extent	Extent	layer extent	no
extentBuffer	`int`	extent buffer	no
featureFormat	FormatConfig	feature formatting options	no
grid	LayerGridConfig	grid configuration	no
imageFormat	LayerImageFormat	image format	no	“png8”
legend	LayerLegendConfig	legend configuration	no
maxRequests	`int`	max concurrent requests to this source	no	0
meta	MetaConfig	layer meta data	no
opacity	`float`	layer opacity	no	1
params	`dict`	query string parameters	no
search	SearchConfig	layer search configuration	no
services	LayerServicesConfig	OWS services options	no
sourceLayer	`str`	WMTS layer name	no
sourceStyle	`str`	WMTS style name	no	“default”
title	`str`	layer title	no
type	`str`	“wmts”	yes
uid	`str`	layer unique id	no
url	`url`	service url	yes
zoom	ZoomConfig	layer resolutions and scales	no

MapConfig¶

Map configuration

Properties:

name	type		required	default
center	Point	map center	no
coordinatePrecision	`int`	precision for coordinates	no
crs	`crsref`	crs for this map	no	“EPSG:3857”
extent	Extent	map extent	yes
extentBuffer	`int`	extent buffer	no
layers	[LayerConfig…]	collection of layers for this map	yes
title	`str`	map title	no
uid	`str`	unique id	no
zoom	ZoomConfig	map scales and resolutions	no

MetaConfig¶

Object metadata configuration

Properties:

name	type		required	default
abstract	`str`	object abstract description	no
attribution	`str`	attribution (copyright) string	no
contact	MetaContactConfig	contact information	no
image	`url`	image (logo) url	no
images	`dict`	further images	no
keywords	[`str`…]	keywords	no	[]
name	`str`	object internal name	no
title	`str`	object title	no
url	`url`	object metadata url	no

MetaContactConfig¶

Object metadata configuration

Properties:

name	type	required
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
zip	`str`	no

Point¶

Point coordinates [x, y]

PrinterConfig¶

Properties:

name	type		required	default
templates	[TemplateConfig…]		yes

ProjectConfig¶

Project configuration

Properties:

name	type		required
access	[AccessRuleConfig…]	access rights	no
api	ApiConfig	project-specific actions	no
assets	DocumentRootConfig	project-specific assets options	no
client	ClientConfig	project-specific gws client configuration	no
description	TemplateConfig	template for the project description	no
locales	[`str`…]	project locales	no
map	MapConfig	Map configuration	no
meta	MetaConfig	project metadata	no
multi	`regex`	filename pattern for a multi-project template	no
overviewMap	MapConfig	Overview map configuration	no
printer	PrinterConfig	printer configuration	no
search	SearchConfig	project-wide search configuration	no
title	`str`	project title	no
uid	`str`	unique id	no

SearchConfig¶

Properties:

name	type		required	default
enabled	`bool`	search is enabled	no	true
providers	[SearchProviderConfig…]	list of search prodivers	no

SearchProviderNominatimConfig¶

Nominatim (OSM) search provider

Properties:

name	type		required
access	[AccessRuleConfig…]	access rights	no
country	`str`	country to limit the search	no
defaultContext	`str`	default spatial context (‘view’ or ‘map’)	no
featureFormat	FormatConfig	feature formatting options	no
language	`str`	language to return the results in	no
title	`str`	search results title	no
type	`str`	“nominatim”	yes
uid	`str`	unique ID	no

SearchProviderQgispostgresConfig¶

Qgis/Postgres automatic search provider

Properties:

name	type		required
access	[AccessRuleConfig…]	access rights	no
defaultContext	`str`	default spatial context (‘view’ or ‘map’)	no
ds	`dict`	qgis data source	yes
featureFormat	FormatConfig	feature formatting options	no
title	`str`	search results title	no
type	`str`	“qgispostgres”	yes
uid	`str`	unique ID	no

SearchProviderQgiswmsConfig¶

Qgis/WMS automatic search provider

Properties:

name	type		required
access	[AccessRuleConfig…]	access rights	no
defaultContext	`str`	default spatial context (‘view’ or ‘map’)	no
featureFormat	FormatConfig	feature formatting options	no
path	`filepath`	project path	yes
sourceLayers	SourceLayerFilterConfig	source layers to use	no
title	`str`	search results title	no
type	`str`	“qgiswms”	yes
uid	`str`	unique ID	no

SearchProviderSqlConfig¶

Database-based search

Properties:

name	type		required	default
access	[AccessRuleConfig…]	access rights	no
db	`str`	database provider uid	no
defaultContext	`str`	default spatial context (‘view’ or ‘map’)	no
featureFormat	FormatConfig	feature formatting options	no
geometryRequired	`bool`		no	false
keywordRequired	`bool`		no	false
sort	`str`	sort expression	no
table	SqlTableConfig	sql table configuration	yes
title	`str`	search results title	no
type	`str`	“sql”	yes
uid	`str`	unique ID	no

SearchProviderWfsConfig¶

WMS search

Properties:

name	type		required	default
access	[AccessRuleConfig…]	access rights	no
capsCacheMaxAge	`duration`	max cache age for capabilities documents	no	“1d”
defaultContext	`str`	default spatial context (‘view’ or ‘map’)	no
featureFormat	FormatConfig	feature formatting options	no
invertAxis	[`crsref`…]	projections that have an inverted axis (yx)	no
maxRequests	`int`	max concurrent requests to this source	no	0
sourceLayers	SourceLayerFilterConfig	source layers to use	no
title	`str`	search results title	no
type	`str`	“wfs”	yes
uid	`str`	unique ID	no
url	`url`	service url	yes

SearchProviderWmsConfig¶

WMS search

Properties:

name	type		required	default
access	[AccessRuleConfig…]	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
defaultContext	`str`	default spatial context (‘view’ or ‘map’)	no
featureFormat	FormatConfig	feature formatting options	no
invertAxis	[`crsref`…]	projections that have an inverted axis (yx)	no
maxRequests	`int`	max concurrent requests to this source	no	0
sourceLayers	SourceLayerFilterConfig	source layers to use	no
title	`str`	search results title	no
type	`str`	“wms”	yes
uid	`str`	unique ID	no
url	`url`	service url	yes

ServerConfig¶

Server module configuation

Properties:

name	type		required	default
autoRun	`str`	shell command to run before server start	no
logLevel	LogLevel	logging level	no	“INFO”
mapproxy	ServerMapproxyConfig	bundled Mapproxy module	no
qgis	ServerQgisConfig	bundled Qgis module	no
spool	ServerSpoolConfig	spool server module	no
timeout	`duration`	server timeout	no	60
web	ServerWebConfig	web server module	no

ServerMapproxyConfig¶

Mapproxy server module

Properties:

name	type		required	default
enabled	`bool`	the module is enabled	no	true
host	`str`		no	“localhost”
port	`int`		no	5000
threads	`int`	number of threads for this module	no	0
workers	`int`	number of processes for this module	no	4

ServerQgisConfig¶

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`		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`		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
workers	`int`	number of processes for this module	no	4

ServerSpoolConfig¶

Spool server module

Properties:

name	type		required	default
enabled	`bool`	the module is enabled	no	true
jobFrequency	`duration`	background jobs checking frequency	no	3
monitorFrequency	`duration`	filesystem changes check frequency	no	30
threads	`int`	number of threads for this module	no	0
workers	`int`	number of processes for this module	no	4

ServerWebConfig¶

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
workers	`int`	number of processes for this module	no	4

SourceLayerFilterConfig¶

Layer filter

Properties:

name	type		required	default
level	`int`	use layers at this level	no	0
names	[`str`…]	use these layer names (top-to-bottom order)	no
pattern	`regex`	match a pattern against the layer full path	no

SqlTableConfig¶

SQL database table

Properties:

name	type		required	default
geometryColumn	`str`	geometry column name	no
keyColumn	`str`	primary key column name	no	“id”
name	`str`	table name	yes
searchColumn	`str`	column to be searched for	no

StorageSqliteConfig¶

Sqlite-based storage

Properties:

name	type		required	default
path	`str`		no
type	`str`	“sqlite”	yes

StyleProps¶

Feature style

Properties:

name	type		required
content	`dict`	css rules	no
text	`str`	raw style content	no
type	`str`	style type (“css”)	yes

TemplateConfig¶

Properties:

name	type		required
dataModel	[AttributeConfig…]	user-editable template attributes	no
path	`filepath`	path to a template file	no
qualityLevels	[TemplateQualityLevel…]	list of quality levels supported by the template	no
text	`str`	template content	no
title	`str`	template title	no
type	`str`	template type	yes
uid	`str`	unique id	no

TemplateHtmlConfig¶

HTML template

Properties:

name	type		required
dataModel	[AttributeConfig…]	user-editable template attributes	no
path	`filepath`	path to a template file	no
qualityLevels	[TemplateQualityLevel…]	list of quality levels supported by the template	no
text	`str`	template content	no
title	`str`	template title	no
type	`str`	“html”	yes
uid	`str`	unique id	no

TemplateQgisConfig¶

Qgis print template

Properties:

name	type		required
dataModel	[AttributeConfig…]	user-editable template attributes	no
path	`filepath`		yes
qualityLevels	[TemplateQualityLevel…]	list of quality levels supported by the template	no
text	`str`	template content	no
title	`str`	template title	no
type	`str`	“qgis”	yes
uid	`str`	unique id	no

TemplateQualityLevel¶

Quality level for a template

Properties:

name	type		required	default
dpi	`int`	dpi value	yes
name	`str`	level name	no

WebSiteConfig¶

Site (virtual host) configuration

Properties:

name	type		required	default
assets	DocumentRootConfig	assets location and options	no
cors	WebSiteCorsConfig	cors configuration	no
errorPage	TemplateConfig	error page template	no
host	`str`	host name	no	“*”
reversedRewrite	[WebSiteRewriteRule…]	reversed rewrite rules	no
reversedUrl	`str`	base url for reversed addresses	no
rewrite	[WebSiteRewriteRule…]	rewrite rules	no
root	DocumentRootConfig	document root location and options	yes

WebSiteCorsConfig¶

CORS options

Properties:

name	type	required	default
allowCredentials	`bool`	no	false
allowHeaders	[`str`…]	no
allowOrigin	`str`	no	“*”
enabled	`bool`	no	false

WebSiteRewriteRule¶

Rewrite rule

Properties:

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

ZoomConfig¶

Zoom levels and resolutions

Properties:

name	type		required
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