Open Source search based on OpenStreetMap data
Go to file
Sarah Hoffmann f535340d5a
Merge pull request #3520 from lonvia/restrict-interpolation-range
Restrict interpolation housenumbers to 0-999999
2024-08-20 09:03:52 +02:00
.github switch CI to new handling of legacy BDD tests 2024-07-31 11:16:49 +02:00
cmake adapt cmake to new directory structure 2024-06-26 11:52:47 +02:00
data modify data import logic to load country names from yaml 2022-03-12 15:20:57 +08:00
docs improve error message on missing modules from nominatim_api 2024-08-17 10:03:36 +02:00
lib-php Allow negative osm_id in details page by setting default parameter to 0 2023-08-11 10:46:28 +02:00
lib-sql restrict interpolation housenumbers to 0-999999 2024-08-19 20:40:25 +02:00
LICENSES update licenses and discussion links 2024-06-26 11:52:47 +02:00
man build man page without CMake 2024-08-07 16:38:56 +02:00
module fix compilation of PG module for PostgreSQL 16 2024-03-05 16:31:02 +01:00
munin docs: fix typos 2022-07-20 22:05:31 +08:00
osm2pgsql@cf66989fa2 update osm2pgsql to 1.11.0 2024-02-27 10:15:36 +01:00
packaging fix dependencies and adapt documentation for psycopg3 2024-07-29 08:54:09 +02:00
settings drop amenity=waste_prposal and amenity=hunting_stand 2024-07-30 10:41:13 +02:00
src import requests library later than osmium 2024-08-19 16:36:09 +02:00
test make NominatimAPI[Async] a context manager 2024-08-19 11:31:38 +02:00
utils port multi-region update scripts to nominatim tool 2021-08-14 23:55:48 +02:00
vagrant vagrant install: remove custom python path 2024-08-13 09:31:36 +02:00
.codespellrc Github Actions: add codespell linter, warn only 2024-03-04 00:22:24 +01:00
.gitignore move generated docs to site-html 2024-08-07 16:48:22 +02:00
.gitmodules update osm2pgsql to latest version 2012-09-29 18:53:21 +02:00
.mypy.ini add SQLAlchemy table schema for Nominatim tables 2023-01-28 11:51:26 +01:00
.pylintrc add-data: warn and exit if database is frozen 2024-08-05 16:14:19 +02:00
AUTHORS add consistent SPDX copyright headers 2022-01-03 16:23:58 +01:00
ChangeLog prepare release 4.4.0 2024-03-07 11:43:01 +01:00
CMakeLists.txt add deprecation warnings in the code 2024-08-09 19:25:15 +02:00
CONTRIBUTING.md Correct some typos 2024-02-26 18:13:30 +01:00
COPYING update licenses and discussion links 2024-06-26 11:52:47 +02:00
Makefile build man page without CMake 2024-08-07 16:38:56 +02:00
mkdocs.yml add documentation for custom formatters 2024-08-14 18:24:40 +02:00
nominatim-cli.py add script for in-source execution 2024-06-26 11:52:47 +02:00
phpcs.xml add PHPCS Squiz.Arrays.ArrayDeclaration.KeyNotAligned rule 2018-05-08 00:37:41 +02:00
README.md update licenses and discussion links 2024-06-26 11:52:47 +02:00
SECURITY.md prepare release 4.4.0 2024-03-07 11:43:01 +01:00
VAGRANT.md VAGRANT.md - replace local.php settings with .env 2022-12-22 03:12:30 +01:00
Vagrantfile Development environment: add missing dependencies 2024-08-09 17:57:18 +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

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
     sudo make install
    
  2. Create a project directory, get OSM data and import:

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

License

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

Contributing

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

For details on contributing, have a look at the contribution guide.

Questions and help

If you have questions about search results and the OpenStreetMap data used in the search, use the OSM Forum.

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