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