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