Open Source search based on OpenStreetMap data
Go to file
Sarah Hoffmann e2416f90af installation for Ubuntu 24.04 with packages
Also remove Ubuntu 20.04 instructions.
2024-06-26 11:52:47 +02:00
.github update licenses and discussion links 2024-06-26 11:52:47 +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 installation for Ubuntu 24.04 with packages 2024-06-26 11:52:47 +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 invalidation of child objects on large street features 2024-06-19 14:23:29 +02:00
LICENSES update licenses and discussion links 2024-06-26 11:52:47 +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
osm2pgsql@cf66989fa2 update osm2pgsql to 1.11.0 2024-02-27 10:15:36 +01:00
packaging installation for Ubuntu 24.04 with packages 2024-06-26 11:52:47 +02:00
settings address and street style: switch to explicit choice of highway values 2024-05-05 11:21:48 +02:00
src switch to symlink approach for packages 2024-06-26 11:52:47 +02:00
test adapt bdd tests to new layout 2024-06-26 11:52:47 +02:00
utils port multi-region update scripts to nominatim tool 2021-08-14 23:55:48 +02:00
vagrant installation for Ubuntu 24.04 with packages 2024-06-26 11:52:47 +02:00
.codespellrc Github Actions: add codespell linter, warn only 2024-03-04 00:22:24 +01:00
.gitignore switch to symlink approach for packages 2024-06-26 11:52:47 +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 adapt cmake to new directory structure 2024-06-26 11:52:47 +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 installation for Ubuntu 24.04 with packages 2024-06-26 11:52:47 +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 installation for Ubuntu 24.04 with packages 2024-06-26 11:52:47 +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.