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