Repository files navigation

Nominatim (from the Latin, 'by name') is a tool to search OpenStreetMap databy name and address (geocoding) and to generate synthetic addresses ofOSM points (reverse geocoding). An instance with up-to-date data can be foundathttps://nominatim.openstreetmap.org. Nominatim is also used as one of thesources for the Search box on the OpenStreetMap home page.

The documentation of the latest development version is in thedocs/ subdirectory. A HTML version can be found athttps://nominatim.org/release-docs/develop/ .

The latest stable release can be downloaded fromhttps://nominatim.org.There you can also findinstallation instructions for the release, as well as an extensiveTroubleshooting/FAQ section.

Detailed installation instructions for current mastercan be found at nominatim.org as well.

A quick summary of the necessary steps:

1. Create a Python virtualenv and install the packages:

    python3 -m venv nominatim-venv ./nominatim-venv/bin/pip install packaging/nominatim-{api,db}

2. Create a project directory, get OSM data and import:

    mkdir nominatim-project cd nominatim-project ../nominatim-venv/bin/nominatim import --osm-file <your planet file>

3. Start the webserver:

    ./nominatim-venv/bin/pip install uvicorn falcon ../nominatim-venv/bin/nominatim serve

The Python source code is available under a GPL license version 3 or later.The Lua configuration files for osm2pgsql are released under theApache License, Version 2.0. All other files are under a GPLv2 license.

Contributions, bug reports and pull requests are welcome. When reporting abug, please use one of theissue templatesand make sure to provide all the information requested. If you are notsure if you have really found a bug, please ask for help in the forumsfirst (see 'Questions' below).

For details on contributing, have a look at thecontribution guide.

If you have questions about search results and the OpenStreetMap dataused in the search, use theOSM Forum.

For questions, community help and discussions around the software andyour own installation of Nominatim, use theGithub discussions forum.