packaging/nominatim-db/README.md

   1 # Nominatim - DB Backend
   2
   3 Nominatim is a tool to search OpenStreetMap data
   4 by name and address (geocoding) and to generate synthetic addresses of
   5 OSM points (reverse geocoding).
   6
   7 This module implements the database backend for Nominatim and the
   8 command-line tool for importing and maintaining the database.
   9
  10 ## Installation
  11
  12 ### Prerequisites
  13
  14 Nominatim requires [osm2pgsql](https://osm2pgsql.org/) (>=1.8) for reading
  15 OSM data and [PostgreSQL](https://www.postgresql.org/) to store the data.
  16
  17 On Ubuntu (>=23.04) and Debian (using backports), you can install them with:
  18
  19     sudo apt-get install osm2pgsql postgresql-postgis
  20
  21 ### Installation from pypi
  22
  23 To install Nominatim from pypi, run:
  24
  25     pip install nominatim-db
  26
  27
  28 ## Quick start
  29
  30 First create a project directory for your new Nominatim database, which
  31 is the space for additional configuration and customization:
  32
  33     mkdir planet-project
  34
  35 Download an appropriate data extract, for example from
  36 [Geofabrik](https://download.geofabrik.de/) and import the file:
  37
  38     nominatim import --osm-file <downlaoded-osm-data.pbf>
  39
  40 You will need to install the 'nominatim-api' package to query the
  41 database.
  42
  43 ## Documentation
  44
  45 The documentation of the latest development version is in the
  46 `docs/` subdirectory. A HTML version can be found at
  47 https://nominatim.org/release-docs/develop/ .
  48
  49 ## License
  50
  51 The source code is available under a GPLv3 license.