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 24.04](Install-on-Ubuntu-24.md)
   8   * [Ubuntu 22.04](Install-on-Ubuntu-22.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 running Nominatim:
  31
  32   * [PostgreSQL](https://www.postgresql.org) (9.6+ will work, 11+ strongly recommended)
  33   * [PostGIS](https://postgis.net) (2.2+ will work, 3.0+ strongly recommended)
  34   * [osm2pgsql](https://osm2pgsql.org) (1.8+, optional when building with CMake)
  35   * [Python 3](https://www.python.org/) (3.7+)
  36
  37 Furthermore the following Python libraries are required:
  38
  39   * [Psycopg3](https://www.psycopg.org)
  40   * [Python Dotenv](https://github.com/theskumar/python-dotenv)
  41   * [psutil](https://github.com/giampaolo/psutil)
  42   * [Jinja2](https://palletsprojects.com/p/jinja/)
  43   * [PyICU](https://pypi.org/project/PyICU/)
  44   * [PyYaml](https://pyyaml.org/) (5.1+)
  45   * [datrie](https://github.com/pytries/datrie)
  46
  47 These will be installed automatically when using pip installation.
  48
  49 When using legacy CMake-based installation:
  50
  51   * [cmake](https://cmake.org/)
  52   * [expat](https://libexpat.github.io/)
  53   * [proj](https://proj.org/)
  54   * [bzip2](http://www.bzip.org/)
  55   * [zlib](https://www.zlib.net/)
  56   * [ICU](http://site.icu-project.org/)
  57   * [nlohmann/json](https://json.nlohmann.me/)
  58   * [Boost libraries](https://www.boost.org/), including system and file system
  59   * PostgreSQL client libraries
  60   * a recent C++ compiler (gcc 5+ or Clang 3.8+)
  61
  62 For running continuous updates:
  63
  64   * [pyosmium](https://osmcode.org/pyosmium/)
  65
  66 For running the Python frontend:
  67
  68   * [SQLAlchemy](https://www.sqlalchemy.org/) (1.4.31+ with greenlet support)
  69   * [asyncpg](https://magicstack.github.io/asyncpg) (0.8+, only when using SQLAlchemy < 2.0)
  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 running the legacy PHP frontend:
  76
  77   * [PHP](https://php.net) (7.3+)
  78   * PHP-pgsql
  79   * PHP-intl (bundled with PHP)
  80
  81
  82 For dependencies for running tests and building documentation, see
  83 the [Development section](../develop/Development-Environment.md).
  84
  85 ### Hardware
  86
  87 A minimum of 2GB of RAM is required or installation will fail. For a full
  88 planet import 128GB of RAM or more are strongly recommended. Do not report
  89 out of memory problems if you have less than 64GB RAM.
  90
  91 For a full planet install you will need at least 1TB of hard disk space.
  92 Take into account that the OSM database is growing fast.
  93 Fast disks are essential. Using NVME disks is recommended.
  94
  95 Even on a well configured machine the import of a full planet takes
  96 around 2.5 days. When using traditional SSDs, 4-5 days are more realistic.
  97
  98 ## Tuning the PostgreSQL database
  99
 100 You might want to tune your PostgreSQL installation so that the later steps
 101 make best use of your hardware. You should tune the following parameters in
 102 your `postgresql.conf` file.
 103
 104     shared_buffers = 2GB
 105     maintenance_work_mem = (10GB)
 106     autovacuum_work_mem = 2GB
 107     work_mem = (50MB)
 108     synchronous_commit = off
 109     max_wal_size = 1GB
 110     checkpoint_timeout = 60min
 111     checkpoint_completion_target = 0.9
 112     random_page_cost = 1.0
 113     wal_level = minimal
 114     max_wal_senders = 0
 115
 116 The numbers in brackets behind some parameters seem to work fine for
 117 128GB RAM machine. Adjust to your setup. A higher number for `max_wal_size`
 118 means that PostgreSQL needs to run checkpoints less often but it does require
 119 the additional space on your disk.
 120
 121 Autovacuum must not be switched off because it ensures that the
 122 tables are frequently analysed. If your machine has very little memory,
 123 you might consider setting:
 124
 125     autovacuum_max_workers = 1
 126
 127 and even reduce `autovacuum_work_mem` further. This will reduce the amount
 128 of memory that autovacuum takes away from the import process.
 129
 130 ## Downloading and building Nominatim
 131
 132 ### Downloading the latest release
 133
 134 You can download the [latest release from nominatim.org](https://nominatim.org/downloads/).
 135 The release contains all necessary files. Just unpack it.
 136
 137 ### Downloading the latest development version
 138
 139 If you want to install latest development version from github, make sure to
 140 also check out the osm2pgsql subproject:
 141
 142 ```
 143 git clone --recursive https://github.com/openstreetmap/Nominatim.git
 144 ```
 145
 146 The development version does not include the country grid. Download it separately:
 147
 148 ```
 149 wget -O Nominatim/data/country_osm_grid.sql.gz https://nominatim.org/data/country_grid.sql.gz
 150 ```
 151
 152 ### Building Nominatim
 153
 154 #### Building the latest development version with pip
 155
 156 Nominatim is easiest to run from its own virtual environment. To create one, run:
 157
 158     sudo apt-get install virtualenv
 159     virtualenv /srv/nominatim-venv
 160
 161 To install Nominatim directly from the source tree into the virtual environment, run:
 162
 163     /srv/nominatim-venv/bin/pip install packaging/nominatim-{db,api}
 164
 165 #### Building in legacy CMake mode
 166
 167 !!! warning
 168     Installing Nominatim through CMake is now deprecated. The infrastructure
 169     will be removed in Nominatim 5.0. Please switch to pip installation.
 170
 171 The code must be built in a separate directory. Create the directory and
 172 change into it.
 173
 174 ```
 175 mkdir build
 176 cd build
 177 ```
 178
 179 Nominatim uses cmake and make for building. Assuming that you have created the
 180 build at the same level as the Nominatim source directory run:
 181
 182 ```
 183 cmake ../Nominatim
 184 make
 185 sudo make install
 186 ```
 187
 188 !!! warning
 189     The default installation no longer compiles the PostgreSQL module that
 190     is needed for the legacy tokenizer from older Nominatim versions. If you
 191     are upgrading an older database or want to run the
 192     [legacy tokenizer](../customize/Tokenizers.md#legacy-tokenizer) for
 193     some other reason, you need to enable the PostgreSQL module via
 194     cmake: `cmake -DBUILD_MODULE=on ../Nominatim`. To compile the module
 195     you need to have the server development headers for PostgreSQL installed.
 196     On Ubuntu/Debian run: `sudo apt install postgresql-server-dev-<postgresql version>`
 197
 198
 199 Nominatim installs itself into `/usr/local` per default. To choose a different
 200 installation directory add `-DCMAKE_INSTALL_PREFIX=<install root>` to the
 201 cmake command. Make sure that the `bin` directory is available in your path
 202 in that case, e.g.
 203
 204 ```
 205 export PATH=<install root>/bin:$PATH
 206 ```
 207
 208 Now continue with [importing the database](Import.md).