Configuration

Configuring ckanext-gztr

Here we will go over the steps involved for customizing your installation of ckanext-gztr followed by all of the available configuration options. For maximum configuration you could fork the ckanext-gztr git repository, make your own changes, and then use that fork for your use cases. However we attempt to consolidate some configurable options used throughout ckanext-gztr that may be common for various use cases.

Modify your CKAN config INI file or environment variables

The extension provides multiple configuration options that can be defined in your CKAN configuration file, which in a CKAN source install is available at /etc/ckan/default/ckan.ini by default. You can add these options and values to customize your installation of ckanext-gztr for your CKAN instance for the next time you run your CKAN instance (e.g. by running ckan -c /etc/ckan/default/ckan.ini run). The available configuration options are listed further below on this page.

If you use ckanext-envvars then each configuration option should be modifiable by environment variable declarations. For example the ckanext.gztr.enable_drawn_features configuration option can have its value set by the environment variable CKANEXT__GZTR__ENABLE_DRAWN_FEATURES. This method can be useful when deploying CKAN with Docker or Docker Compose.

General options

# Default map configuration for gazetteers (for example here we use New Mexico's location).
ckanext.gztr.default_latitude = 34.0
ckanext.gztr.default_longitude = -106.018066
ckanext.gztr.default_zoom = 5
# URL to map tile server whose tiles are rendered on the maps.
ckanext.gztr.map_tile_server = https://tiles.openfreemap.org/styles/liberty

Public search gazetteer

# Display or hide the address search feature which uses Nominatim.
ckanext.gztr.search.enable_nominatim_search = true
# Display or hide the feature collections preview dropdown.
ckanext.gztr.search.enable_feature_categories_preview = true

Dataset form configuration

We prefix configuration specific to the dataset form with ckanext.gztr.form (e.g. configuration for the dataset publisher gazetteer, place keywords, etc.).

# Whether to allow data publishers to draw custom polygons as features.
# Set this to false if you want data publishers to only use preset features.
ckanext.gztr.form.enable_drawn_features = true
ckanext.gztr.form.dialog_map_height = 60vh

Public search preview map

Dataset search results preview maps

Dataset landing page preview map

Geoconnex integration

This configuration is used when enabling the Geoconnex integration.

# Set this field to true to enable Geoconnex-specific features
ckanext.gztr.geoconnex.enable = false

Apache SedonaDB