]> git.openstreetmap.org Git - nominatim.git/blob - README.md
docs: need to index after updating with a file
[nominatim.git] / README.md
1 [![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)
2
3 Nominatim
4 =========
5
6 Nominatim (from the Latin, 'by name') is a tool to search OpenStreetMap data
7 by name and address (geocoding) and to generate synthetic addresses of
8 OSM points (reverse geocoding). An instance with up-to-date data can be found
9 at https://nominatim.openstreetmap.org. Nominatim is also used as one of the
10 sources for the Search box on the OpenStreetMap home page.
11
12 Documentation
13 =============
14
15 The documentation of the latest development version is in the
16 `docs/` subdirectory. A HTML version can be found at
17 https://nominatim.org/release-docs/develop/ .
18
19 Installation
20 ============
21
22 **Nominatim is a complex piece of software and runs in a complex environment.
23 Installing and running Nominatim is something for experienced system
24 administrators only who can do some trouble-shooting themselves. We are sorry,
25 but we can not provide installation support. We are all doing this in our free
26 time and there is just so much of that time to go around. Do not open issues in
27 our bug tracker if you need help. You can ask questions on the mailing list
28 (see below) or on [help.openstreetmap.org](https://help.openstreetmap.org/).**
29
30 The latest stable release can be downloaded from https://nominatim.org.
31 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/).
32
33 Detailed installation instructions for the development version can be
34 found at [nominatim.org](https://nominatim.org/release-docs/develop/admin/Installation)
35 as well.
36
37 A quick summary of the necessary steps:
38
39 1. Compile Nominatim:
40
41         mkdir build
42         cd build
43         cmake ..
44         make
45
46 2. Get OSM data and import:
47
48         ./build/utils/setup.php --osm-file <your planet file> --all
49
50 3. Point your webserver to the ./build/website directory.
51
52
53 License
54 =======
55
56 The source code is available under a GPLv2 license.
57
58
59 Contributing
60 ============
61
62 Contributions are welcome. For details see [contribution guide](CONTRIBUTING.md).
63
64 Both bug reports and pull requests are welcome.
65
66
67 Mailing list
68 ============
69
70 For questions you can join the geocoding mailing list, see
71 https://lists.openstreetmap.org/listinfo/geocoding