Generate JSON files for service configs and permissions from WMS GetCapabilities, QGS projects and QWC ConfigDB.
Create a ConfigGenerator config file tenantConfig.json for each tenant (see below).
Example tenantConfig.json:
{
"$schema": "https://github.com/qwc-services/qwc-config-generator/raw/master/schemas/qwc-config-generator.json",
"service": "config-generator",
"config": {
"tenant": "default",
"config_db_url": "postgresql:///?service=qwc_configdb",
"default_qgis_server_url": "http://localhost:8001/ows/",
"qgis_projects_base_dir": "/data",
"qgis_projects_scan_base_dir": "/data/scan",
"qgis_projects_gen_base_dir": "/data/gen",
"permissions_default_allow": true,
"validate_schema": true,
"autogen_keyvaltable_datasets": false
},
"themesConfig": {
"defaultScales": [100000000, 50000000, 25000000, 10000000, 4000000, 2000000, 1000000, 400000, 200000, 80000, 40000, 20000, 10000, 8000, 6000, 4000, 2000, 1000, 500, 250, 100],
"defaultPrintGrid": [{"s": 10000000, "x": 1000000, "y": 1000000}, {"s": 1000000, "x": 100000, "y": 100000}, {"s": 100000, "x": 10000, "y": 10000}, {"s": 10000, "x": 1000, "y": 1000}, {"s": 1000, "x": 100, "y": 100}, {"s": 100, "x": 10, "y": 10}],
"defaultWMSVersion":"1.3.0",
"defaultBackgroundLayers": [],
"defaultSearchProviders": ["coordinates"],
"defaultMapCrs": "EPSG:3857",
"themes": {
"items": [
{
"title": "Demo",
"url": "/ows/qwc_demo",
"default": true,
"attribution": "Demo attribution",
"attributionUrl": "https://127.0.0.1/",
"backgroundLayers": [
{
"name": "bluemarble",
"printLayer": "bluemarble_bg",
"visibility": true
},
{
"name": "mapnik",
"printLayer": "osm_bg"
}
],
"searchProviders": ["coordinates"],
"mapCrs": "EPSG:3857",
"additionalMouseCrs": [],
"extent": [-1000000, 4000000, 3000000, 8000000],
"skipEmptyFeatureAttributes": true,
"printResolutions": [300],
"thumbnail": "default.jpg"
}
],
"backgroundLayers": [
{
"name": "mapnik",
"title": "Open Street Map",
"type": "osm",
"source": "osm",
"thumbnail": "mapnik.jpg",
"attribution": "OpenStreetMap contributors",
"attributionUrl": "https://www.openstreetmap.org/copyright"
}
]
}
},
"custom_resource_types": [],
"services": [
{
"name": "ogc",
"generator_config": {
"wms_services": {
"online_resources": {
"service": "http://localhost:8088/ows/",
"feature_info": "http://localhost:8088/ows/",
"legend": "http://localhost:8088/ows/"
}
}
},
"config": {
"default_qgis_server_url": "http://qwc-qgis-server/ows/"
}
},
{
"name": "mapViewer",
"generator_config": {
"qwc2_config": {
"qwc2_config_file": "../qwc-docker/volumes/qwc2/config.json",
"qwc2_index_file": "../qwc-docker/volumes/qwc2/index.html"
}
},
"config": {
"qwc2_path": "/qwc2/",
"auth_service_url": "/auth/",
"data_service_url": "/api/v1/data/",
"#document_service_url": "/api/v1/document/",
"elevation_service_url": "/elevation/",
"#info_service_url": "/api/v1/featureinfo/",
"#legend_service_url": "/api/v1/legend/",
"mapinfo_service_url": "/api/v1/mapinfo/",
"ogc_service_url": "/ows/",
"permalink_service_url": "/api/v1/permalink/",
"#print_service_url": "/api/v1/print/",
"search_data_service_url": "/api/v1/data/",
"search_service_url": "/api/v2/search/"
}
},
{
"name": "featureInfo",
"config": {
"default_qgis_server_url": "http://qwc-qgis-server/ows/"
}
},
{
"name": "search",
"config": {
"solr_service_url": "http://qwc-solr:8983/solr/gdi/select",
"search_result_limit": 50,
"db_url": "postgresql:///?service=qwc_geodb"
},
"resources": {
"facets": [
{
"name": "background",
"filter_word": "Background"
},
{
"name": "foreground",
"filter_word": "Map"
},
{
"name": "ne_10m_admin_0_countries",
"filter_word": "Country",
"table_name": "qwc_geodb.search_v",
"geometry_column": "geom",
"facet_column": "subclass"
}
]
},
"permissions": [
{
"role": "public",
"permissions": {
"dataproducts": [
"qwc_demo"
],
"solr_facets": [
"foreground",
"ne_10m_admin_0_countries"
]
}
}
]
}
]
}For a full example see tenantConfig-example.json (JSON schema).
NOTE: the QWC2 themes config is defined under themesConfig in the ConfigGenerator config and not in a separate file.
QGIS projects can be automatically detected when qgis_projects_scan_base_dir is defined.
For adding these projects, the following settings need to be defined in themesConfig.
defaultBackgroundLayersdefaultSearchProvidersdefaultMapCrs
Additionally the config generator can also autodetect thumbnails when adding projects that meet the following criteria:
qwc2_base_diris defined in the ConfigGenerator config- the thumbnail of the project is located in the QWC2 thumbnail directory (Example:
/qwc/assets/img/mapthumbs) - the thumbnail image has the same filename as the QGIS project
The config generator also has the ability to split a layer, that has been classified with QGIS, into multiple layers and move them into a new group (The group name will be the original layer name). The following steps need to be done, to activate this functionality:
-
Set ConfigGenerator config:
"split_categorized_layers": true -
Define the environment variable
QGIS_APPLICATION_PREFIX_PATH(default:/usr). The prefix path is the location where QGIS is installed on your system. This is needed by the split function, because it uses theqgis.corelibrary.
NOTE: The Search service config takes its resources directly from the ConfigGenerator config. Its Permissions are collected from the ConfigDB (solr_facet resources), unless they are defined in the ConfigGenerator config.
NOTE: the FeatureInfo service config may take additional WMS service resources and permissions directly from the ConfigGenerator config, e.g. for external info layers. Its Permissions are collected from the ConfigDB (feature_info_service, feature_info_layer resources), unless they are defined in the ConfigGenerator config. Example:
{
"name": "featureInfo",
"config": {
"default_qgis_server_url": "http://qwc-qgis-server/ows/"
},
"resources": {
"wms_services": [
{
"name": "external_info_layers",
"root_layer": {
"name": "external_info_layers",
"layers": [
{
"name": "example_info_layer",
"title": "External info layer",
"attributes": [
{
"name": "name"
},
{
"name": "geometry"
}
],
"info_template": {
"type": "wms",
"wms_url": "https://example.com/wms/demo"
}
}
]
}
}
]
},
"permissions": [
{
"role": "public",
"permissions": {
"wms_services": [
{
"name": "external_info_layers",
"layers": [
{
"name": "external_info_layers"
},
{
"name": "example_info_layer",
"attributes": ["name", "geometry"],
"info_template": true
}
]
}
]
}
}
]
}By default, the config-generator will validate the service configurations in tenantConfig.json against the schema definition of the service. The JSON Schemas are loaded from local files in JSON_SCHEMAS_PATH, or else downloaded from https://github.com/qwc-services/ if no schema files are present. You can disable the schema validation by setting "validate_schema": false in config-generator config block in tenantConfig.json.
Using the permissions_default_allow setting, some resources can be set to be permitted or restricted by default if no permissions are set (default: true). Affected resources are map, layer, print_template and viewer_task.
- i.e.
permissions_default_allow: true: all maps, layers and attributes are permitted by default - i.e.
permissions_default_allow: false: maps and layers are only available if their resources and permissions are explicitly configured; though attributes are still permitted by default
If you want to define custom resource types for a custom service, you can add a record for the resource type to the configdb
INSERT INTO qwc_config.resource_types(name, description, list_order) values ('<resource_name>', '<resource_description>', <list_order>);
and then add it to the custom_resource_types setting.
Show command options:
python config_generator_cli.py --help
Generate both service configs and permissions:
python config_generator_cli.py ./tenantConfig.json all
Generate service config files:
python config_generator_cli.py ./tenantConfig.json service_configs
Generate permissions file:
python config_generator_cli.py ./tenantConfig.json permissions
Set the INPUT_CONFIG_PATH environment variable to the base dir for reading generator config files (default: config-in/).
Set the OUTPUT_CONFIG_PATH environment variable to the base dir for writing service configs and permissions (default: /tmp/).
NOTE: Requires write permissions for config-generator docker user (www-data) in OUTPUT_CONFIG_PATH for writing service configs and permissions.
Base URL:
http://localhost:5010/
Generate both service configs and permissions for default tenant:
curl -X POST "http://localhost:5010/generate_configs?tenant=default"
Optionally change the JSON_SCHEMAS_PATH environment variable to the target dir for JSON schemas (default /tmp/).
Optionally change schema URLs in schema-versions.json to desired versions (default: current master).
Download JSON schemas:
python download_json_schemas.py
Create a virtual environment:
virtualenv --python=/usr/bin/python3 --system-site-package .venv
Activate virtual environment:
source .venv/bin/activate
Install requirements (NOTE: additionally requires modules from python-qgis):
pip install -r requirements.txt
Run Demo-DB and QGIS Server:
cd ../qwc-docker && docker-compose up -d qwc-postgis qwc-qgis-server
Generate service configs and permissions for Docker:
python config_generator_cli.py ./tenantConfig-example.json all