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   * [nlohmann/json](https://json.nlohmann.me/)
  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.7+)
  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   * [SQLAlchemy](https://www.sqlalchemy.org/) (1.4.31+ with greenlet support)
  53   * [asyncpg](https://magicstack.github.io/asyncpg) (0.8+)
  54   * [PyICU](https://pypi.org/project/PyICU/)
  55   * [PyYaml](https://pyyaml.org/) (5.1+)
  56   * [datrie](https://github.com/pytries/datrie)
  57
  58 For running continuous updates:
  59
  60   * [pyosmium](https://osmcode.org/pyosmium/)
  61
  62 For running the Python frontend:
  63
  64   * one of the following web frameworks:
  65     * [falcon](https://falconframework.org/) (3.0+)
  66     * [starlette](https://www.starlette.io/)
  67   * [uvicorn](https://www.uvicorn.org/)
  68
  69 For running the legacy PHP frontend:
  70
  71   * [PHP](https://php.net) (7.3+)
  72   * PHP-pgsql
  73   * PHP-intl (bundled with PHP)
  74
  75
  76 For dependencies for running tests and building documentation, see
  77 the [Development section](../develop/Development-Environment.md).
  78
  79 ### Hardware
  80
  81 A minimum of 2GB of RAM is required or installation will fail. For a full
  82 planet import 128GB of RAM or more are strongly recommended. Do not report
  83 out of memory problems if you have less than 64GB RAM.
  84
  85 For a full planet install you will need at least 1TB of hard disk space.
  86 Take into account that the OSM database is growing fast.
  87 Fast disks are essential. Using NVME disks is recommended.
  88
  89 Even on a well configured machine the import of a full planet takes
  90 around 2 days. When using traditional SSDs, 4-5 days are more realistic.
  91
  92 ## Tuning the PostgreSQL database
  93
  94 You might want to tune your PostgreSQL installation so that the later steps
  95 make best use of your hardware. You should tune the following parameters in
  96 your `postgresql.conf` file.
  97
  98     shared_buffers = 2GB
  99     maintenance_work_mem = (10GB)
 100     autovacuum_work_mem = 2GB
 101     work_mem = (50MB)
 102     effective_cache_size = (24GB)
 103     synchronous_commit = off
 104     max_wal_size = 1GB
 105     checkpoint_timeout = 10min
 106     checkpoint_completion_target = 0.9
 107
 108 The numbers in brackets behind some parameters seem to work fine for
 109 64GB RAM machine. Adjust to your setup. A higher number for `max_wal_size`
 110 means that PostgreSQL needs to run checkpoints less often but it does require
 111 the additional space on your disk.
 112
 113 Autovacuum must not be switched off because it ensures that the
 114 tables are frequently analysed. If your machine has very little memory,
 115 you might consider setting:
 116
 117     autovacuum_max_workers = 1
 118
 119 and even reduce `autovacuum_work_mem` further. This will reduce the amount
 120 of memory that autovacuum takes away from the import process.
 121
 122 ## Downloading and building Nominatim
 123
 124 ### Downloading the latest release
 125
 126 You can download the [latest release from nominatim.org](https://nominatim.org/downloads/).
 127 The release contains all necessary files. Just unpack it.
 128
 129 ### Downloading the latest development version
 130
 131 If you want to install latest development version from github, make sure to
 132 also check out the osm2pgsql subproject:
 133
 134 ```
 135 git clone --recursive https://github.com/openstreetmap/Nominatim.git
 136 ```
 137
 138 The development version does not include the country grid. Download it separately:
 139
 140 ```
 141 wget -O Nominatim/data/country_osm_grid.sql.gz https://nominatim.org/data/country_grid.sql.gz
 142 ```
 143
 144 ### Building Nominatim
 145
 146 The code must be built in a separate directory. Create the directory and
 147 change into it.
 148
 149 ```
 150 mkdir build
 151 cd build
 152 ```
 153
 154 Nominatim uses cmake and make for building. Assuming that you have created the
 155 build at the same level as the Nominatim source directory run:
 156
 157 ```
 158 cmake ../Nominatim
 159 make
 160 sudo make install
 161 ```
 162
 163 !!! warning
 164     The default installation no longer compiles the PostgreSQL module that
 165     is needed for the legacy tokenizer from older Nominatim versions. If you
 166     are upgrading an older database or want to run the
 167     [legacy tokenizer](../customize/Tokenizers.md#legacy-tokenizer) for
 168     some other reason, you need to enable the PostgreSQL module via
 169     cmake: `cmake -DBUILD_MODULE=on ../Nominatim`. To compile the module
 170     you need to have the server development headers for PostgreSQL installed.
 171     On Ubuntu/Debian run: `sudo apt install postgresql-server-dev-<postgresql version>`
 172
 173
 174 Nominatim installs itself into `/usr/local` per default. To choose a different
 175 installation directory add `-DCMAKE_INSTALL_PREFIX=<install root>` to the
 176 cmake command. Make sure that the `bin` directory is available in your path
 177 in that case, e.g.
 178
 179 ```
 180 export PATH=<install root>/bin:$PATH
 181 ```
 182
 183 Now continue with [importing the database](Import.md).