Open Source search based on OpenStreetMap data
Go to file
2024-05-16 15:23:54 +02:00
.github actions: use newest pytest-asyncio for ubuntu 20 2024-05-02 11:06:45 +02:00
cmake make Python frontend default and PHP optional 2024-02-19 18:39:01 +01:00
data modify data import logic to load country names from yaml 2022-03-12 15:20:57 +08:00
docs Update Output place_id documentation to match implementation 2024-05-14 12:00:17 -06: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 add CSV format for importance import 2024-05-16 15:23:54 +02:00
man mostly remove php-cgi requirement 2023-07-26 00:10:11 +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
nominatim add CSV format for importance import 2024-05-16 15:23:54 +02:00
osm2pgsql@cf66989fa2 update osm2pgsql to 1.11.0 2024-02-27 10:15:36 +01:00
settings address and street style: switch to explicit choice of highway values 2024-05-05 11:21:48 +02:00
test add CSV format for importance import 2024-05-16 15:23:54 +02:00
utils port multi-region update scripts to nominatim tool 2021-08-14 23:55:48 +02:00
vagrant switch Ubuntu installation scripts to Python frontend 2024-02-19 18:39:01 +01:00
.codespellrc Github Actions: add codespell linter, warn only 2024-03-04 00:22:24 +01:00
.gitignore docs: section about database layout 2021-10-29 12:03: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 work around new pylint warnings 2024-05-14 14:50:37 +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 prepare release 4.4.0 2024-03-07 11:43:01 +01:00
CONTRIBUTING.md Correct some typos 2024-02-26 18:13:30 +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 Remove the installation warning 2021-09-19 13:01:32 +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 switch Ubuntu installation scripts to Python frontend 2024-02-19 18:39:01 +01:00

Build Status codecov

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