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