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