Open Source search based on OpenStreetMap data
Go to file
Sarah Hoffmann 918fec73c6
Merge pull request #3341 from mtmail/remove-php-faq-entries
PHP related FAQ entries are no longer needed
2024-02-21 08:56:18 +01:00
.github actions: make php the legacy tests 2024-02-19 18:39:01 +01: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 PHP related FAQ entries are no longer needed 2024-02-20 18:55:02 +01: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 extratags should become null when empty 2024-02-08 10:21:48 +01:00
man mostly remove php-cgi requirement 2023-07-26 00:10:11 +02:00
module update CI tests to postgresql 15 2022-11-04 16:21:15 +01:00
munin docs: fix typos 2022-07-20 22:05:31 +08:00
nominatim API debug: properly escape non-highlighted code 2024-02-19 18:39:01 +01:00
osm2pgsql@415de9abdf update osm2pgsql to 1.9.2 2023-09-04 14:53:46 +02:00
settings fix issues found by luacheck 2024-02-20 10:43:51 +01:00
test bdd: be more verbose on HTML parsing error 2024-02-19 18:39:01 +01: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
.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 implement actual database searches 2023-05-24 13:52:31 +02:00
AUTHORS add consistent SPDX copyright headers 2022-01-03 16:23:58 +01:00
ChangeLog add changelog for 4.2.3 2023-09-07 10:07:16 +02:00
CMakeLists.txt make Python frontend default and PHP optional 2024-02-19 18:39:01 +01:00
CONTRIBUTING.md fixed typos in docs and code comments 2023-03-06 17:09:38 +05:30
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 add report on newest vulnerability 2023-11-20 10:44:48 +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.