Documentation

The following tutorials explain how you can use the OSMNames project. Feel free to submit an issue if you think something is missing or does not run as it should.

Install the OSMNames Search on your computer

The fastest way how to run the OSMNames geocoding service on your computer is to use Docker which provides a container with all the software components installed in Debian and already configured.

To start on your laptop/desktop with a graphical user interface, get the Kitematic and search for “osmnames-sphinxsearch”. This downloads and starts the container OSMNames software and with sample data (top 100k places worldwide). The web service will run directly on your localhost.

To start the system from command-line (for example on a server) use instead this command:

docker run -d -p 80:80 klokantech/osmnames-sphinxsearch

In both cases - you can easily replace sample data with your own file data.tsv, which has to be located in the container internal path /data/input/data.tsv:

docker run -d \
    -v /path/to/folder/data.tsv:/data/input/ \
    -p 80:80 \
    klokantech/osmnames-sphinxsearch

This file will be indexed on the first run or if index files are missing. The generated indexes for the whole world are large (over 30GBytes) and time consuming (about 45minutes) to create. But the process is done only once.

You can specify path for index folder on your computer as well:

docker run -d \
    -v /path/to/index/folder/:/data/index/ \
    -v /path/to/data/folder/:/data/input/ \
    -p 80:80 \
    klokantech/osmnames-sphinxsearch

Even easier alternative is to create on your computer data folder with structure:

/path/to/folder/
/path/to/folder/input/
/path/to/folder/input/data.tsv
/path/to/folder/index/

and then directly use it with a simple command: docker run -d -v /path/to/folder/:/data/ -p 80:80 klokantech/osmnames-sphinxsearch or from Kitematic.

If you are not familiar with the docker and you want to directly install the project on Linux, then you can do that too of course. The main search system is written in python (Flask) and requires the search engine (SphinxSearch). A step by step setup for Debian is visible here.

Generate the data from raw OSM data

You can always downnload the prepared world data and filter it for your needs.

In case you want to improve, modify or regenerate or extend the data by yourself you are welcome to do this.

The whole process is described in the manual available at http://osmnames.readthedocs.io/ and in the Getting started section in the README.md.

Project Partners

Do you need commercial support, customization or help with deployment of the geocoder on your server or setup of the autocomplete service or map tile hosting? Contact us.

OSMNames project is maintained by the OSM community, Geometa Lab HSR and Klokan Technologies