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