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