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. Use the discussions forum
  28 or ask for help 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 current master](https://nominatim.org/release-docs/develop/admin/Installation)
  34 can be found at nominatim.org as well.
  35
  36 A quick summary of the necessary steps:
  37
  38 1. Compile Nominatim:
  39
  40         mkdir build
  41         cd build
  42         cmake ..
  43         make
  44
  45 2. Create a project directory, get OSM data and import:
  46
  47         mkdir nominatim-project
  48         cd nominatim-project
  49         ~/build/nominatim import --osm-file <your planet file>
  50
  51 3. Point your webserver to the nominatim-project/website directory.
  52
  53
  54 License
  55 =======
  56
  57 The source code is available under a GPLv2 license.
  58
  59
  60 Contributing
  61 ============
  62
  63 Contributions, bugreport and pull requests are welcome.
  64 For details see [contribution guide](CONTRIBUTING.md).
  65
  66
  67 Questions and help
  68 ==================
  69
  70 For questions, community help and discussions you can use the
  71 [Github discussions forum](https://github.com/osm-search/Nominatim/discussions)
  72 or join the
  73 [geocoding mailing list](https://lists.openstreetmap.org/listinfo/geocoding).