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 The latest stable release can be downloaded from https://nominatim.org.
  23 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/).
  24
  25 [Detailed installation instructions for current master](https://nominatim.org/release-docs/develop/admin/Installation)
  26 can be found at nominatim.org as well.
  27
  28 A quick summary of the necessary steps:
  29
  30 1. Create a Python virtualenv and install the packages:
  31
  32         python3 -m venv nominatim-venv
  33         ./nominatim-venv/bin/pip install packaging/nominatim-{api,db}
  34
  35 2. Create a project directory, get OSM data and import:
  36
  37         mkdir nominatim-project
  38         cd nominatim-project
  39         ../nominatim-venv/bin/nominatim import --osm-file <your planet file>
  40
  41 3. Start the webserver:
  42
  43         ./nominatim-venv/bin/pip install uvicorn falcon
  44         ../nominatim-venv/bin/nominatim serve
  45
  46
  47 License
  48 =======
  49
  50 The Python source code is available under a GPL license version 3 or later.
  51 The Lua configuration files for osm2pgsql are released under the
  52 Apache License, Version 2.0. All other files are under a GPLv2 license.
  53
  54
  55 Contributing
  56 ============
  57
  58 Contributions, bug reports and pull requests are welcome. When reporting a
  59 bug, please use one of the
  60 [issue templates](https://github.com/osm-search/Nominatim/issues/new/choose)
  61 and make sure to provide all the information requested. If you are not
  62 sure if you have really found a bug, please ask for help in the forums
  63 first (see 'Questions' below).
  64
  65 For details on contributing, have a look at the
  66 [contribution guide](CONTRIBUTING.md).
  67
  68
  69 Questions and help
  70 ==================
  71
  72 If you have questions about search results and the OpenStreetMap data
  73 used in the search, use the [OSM Forum](https://community.openstreetmap.org/).
  74
  75 For questions, community help and discussions around the software and
  76 your own installation of Nominatim, use the
  77 [Github discussions forum](https://github.com/osm-search/Nominatim/discussions).