docs/admin/Installation.md

   1 # Basic Installation
   2
   3 This page contains generic installation instructions for Nominatim and its
   4 prerequisites. There are also step-by-step instructions available for
   5 the following operating systems:
   6
   7   * [Ubuntu 20.04](../appendix/Install-on-Ubuntu-20.md)
   8   * [Ubuntu 18.04](../appendix/Install-on-Ubuntu-18.md)
   9   * [CentOS 8](../appendix/Install-on-Centos-8.md)
  10
  11 These OS-specific instructions can also be found in executable form
  12 in the `vagrant/` directory.
  13
  14 Users have created instructions for other frameworks. We haven't tested those
  15 and can't offer support.
  16
  17   * [Docker](https://github.com/mediagis/nominatim-docker)
  18   * [Docker on Kubernetes](https://github.com/peter-evans/nominatim-k8s)
  19   * [Kubernetes with Helm](https://github.com/robjuz/helm-charts/blob/master/charts/nominatim/README.md)
  20   * [Ansible](https://github.com/synthesio/infra-ansible-nominatim)
  21
  22 ## Prerequisites
  23
  24 ### Software
  25
  26 !!! Warning
  27     For larger installations you **must have** PostgreSQL 11+ and Postgis 3+
  28     otherwise import and queries will be slow to the point of being unusable.
  29     Query performance has marked improvements with PostgrSQL 13+ and Postgis 3.2+.
  30
  31 For compiling:
  32
  33   * [cmake](https://cmake.org/)
  34   * [expat](https://libexpat.github.io/)
  35   * [proj](https://proj.org/)
  36   * [bzip2](http://www.bzip.org/)
  37   * [zlib](https://www.zlib.net/)
  38   * [ICU](http://site.icu-project.org/)
  39   * [Boost libraries](https://www.boost.org/), including system and filesystem
  40   * PostgreSQL client libraries
  41   * a recent C++ compiler (gcc 5+ or Clang 3.8+)
  42
  43 For running Nominatim:
  44
  45   * [PostgreSQL](https://www.postgresql.org) (9.6+ will work, 11+ strongly recommended)
  46   * [PostGIS](https://postgis.net) (2.2+ will work, 3.0+ strongly recommended)
  47   * [Python 3](https://www.python.org/) (3.6+)
  48   * [Psycopg2](https://www.psycopg.org) (2.7+)
  49   * [Python Dotenv](https://github.com/theskumar/python-dotenv)
  50   * [psutil](https://github.com/giampaolo/psutil)
  51   * [Jinja2](https://palletsprojects.com/p/jinja/)
  52   * [PyICU](https://pypi.org/project/PyICU/)
  53   * [PyYaml](https://pyyaml.org/) (5.1+)
  54   * [datrie](https://github.com/pytries/datrie)
  55   * [PHP](https://php.net) (7.0 or later)
  56   * PHP-pgsql
  57   * PHP-intl (bundled with PHP)
  58   * PHP-cgi (for running queries from the command line)
  59
  60 For running continuous updates:
  61
  62   * [pyosmium](https://osmcode.org/pyosmium/)
  63
  64 For dependencies for running tests and building documentation, see
  65 the [Development section](../develop/Development-Environment.md).
  66
  67 ### Hardware
  68
  69 A minimum of 2GB of RAM is required or installation will fail. For a full
  70 planet import 128GB of RAM or more are strongly recommended. Do not report
  71 out of memory problems if you have less than 64GB RAM.
  72
  73 For a full planet install you will need at least 1TB of hard disk space.
  74 Take into account that the OSM database is growing fast.
  75 Fast disks are essential. Using NVME disks is recommended.
  76
  77 Even on a well configured machine the import of a full planet takes
  78 around 2 days. On traditional spinning disks, 7-8 days are more realistic.
  79
  80 ## Tuning the PostgreSQL database
  81
  82 You might want to tune your PostgreSQL installation so that the later steps
  83 make best use of your hardware. You should tune the following parameters in
  84 your `postgresql.conf` file.
  85
  86     shared_buffers = 2GB
  87     maintenance_work_mem = (10GB)
  88     autovacuum_work_mem = 2GB
  89     work_mem = (50MB)
  90     effective_cache_size = (24GB)
  91     synchronous_commit = off
  92     max_wal_size = 1GB
  93     checkpoint_timeout = 10min
  94     checkpoint_completion_target = 0.9
  95
  96 The numbers in brackets behind some parameters seem to work fine for
  97 64GB RAM machine. Adjust to your setup. A higher number for `max_wal_size`
  98 means that PostgreSQL needs to run checkpoints less often but it does require
  99 the additional space on your disk.
 100
 101 Autovacuum must not be switched off because it ensures that the
 102 tables are frequently analysed. If your machine has very little memory,
 103 you might consider setting:
 104
 105     autovacuum_max_workers = 1
 106
 107 and even reduce `autovacuum_work_mem` further. This will reduce the amount
 108 of memory that autovacuum takes away from the import process.
 109
 110 For the initial import, you should also set:
 111
 112     fsync = off
 113     full_page_writes = off
 114
 115 Don't forget to reenable them after the initial import or you risk database
 116 corruption.
 117
 118
 119 ## Downloading and building Nominatim
 120
 121 ### Downloading the latest release
 122
 123 You can download the [latest release from nominatim.org](https://nominatim.org/downloads/).
 124 The release contains all necessary files. Just unpack it.
 125
 126 ### Downloading the latest development version
 127
 128 If you want to install latest development version from github, make sure to
 129 also check out the osm2pgsql subproject:
 130
 131 ```
 132 git clone --recursive https://github.com/openstreetmap/Nominatim.git
 133 ```
 134
 135 The development version does not include the country grid. Download it separately:
 136
 137 ```
 138 wget -O Nominatim/data/country_osm_grid.sql.gz https://www.nominatim.org/data/country_grid.sql.gz
 139 ```
 140
 141 ### Building Nominatim
 142
 143 The code must be built in a separate directory. Create the directory and
 144 change into it.
 145
 146 ```
 147 mkdir build
 148 cd build
 149 ```
 150
 151 Nominatim uses cmake and make for building. Assuming that you have created the
 152 build at the same level as the Nominatim source directory run:
 153
 154 ```
 155 cmake ../Nominatim
 156 make
 157 sudo make install
 158 ```
 159
 160 !!! warning
 161     The default installation no longer compiles the PostgreSQL module that
 162     is needed for the legacy tokenizer from older Nominatim versions. If you
 163     are upgrading an older database or want to run the
 164     [legacy tokenizer](../customize/Tokenizers.md#legacy-tokenizer) for
 165     some other reason, you need to enable the PostgreSQL module via
 166     cmake: `cmake -DBUILD_MODULE=on ../Nominatim`. To compile the module
 167     you need to have the server development headers for PostgreSQL installed.
 168     On Ubuntu/Debian run: `sudo apt install postgresql-server-dev-<postgresql version>`
 169
 170
 171 Nominatim installs itself into `/usr/local` per default. To choose a different
 172 installation directory add `-DCMAKE_INSTALL_PREFIX=<install root>` to the
 173 cmake command. Make sure that the `bin` directory is available in your path
 174 in that case, e.g.
 175
 176 ```
 177 export PATH=<install root>/bin:$PATH
 178 ```
 179
 180 Now continue with [importing the database](Import.md).