QWC Config generator

QWC Config generator

Type: object

root $schema

JSON Schema

Type: stringFormat: uri Default: "https://github.com/qwc-services/qwc-config-generator/raw/master/schemas/qwc-config-generator.json"

Reference to JSON schema of this config

root service

Service name

Type: const
Specific value: "config-generator"

root template

Optional, path to a tenantConfig template. If specified, the contents of the file is merged with the contents of tenantConfig.json. Any occurence of $tenant$ in the template will be replaced with the current tenant name.

Type: string

root themesConfig

QWC2 themes configuration


root themesConfig oneOf item 0
Type: object

Corresponds to contents of standalone QWC2 themesConfig.json

root themesConfig oneOf item 0 themes
Type: object
root themesConfig oneOf item 1
Type: string

Path to themesConfig.json

root config

Config options for Config generator

Type: object

root config tenant
Type: string

Tenant name. Example: default

root config config_db_url
Type: stringFormat: uri

Connection URL for configuration database. Example: postgresql:///?service=qwc_configdb

root config default_qgis_server_url
Type: stringFormat: uri

Default QGIS Server URL for OGC requests. Example: http://qwc-qgis-server/ows/

root config ows_prefix
Type: string

OWS service path prefix. Defaults to the path component of defaultqgisserverurl. Used to form the urls of autodetected projects below qgisprojectsscanbase_dir. Example: /ows

root config qgis_project_extension
Type: string

The QGIS project file extension to look for. Default: '.qgs'

root config qgis_projects_base_dir
Type: string

Base path for QGIS projects. Example: /data

root config qgis_print_layouts_dir
Type: string

Directory containing print layouts. Example: /layouts

root config qgis_projects_scan_base_dir
Type: string

Path for QGIS projects, which should be automatically detected. Must be a subdir qgisprojectsbase_dir. Example: /data/scan

root config qgis_projects_gen_base_dir
Type: string

Path for generated QGIS projects, result of preprocessing. Must be a subdir of qgisprojectsbasedir. Can be the same as qgisprojectsscanbase_dir, in which case the theme autodetection will apply to generated QGIS projects. Example: /data/gen

root config permissions_default_allow
Type: boolean

Set whether resources are permitted or restricted by default. Example: true

root config validate_schema
Type: boolean

Validate configuration against schema. Example: true

root config config_path
Type: string

Target path for generated service configs and permissions, if not set by $OUTPUTCONFIGPATH. Example: /config-out

root config qwc2_base_dir
Type: string

Path to the QWC2 directory, which will be used to autodetect thumbnails. If qgisprojectsscanbasedir is not set, then this option will be ignored. Example /qwc2

root config skip_print_layer_groups
Type: boolean

Skip group layers containing print layers

root config layer_opacities
Type: object

Layer opacity values for QGIS <= 3.10

root config split_categorized_layers
Type: boolean

Set to true to activate the categorize groups functionality

root config project_settings_read_timeout
Type: number

Timeout for GetProjectSettings, GetCapabilities and DescribeFeatureType requests. Default: 60sec

root config autogen_keyvaltable_datasets
Type: boolean

Whether to automatically generate data service datasets used for key-value relationships without requiring corresponding data resources to be created. Warning: this will expose the key and value fields of the key-value table as world readable. Default: false

root config generate_nested_nrel_forms
Type: boolean

Whether to generate nested nrelation forms instead of a tabluar view. Default: false

root config generate_wfs_services
Type: boolean

Generate WFS service resources and permissions for the OGC service. Default: false

root config use_default_map_thumbnail
Type: object

Whether to use the default mapthumb (mapthumbs/default.jpg) instead of generating the thumbnail via GetMap if no custom thumbnail is provided. Default: false

root services

Service configs

Type: array

Service specific config options for generating their service configs

 No Additional Items

Each item of this array must be:

root services services items

Generator config for a service

root services services items oneOf common_service
Type: object

Generator config for a QWC service

root services services items oneOf item 0 name
Type: enum (of string)

Service name

Must be one of:

  • "adminGui"
  • "data"
  • "dbAuth"
  • "elevation"
  • "featureInfo"
  • "mapinfo"
  • "permalink"
  • "print"
  • "search"
  • "legend"

root services services items oneOf item 0 config
Type: object

QWC service config options (cf. its JSON schema). This is copied unmodified to the service config.
root services services items oneOf mapViewer
Type: object

Generator config for Map Viewer

root services services items oneOf item 1 name
Type: const

Service name

Specific value: "mapViewer"

root services services items oneOf item 1 generator_config
Type: object

Additional config for generating MapViewer resources

root services services items oneOf item 1 generator_config qwc2_config
Type: object

Additional config for QWC2 application configuration

root services services items oneOf item 1 generator_config qwc2_config qwc2_config_file
Type: string

Path to QWC2 config.json file. Example: /qwc2/config.json

root services services items oneOf item 1 generator_config qwc2_config qwc2_index_file
Type: string

Path to QWC2 index.html file. Example: /qwc2/index.html

root services services items oneOf item 1 config
Type: object

Map Viewer config options (cf. JSON schema qwc-map-viewer.json). This is copied unmodified to the service config.
root services services items oneOf ogc
Type: object

Generator config for OGC service

root services services items oneOf item 2 name
Type: const

Service name

Specific value: "ogc"

root services services items oneOf item 2 generator_config
Type: object

Additional config for generating OGC service resources

root services services items oneOf item 2 generator_config wms_services
Type: object

Additional config for WMS services

root services services items oneOf item 2 generator_config wms_services online_resources
Type: object

Custom OnlineResources shown in GetCapabilities

root services services items oneOf item 2 generator_config wms_services online_resources service
Type: stringFormat: uri

Default public base URL for OnlineResources

root services services items oneOf item 2 generator_config wms_services online_resources feature_info
Type: stringFormat: uri

Public base URL for FeatureInfo OnlineResources

root services services items oneOf item 2 generator_config wms_services online_resources legend
Type: stringFormat: uri

Public base URL for Legend OnlineResources

root services services items oneOf item 2 config
Type: object

OGC service config options (cf. JSON schema qwc-ogc-service.json). This is copied unmodified to the service config.