Open Source search based on OpenStreetMap data
Go to file
Sarah Hoffmann 298ed11261 introduce constant for configuration directory
This replaces {data_dir}/settings throughout the code, so that
the configuration may be placed somewhere else in the directory
structure (e.g. in /etc).
2021-02-09 18:45:45 +01:00
.github actions: switch to using separate project dir 2021-02-02 11:03:09 +01:00
cmake introduce constant for configuration directory 2021-02-09 18:45:45 +01:00
data move postcode table setup to sql/ 2021-02-08 11:53:01 +01:00
docs replace make serve with nominatim serve command 2021-02-03 16:34:31 +01:00
lib-php introduce constant for configuration directory 2021-02-09 18:45:45 +01:00
lib-sql rename sql directory to lib-sql 2021-02-09 15:26:56 +01:00
module add support for finding pg_config in Postgresql repos 2020-10-20 11:39:00 +02:00
munin Add some comments to help use munin plugin, add over limit detection 2014-01-14 23:50:28 +01:00
nominatim introduce constant for configuration directory 2021-02-09 18:45:45 +01:00
osm2pgsql@497476d56f update osm2pgsql (disable install rule) 2021-02-09 09:48:50 +01:00
settings refer to new nominatim tool in configuration comments 2021-02-02 10:56:40 +01:00
test introduce constant for configuration directory 2021-02-09 18:45:45 +01:00
utils integrate analyse of indexing into nominatim tool 2021-02-08 22:22:49 +01:00
vagrant replace Symfony dotenv dependency with Python dotenv 2021-01-14 18:31:18 +01: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
AUTHORS prepare release 3.2.0 2018-08-26 17:33:49 +02:00
ChangeLog prepare 3.6.0 release 2020-12-13 11:59:16 +01:00
CMakeLists.txt replace make serve with nominatim serve command 2021-02-03 16:34:31 +01:00
CONTRIBUTING.md whitelist pyosmium for pylint 2021-01-30 15:52:49 +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 adapt quick start instructions in README to project dir 2021-02-03 10:17:22 +01:00
VAGRANT.md VAGRANT.md: we use different database DSN syntax these days 2020-07-31 16:52:29 +02:00
Vagrantfile make CentOS 8 the default vagrant script 2020-09-16 17:34:36 +02: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. Use the discussions forum or ask for help 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 current master 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. Create a project directory, get OSM data and import:

     mkdir nominatim-project
     cd nominatim-project
     ~/build/nominatim import --osm-file <your planet file>
    
  3. Point your webserver to the nominatim-project/website directory.

License

The source code is available under a GPLv2 license.

Contributing

Contributions, bugreport and pull requests are welcome. For details see contribution guide.

Questions and help

For questions, community help and discussions you can use the Github discussions forum or join the geocoding mailing list.