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