Skip to content

make Nominatim host and protocol configurable via search service options#12316

Open
jwkaltz wants to merge 3 commits intogeosolutions-it:masterfrom
jwkaltz:overrideable_nominatim_url
Open

make Nominatim host and protocol configurable via search service options#12316
jwkaltz wants to merge 3 commits intogeosolutions-it:masterfrom
jwkaltz:overrideable_nominatim_url

Conversation

@jwkaltz
Copy link
Copy Markdown

@jwkaltz jwkaltz commented Apr 27, 2026

Description

Restructure nominatim URL construction in order to make hostname and protocol overrideable.
Add tests for Nominatim.

Please check if the PR fulfills these requirements

What kind of change does this PR introduce? (check one with "x", remove the others)

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • CI related changes
  • Other... Please describe:

Issue

What is the current behavior?
The Nominatim geocoding endpoint is currently hardcoded as
https://nominatim.openstreetmap.org in web/client/api/nominatim.js.

This prevents users from configuring a custom Nominatim instance, which is required for:

  • Air-gapped / offline deployments
  • Private Nominatim instances for higher rate limits
  • On-premise deployments where external internet access is restricted

What is the new behavior?
Read host and protocol from the service options object, falling back to the current defaults if not provided. This is fully backwards compatible — existing configurations continue to work unchanged.

Breaking change

Does this PR introduce a breaking change? (check one with "x", remove the other)

  • Yes, and I documented them in migration notes
  • No

Other useful information

After this change, there will be more options in localConfig.json or via overrideLocalConfig:

{
  "type": "nominatim",
  "priority": 5,
  "options": {
    "host": "my-nominatim.example.com",
    "protocol": "https",
    "limit": 10,
    "polygon_geojson": 1
  }
}

@cla-bot
Copy link
Copy Markdown

cla-bot Bot commented Apr 27, 2026

Thank you for your pull request and welcome to our community. We could not parse the GitHub identity of the following contributors: Wolfgang Kaltz.
This is most likely caused by a git client misconfiguration; please make sure to:

  1. check if your git client is configured with an email to sign commits git config --list | grep email
  2. If not, set it up using git config --global user.email email@example.com
  3. Make sure that the git commit email is configured in your GitHub account settings, see https://github.com/settings/emails

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant