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 For running Nominatim:
  26
  27   * [PostgreSQL](https://www.postgresql.org) (12+ will work, 13+ strongly recommended)
  28   * [PostGIS](https://postgis.net) (3.0+ will work, 3.2+ strongly recommended)
  29   * [osm2pgsql](https://osm2pgsql.org) (1.8+, optional when building with CMake)
  30   * [Python 3](https://www.python.org/) (3.7+)
  31
  32 Furthermore the following Python libraries are required:
  33
  34   * [Psycopg3](https://www.psycopg.org)
  35   * [Python Dotenv](https://github.com/theskumar/python-dotenv)
  36   * [psutil](https://github.com/giampaolo/psutil)
  37   * [Jinja2](https://palletsprojects.com/p/jinja/)
  38   * [PyICU](https://pypi.org/project/PyICU/)
  39   * [PyYaml](https://pyyaml.org/) (5.1+)
  40   * [datrie](https://github.com/pytries/datrie)
  41
  42 These will be installed automatically when using pip installation.
  43
  44 For running continuous updates:
  45
  46   * [pyosmium](https://osmcode.org/pyosmium/)
  47
  48 For running the Python frontend:
  49
  50   * [SQLAlchemy](https://www.sqlalchemy.org/) (1.4.31+ with greenlet support)
  51   * [asyncpg](https://magicstack.github.io/asyncpg) (0.8+, only when using SQLAlchemy < 2.0)
  52   * one of the following web frameworks:
  53     * [falcon](https://falconframework.org/) (3.0+)
  54     * [starlette](https://www.starlette.io/)
  55   * [uvicorn](https://www.uvicorn.org/)
  56
  57 For dependencies for running tests and building documentation, see
  58 the [Development section](../develop/Development-Environment.md).
  59
  60 ### Hardware
  61
  62 A minimum of 2GB of RAM is required or installation will fail. For a full
  63 planet import 128GB of RAM or more are strongly recommended. Do not report
  64 out of memory problems if you have less than 64GB RAM.
  65
  66 For a full planet install you will need at least 1TB of hard disk space.
  67 Take into account that the OSM database is growing fast.
  68 Fast disks are essential. Using NVME disks is recommended.
  69
  70 Even on a well configured machine the import of a full planet takes
  71 around 2.5 days. When using traditional SSDs, 4-5 days are more realistic.
  72
  73 ## Tuning the PostgreSQL database
  74
  75 You might want to tune your PostgreSQL installation so that the later steps
  76 make best use of your hardware. You should tune the following parameters in
  77 your `postgresql.conf` file.
  78
  79     shared_buffers = 2GB
  80     maintenance_work_mem = (10GB)
  81     autovacuum_work_mem = 2GB
  82     work_mem = (50MB)
  83     synchronous_commit = off
  84     max_wal_size = 1GB
  85     checkpoint_timeout = 60min
  86     checkpoint_completion_target = 0.9
  87     random_page_cost = 1.0
  88     wal_level = minimal
  89     max_wal_senders = 0
  90
  91 The numbers in brackets behind some parameters seem to work fine for
  92 128GB RAM machine. Adjust to your setup. A higher number for `max_wal_size`
  93 means that PostgreSQL needs to run checkpoints less often but it does require
  94 the additional space on your disk.
  95
  96 Autovacuum must not be switched off because it ensures that the
  97 tables are frequently analysed. If your machine has very little memory,
  98 you might consider setting:
  99
 100     autovacuum_max_workers = 1
 101
 102 and even reduce `autovacuum_work_mem` further. This will reduce the amount
 103 of memory that autovacuum takes away from the import process.
 104
 105 ## Downloading and building Nominatim
 106
 107 ### Downloading the latest release
 108
 109 You can download the [latest release from nominatim.org](https://nominatim.org/downloads/).
 110 The release contains all necessary files. Just unpack it.
 111
 112 ### Downloading the latest development version
 113
 114 If you want to install latest development version from github:
 115
 116 ```
 117 git clone https://github.com/osm-search/Nominatim.git
 118 ```
 119
 120 The development version does not include the country grid. Download it separately:
 121
 122 ```
 123 wget -O Nominatim/data/country_osm_grid.sql.gz https://nominatim.org/data/country_grid.sql.gz
 124 ```
 125
 126 ### Building Nominatim
 127
 128 Nominatim is easiest to run from its own virtual environment. To create one, run:
 129
 130     sudo apt-get install virtualenv
 131     virtualenv /srv/nominatim-venv
 132
 133 To install Nominatim directly from the source tree into the virtual environment, run:
 134
 135     /srv/nominatim-venv/bin/pip install packaging/nominatim-{db,api}
 136
 137
 138 Now continue with [importing the database](Import.md).