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   * [Jinja2](https://palletsprojects.com/p/jinja/)
  46   * [PHP](https://php.net) (7.0 or later)
  47   * PHP-pgsql
  48   * PHP-intl (bundled with PHP)
  49   * PHP-cgi (for running queries from the command line)
  50
  51 For running continuous updates:
  52
  53   * [pyosmium](https://osmcode.org/pyosmium/)
  54
  55 For dependencies for running tests and building documentation, see
  56 the [Development section](../develop/Development-Environment.md).
  57
  58 ### Hardware
  59
  60 A minimum of 2GB of RAM is required or installation will fail. For a full
  61 planet import 64GB of RAM or more are strongly recommended. Do not report
  62 out of memory problems if you have less than 64GB RAM.
  63
  64 For a full planet install you will need at least 900GB of hard disk space.
  65 Take into account that the OSM database is growing fast.
  66 Fast disks are essential. Using NVME disks is recommended.
  67
  68 Even on a well configured machine the import of a full planet takes
  69 around 2 days. On traditional spinning disks, 7-8 days are more realistic.
  70
  71 ## Tuning the PostgreSQL database
  72
  73 You might want to tune your PostgreSQL installation so that the later steps
  74 make best use of your hardware. You should tune the following parameters in
  75 your `postgresql.conf` file.
  76
  77     shared_buffers = 2GB
  78     maintenance_work_mem = (10GB)
  79     autovacuum_work_mem = 2GB
  80     work_mem = (50MB)
  81     effective_cache_size = (24GB)
  82     synchronous_commit = off
  83     checkpoint_segments = 100 # only for postgresql <= 9.4
  84     max_wal_size = 1GB # postgresql > 9.4
  85     checkpoint_timeout = 10min
  86     checkpoint_completion_target = 0.9
  87
  88 The numbers in brackets behind some parameters seem to work fine for
  89 64GB RAM machine. Adjust to your setup. A higher number for `max_wal_size`
  90 means that PostgreSQL needs to run checkpoints less often but it does require
  91 the additional space on your disk.
  92
  93 Autovacuum must not be switched off because it ensures that the
  94 tables are frequently analysed. If your machine has very little memory,
  95 you might consider setting:
  96
  97     autovacuum_max_workers = 1
  98
  99 and even reduce `autovacuum_work_mem` further. This will reduce the amount
 100 of memory that autovacuum takes away from the import process.
 101
 102 For the initial import, you should also set:
 103
 104     fsync = off
 105     full_page_writes = off
 106
 107 Don't forget to reenable them after the initial import or you risk database
 108 corruption.
 109
 110
 111 ## Downloading and building Nominatim
 112
 113 ### Downloading the latest release
 114
 115 You can download the [latest release from nominatim.org](https://nominatim.org/downloads/).
 116 The release contains all necessary files. Just unpack it.
 117
 118 ### Downloading the latest development version
 119
 120 If you want to install latest development version from github, make sure to
 121 also check out the osm2pgsql subproject:
 122
 123 ```
 124 git clone --recursive git://github.com/openstreetmap/Nominatim.git
 125 ```
 126
 127 The development version does not include the country grid. Download it separately:
 128
 129 ```
 130 wget -O Nominatim/data/country_osm_grid.sql.gz https://www.nominatim.org/data/country_grid.sql.gz
 131 ```
 132
 133 ### Building Nominatim
 134
 135 The code must be built in a separate directory. Create the directory and
 136 change into it.
 137
 138 ```
 139 mkdir build
 140 cd build
 141 ```
 142
 143 Nominatim uses cmake and make for building. Assuming that you have created the
 144 build at the same level as the Nominatim source directory run:
 145
 146 ```
 147 cmake ../Nominatim
 148 make
 149 sudo make install
 150 ```
 151
 152 Nominatim installs itself into `/usr/local` per default. To choose a different
 153 installation directory add `-DCMAKE_INSTALL_PREFIX=<install root>` to the
 154 cmake command. Make sure that the `bin` directory is available in your path
 155 in that case, e.g.
 156
 157 ```
 158 export PATH=<install root>/bin:$PATH
 159 ```
 160
 161 Now continue with [importing the database](Import.md).