Open Source search based on OpenStreetMap data
Go to file
Sarah Hoffmann 97a9a262bb
Merge pull request #1764 from mtmail/docs-countrycodes-based-on-adminlevel-2
API docs: countrycode assignment happens using admin_level=2 tags
2020-04-22 09:57:59 +02:00
cmake Restructure script and website installation 2018-12-02 11:13:48 +01:00
data make US postcode data to an optional download 2019-07-24 01:13:57 +02:00
data-sources Updated TIGER database link in documentation (#1725) 2020-03-27 15:50:05 +01:00
docs API documentation: clarification countrycode assignment happens using admin_level=2 tags 2020-04-21 17:42:12 +02:00
lib highway:construction should appear as 'road' in the address list 2020-04-22 09:08:33 +02:00
module Support whitespace characters(x09-x0d) as single space 2020-04-02 05:04:40 +05:30
munin Add some comments to help use munin plugin, add over limit detection 2014-01-14 23:50:28 +01:00
nominatim nominatim.py: fix wrong use of assert 2020-04-19 17:59:49 +02:00
osm2pgsql@cb7655a4ff update osm2pgsql (gazetteer output tests) 2020-01-04 16:20:52 +01:00
settings downgrade waterways 2020-04-14 17:14:20 +02:00
sql address ranks must not invert admin_level hierarchy 2020-04-11 20:56:30 +02:00
test highway:construction should appear as 'road' in the address list 2020-04-22 09:08:33 +02:00
utils Fix documentation links (#1760) 2020-04-19 00:42:24 +02:00
vagrant psycopg 2.6 is now usable on ubuntu 16 2020-02-11 22:49:03 +01:00
website fix logging of lookup calls 2020-04-13 11:55:24 +02:00
.gitignore move from autotools to cmake and update osm2pgsql 2016-02-29 22:26:55 +01:00
.gitmodules update osm2pgsql to latest version 2012-09-29 18:53:21 +02:00
.travis.yml travis-ci configuration: remove -sudo-, add -os- 2020-04-10 01:20:51 +02:00
AUTHORS prepare release 3.2.0 2018-08-26 17:33:49 +02:00
ChangeLog prepare for 3.4.0 release 2019-10-25 22:04:59 +02:00
CMakeLists.txt update cMake build documentation 2020-01-24 22:53:26 +01:00
CONTRIBUTING.md update minimum required RAM to 64GB 2019-11-24 10:31:34 +01:00
COPYING tabs-to-spaces 2016-09-04 03:19:48 +02:00
phpcs.xml add PHPCS Squiz.Arrays.ArrayDeclaration.KeyNotAligned rule 2018-05-08 00:37:41 +02:00
README.md fix Travis-CI badge in README output 2020-04-13 17:55:17 +02:00
VAGRANT.md Fix documentation links (#1760) 2020-04-19 00:42:24 +02:00
Vagrantfile Vagrant setup for CentOS 8 2020-02-06 00:43:30 +01:00

Build Status

Nominatim

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.

Documentation

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/ .

Installation

Nominatim is a complex piece of software and runs in a complex environment. Installing and running Nominatim is something for experienced system administrators only who can do some trouble-shooting themselves. We are sorry, but we can not provide installation support. We are all doing this in our free time and there is just so much of that time to go around. Do not open issues in our bug tracker if you need help. You can ask questions on the mailing list (see below) or on help.openstreetmap.org.

The latest stable release can be downloaded from https://nominatim.org. There you can also find installation instructions for the release, as well as an extensive Troubleshooting/FAQ section.

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.

License

The source code is available under a GPLv2 license.

Contributing

Contributions are welcome. For details see contribution guide.

Both bug reports and pull requests are welcome.

Mailing list

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