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