Nominatim/README.md

[![Build Status](https://github.com/osm-search/Nominatim/workflows/CI%20Tests/badge.svg)](https://github.com/osm-search/Nominatim/actions?query=workflow%3A%22CI+Tests%22)

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

**Nominatim is a complex piece of software and runs in a complex environment.
Installing and running Nominatim is something for experienced system
administrators only who can do some trouble-shooting themselves. We are sorry,
but we can not provide installation support. We are all doing this in our free
time and there is just so much of that time to go around. Do not open issues in
our bug tracker if you need help. You can ask questions on the mailing list
(see below) or on [help.openstreetmap.org](https://help.openstreetmap.org/).**

The latest stable release can be downloaded from https://nominatim.org.
There you can also find [installation instructions for the release](https://nominatim.org/release-docs/latest/admin/Installation), as well as an extensive [Troubleshooting/FAQ section](https://nominatim.org/release-docs/latest/admin/Faq/).

Detailed installation instructions for the development version can be
found at [nominatim.org](https://nominatim.org/release-docs/develop/admin/Installation)
as well.

A quick summary of the necessary steps:

1. Compile Nominatim:

        mkdir build
        cd build
        cmake ..
        make

2. Get OSM data and import:

        ./build/utils/setup.php --osm-file <your planet file> --all

3. Point your webserver to the ./build/website directory.


License
=======

The source code is available under a GPLv2 license.


Contributing
============

Contributions are welcome. For details see [contribution guide](CONTRIBUTING.md).

Both bug reports and pull requests are welcome.


Mailing list
============

For questions you can join the geocoding mailing list, see
https://lists.openstreetmap.org/listinfo/geocoding
switch CI badge to github actions 2020-10-28 12:11:22 +03:00			`[![Build Status](https://github.com/osm-search/Nominatim/workflows/CI%20Tests/badge.svg)](https://github.com/osm-search/Nominatim/actions?query=workflow%3A%22CI+Tests%22)`
add travis-ci badge ("build passing") to README file 2017-03-12 15:11:56 +03:00
add README stuff 2012-06-27 23:40:58 +04:00			`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`
update URLs in code and documentation Use https for all openstreetmap addresses, remove defunct mapquest link and redirect documentation links to nominatim.org. 2018-01-06 00:38:51 +03:00			`at https://nominatim.openstreetmap.org. Nominatim is also used as one of the`
update links and remove MapQuest reference 2018-01-23 01:46:56 +03:00			`sources for the Search box on the OpenStreetMap home page.`
add README stuff 2012-06-27 23:40:58 +04:00
			`Documentation`
			`=============`

update links and remove MapQuest reference 2018-01-23 01:46:56 +03:00			`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/ .`
add README stuff 2012-06-27 23:40:58 +04:00
			`Installation`
			`============`

update minimum required RAM to 64GB Also adds more background explanation on time and RAM use, as well as a hint that github issues are not good for installation support. 2019-11-24 12:31:34 +03:00			`**Nominatim is a complex piece of software and runs in a complex environment.`
			`Installing and running Nominatim is something for experienced system`
			`administrators only who can do some trouble-shooting themselves. We are sorry,`
			`but we can not provide installation support. We are all doing this in our free`
			`time and there is just so much of that time to go around. Do not open issues in`
			`our bug tracker if you need help. You can ask questions on the mailing list`
			`(see below) or on [help.openstreetmap.org](https://help.openstreetmap.org/).**`

convert remaining http links and shorten copyright URL 2018-01-12 01:05:28 +03:00			`The latest stable release can be downloaded from https://nominatim.org.`
Mention FAQ / troubleshooting page in README 2019-11-27 00:33:00 +03:00			`There you can also find [installation instructions for the release](https://nominatim.org/release-docs/latest/admin/Installation), as well as an extensive [Troubleshooting/FAQ section](https://nominatim.org/release-docs/latest/admin/Faq/).`
README: point to release instalation instructions 2017-09-06 21:36:59 +03:00
			`Detailed installation instructions for the development version can be`
update links and remove MapQuest reference 2018-01-23 01:46:56 +03:00			`found at [nominatim.org](https://nominatim.org/release-docs/develop/admin/Installation)`
			`as well.`
README: point to release instalation instructions 2017-09-06 21:36:59 +03:00
			`A quick summary of the necessary steps:`
add README stuff 2012-06-27 23:40:58 +04:00
			`1. Compile Nominatim:`

Improve markdown of Installation section Due to indentation issues (code within numbered list needs at least 8 spaces instead of 4) the code would not appear as code but as plain text without a fixed size font and also without newlines appearing in the HTML. 2017-02-02 13:58:40 +03:00			`mkdir build`
			`cd build`
			`cmake ..`
			`make`
add README stuff 2012-06-27 23:40:58 +04:00
			`2. Get OSM data and import:`

Improve markdown of Installation section Due to indentation issues (code within numbered list needs at least 8 spaces instead of 4) the code would not appear as code but as plain text without a fixed size font and also without newlines appearing in the HTML. 2017-02-02 13:58:40 +03:00			`./build/utils/setup.php --osm-file <your planet file> --all`
move installation instructions from wiki page here 2016-06-07 23:47:57 +03:00
			`3. Point your webserver to the ./build/website directory.`

add README stuff 2012-06-27 23:40:58 +04:00
			`License`
			`=======`

			`The source code is available under a GPLv2 license.`

link CONTRIBUTING file from README file This change should also encourage to read "how to report bugs" guide before reporting bugs fixes #1133 2018-09-11 21:51:22 +03:00
			`Contributing`
			`============`

README: tiny markdown syntax error 2019-01-28 21:42:40 +03:00			`Contributions are welcome. For details see [contribution guide](CONTRIBUTING.md).`
link CONTRIBUTING file from README file This change should also encourage to read "how to report bugs" guide before reporting bugs fixes #1133 2018-09-11 21:51:22 +03:00
			`Both bug reports and pull requests are welcome.`


			`Mailing list`
			`============`
add README stuff 2012-06-27 23:40:58 +04:00
Rectified a small spelling mistake changed "mailinglist" to "mailing list" 2019-03-14 20:23:09 +03:00			`For questions you can join the geocoding mailing list, see`
update URLs in code and documentation Use https for all openstreetmap addresses, remove defunct mapquest link and redirect documentation links to nominatim.org. 2018-01-06 00:38:51 +03:00			`https://lists.openstreetmap.org/listinfo/geocoding`