osm-search/Nominatim
1
1
Fork 0
mirror of https://github.com/osm-search/Nominatim.git synced 2024-12-27 06:51:42 +03:00
Code Issues Packages Projects Releases Wiki Activity
Open Source search based on OpenStreetMap data
3,870 Commits 31 Branches 41 Tags 164 MiB
Python 70.9%
Gherkin 17.7%
PLpgSQL 7.6%
Lua 2.3%
Shell 1.3%
Other 0.2%
7b7203c149
Go to file
Sarah Hoffmann 7b7203c149 add function for loading plugin modules 
Loads modules for configurable code like tokenizers, sanitizers, etc.
Supports internal modules, external libraries and code from the
project directory.
2022-07-25 16:10:10 +02:00
.github CIL use psutil type stubs 2022-07-18 09:55:58 +02:00
cmake add git commit hash to --version output 2022-05-09 23:56:13 +02:00
data modify data import logic to load country names from yaml 2022-03-12 15:20:57 +08:00
docs remove CentOS installation instructions 2022-07-24 10:22:22 +02:00
lib-php ignore API parameters in array notation 2022-07-23 10:51:44 +02:00
lib-sql docs: fix typos 2022-07-20 22:05:31 +08:00
man update and extend man page 2021-10-18 09:03:07 +02:00
module raise PostgreSQL requirement to 9.6 2022-01-27 15:15:56 +01:00
munin docs: fix typos 2022-07-20 22:05:31 +08:00
nominatim add function for loading plugin modules 2022-07-25 16:10:10 +02:00
osm2pgsql@3f136f1a6b update to osm2pgsql 1.6.0 2022-01-24 16:55:52 +01:00
settings ignore 5+ postcodes in the US for now 2022-06-24 19:24:22 +02:00
test add function for loading plugin modules 2022-07-25 16:10:10 +02:00
utils port multi-region update scripts to nominatim tool 2021-08-14 23:55:48 +02:00
vagrant vagrant: remove proj dependency and only require php-cli 2022-07-24 10:24:18 +02: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 CIL use psutil type stubs 2022-07-18 09:55:58 +02:00
.pylintrc avoid issues with Python < 3.9 and linting 2022-07-18 09:47:57 +02:00
AUTHORS add consistent SPDX copyright headers 2022-01-03 16:23:58 +01:00
ChangeLog prepare release 4.0.0 2021-11-02 20:27:55 +01:00
CMakeLists.txt make ICU the default tokenizer 2022-05-10 12:02:50 +02:00
CONTRIBUTING.md docs: fix typos 2022-07-20 22:05:31 +08: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 update supported versions 2022-02-23 09:22:17 +01:00
VAGRANT.md docs: fix typos 2022-07-20 22:05:31 +08:00
Vagrantfile make CentOS 8 the default vagrant script 2020-09-16 17:34:36 +02:00

README.md

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.