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

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

The latest stable release can be downloaded from https://nominatim.org. There you can also find installation instructions for the release.

Detailed installation instructions for the development version can be found at nominatim.org as well.

A quick summary of the necessary steps:

1. Compile Nominatim:

    mkdir build
    cd build
    cmake ..
    make
   

2. Get OSM data and import:

    ./build/utils/setup.php --osm-file <your planet file> --all
   

3. Point your webserver to the ./build/website directory.

The source code is available under a GPLv2 license.

For questions you can join the geocoding mailinglist, see https://lists.openstreetmap.org/listinfo/geocoding

Bugs may be reported on the github project site: https://github.com/openstreetmap/Nominatim