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 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.5 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     synchronous_commit = off
 102     max_wal_size = 1GB
 103     checkpoint_timeout = 60min
 104     checkpoint_completion_target = 0.9
 105     random_page_cost = 1.0
 106     wal_level = minimal
 107     max_wal_senders = 0
 108
 109 The numbers in brackets behind some parameters seem to work fine for
 110 128GB RAM machine. Adjust to your setup. A higher number for `max_wal_size`
 111 means that PostgreSQL needs to run checkpoints less often but it does require
 112 the additional space on your disk.
 113
 114 Autovacuum must not be switched off because it ensures that the
 115 tables are frequently analysed. If your machine has very little memory,
 116 you might consider setting:
 117
 118     autovacuum_max_workers = 1
 119
 120 and even reduce `autovacuum_work_mem` further. This will reduce the amount
 121 of memory that autovacuum takes away from the import process.
 122
 123 ## Downloading and building Nominatim
 124
 125 ### Downloading the latest release
 126
 127 You can download the [latest release from nominatim.org](https://nominatim.org/downloads/).
 128 The release contains all necessary files. Just unpack it.
 129
 130 ### Downloading the latest development version
 131
 132 If you want to install latest development version from github, make sure to
 133 also check out the osm2pgsql subproject:
 134
 135 ```
 136 git clone --recursive https://github.com/openstreetmap/Nominatim.git
 137 ```
 138
 139 The development version does not include the country grid. Download it separately:
 140
 141 ```
 142 wget -O Nominatim/data/country_osm_grid.sql.gz https://nominatim.org/data/country_grid.sql.gz
 143 ```
 144
 145 ### Building Nominatim
 146
 147 #### Building the latest development version with pip
 148
 149 Nominatim is easiest to run from its own virtual environment. To create one, run:
 150
 151     sudo apt-get install virtualenv
 152     virtualenv /srv/nominatim-venv
 153
 154 To install Nominatim directly from the source tree into the virtual environment, run:
 155
 156     /srv/nominatim-venv/bin/pip install packaging/nominatim-{db,api}
 157
 158 #### Building in legacy CMake mode
 159
 160 !!! warning
 161     Installing Nominatim through CMake is now deprecated. The infrastructure
 162     will be removed in Nominatim 5.0. Please switch to pip installation.
 163
 164 The code must be built in a separate directory. Create the directory and
 165 change into it.
 166
 167 ```
 168 mkdir build
 169 cd build
 170 ```
 171
 172 Nominatim uses cmake and make for building. Assuming that you have created the
 173 build at the same level as the Nominatim source directory run:
 174
 175 ```
 176 cmake ../Nominatim
 177 make
 178 sudo make install
 179 ```
 180
 181 !!! warning
 182     The default installation no longer compiles the PostgreSQL module that
 183     is needed for the legacy tokenizer from older Nominatim versions. If you
 184     are upgrading an older database or want to run the
 185     [legacy tokenizer](../customize/Tokenizers.md#legacy-tokenizer) for
 186     some other reason, you need to enable the PostgreSQL module via
 187     cmake: `cmake -DBUILD_MODULE=on ../Nominatim`. To compile the module
 188     you need to have the server development headers for PostgreSQL installed.
 189     On Ubuntu/Debian run: `sudo apt install postgresql-server-dev-<postgresql version>`
 190     The legacy tokenizer is deprecated and will be removed in Nominatim 5.0
 191
 192
 193 Nominatim installs itself into `/usr/local` per default. To choose a different
 194 installation directory add `-DCMAKE_INSTALL_PREFIX=<install root>` to the
 195 cmake command. Make sure that the `bin` directory is available in your path
 196 in that case, e.g.
 197
 198 ```
 199 export PATH=<install root>/bin:$PATH
 200 ```
 201
 202 Now continue with [importing the database](Import.md).