]> 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 20.04](../appendix/Install-on-Ubuntu-20.md)
8   * [Ubuntu 18.04](../appendix/Install-on-Ubuntu-18.md)
9   * [CentOS 8](../appendix/Install-on-Centos-8.md)
10   * [CentOS 7.2](../appendix/Install-on-Centos-7.md)
11
12 These OS-specific instructions can also be found in executable form
13 in the `vagrant/` directory.
14
15 Users have created instructions for other frameworks. We haven't tested those
16 and can't offer support.
17
18   * [Docker](https://github.com/mediagis/nominatim-docker)
19   * [Docker on Kubernetes](https://github.com/peter-evans/nominatim-k8s)
20   * [Ansible](https://github.com/synthesio/infra-ansible-nominatim)
21
22 ## Prerequisites
23
24 ### Software
25
26 For compiling:
27
28   * [cmake](https://cmake.org/)
29   * [expat](https://libexpat.github.io/)
30   * [proj](https://proj.org/)
31   * [bzip2](http://www.bzip.org/)
32   * [zlib](https://www.zlib.net/)
33   * [ICU](http://site.icu-project.org/)
34   * [Boost libraries](https://www.boost.org/), including system and filesystem
35   * PostgreSQL client libraries
36   * a recent C++ compiler (gcc 5+ or Clang 3.8+)
37
38 For running Nominatim:
39
40   * [PostgreSQL](https://www.postgresql.org) (9.3+ will work, 11+ strongly recommended)
41   * [PostGIS](https://postgis.net) (2.2+)
42   * [Python 3](https://www.python.org/) (3.6+)
43   * [Psycopg2](https://www.psycopg.org) (2.7+)
44   * [Python Dotenv](https://github.com/theskumar/python-dotenv)
45   * [psutil](https://github.com/giampaolo/psutil)
46   * [Jinja2](https://palletsprojects.com/p/jinja/)
47   * [PyICU](https://pypi.org/project/PyICU/)
48   * [PyYaml](https://pyyaml.org/) (5.1+)
49   * [datrie](https://github.com/pytries/datrie)
50   * [PHP](https://php.net) (7.0 or later)
51   * PHP-pgsql
52   * PHP-intl (bundled with PHP)
53   * PHP-cgi (for running queries from the command line)
54
55 For running continuous updates:
56
57   * [pyosmium](https://osmcode.org/pyosmium/)
58
59 For dependencies for running tests and building documentation, see
60 the [Development section](../develop/Development-Environment.md).
61
62 ### Hardware
63
64 A minimum of 2GB of RAM is required or installation will fail. For a full
65 planet import 64GB of RAM or more are strongly recommended. Do not report
66 out of memory problems if you have less than 64GB RAM.
67
68 For a full planet install you will need at least 900GB of hard disk space.
69 Take into account that the OSM database is growing fast.
70 Fast disks are essential. Using NVME disks is recommended.
71
72 Even on a well configured machine the import of a full planet takes
73 around 2 days. On traditional spinning disks, 7-8 days are more realistic.
74
75 ## Tuning the PostgreSQL database
76
77 You might want to tune your PostgreSQL installation so that the later steps
78 make best use of your hardware. You should tune the following parameters in
79 your `postgresql.conf` file.
80
81     shared_buffers = 2GB
82     maintenance_work_mem = (10GB)
83     autovacuum_work_mem = 2GB
84     work_mem = (50MB)
85     effective_cache_size = (24GB)
86     synchronous_commit = off
87     checkpoint_segments = 100 # only for postgresql <= 9.4
88     max_wal_size = 1GB # postgresql > 9.4
89     checkpoint_timeout = 10min
90     checkpoint_completion_target = 0.9
91
92 The numbers in brackets behind some parameters seem to work fine for
93 64GB RAM machine. Adjust to your setup. A higher number for `max_wal_size`
94 means that PostgreSQL needs to run checkpoints less often but it does require
95 the additional space on your disk.
96
97 Autovacuum must not be switched off because it ensures that the
98 tables are frequently analysed. If your machine has very little memory,
99 you might consider setting:
100
101     autovacuum_max_workers = 1
102
103 and even reduce `autovacuum_work_mem` further. This will reduce the amount
104 of memory that autovacuum takes away from the import process.
105
106 For the initial import, you should also set:
107
108     fsync = off
109     full_page_writes = off
110
111 Don't forget to reenable them after the initial import or you risk database
112 corruption.
113
114
115 ## Downloading and building Nominatim
116
117 ### Downloading the latest release
118
119 You can download the [latest release from nominatim.org](https://nominatim.org/downloads/).
120 The release contains all necessary files. Just unpack it.
121
122 ### Downloading the latest development version
123
124 If you want to install latest development version from github, make sure to
125 also check out the osm2pgsql subproject:
126
127 ```
128 git clone --recursive git://github.com/openstreetmap/Nominatim.git
129 ```
130
131 The development version does not include the country grid. Download it separately:
132
133 ```
134 wget -O Nominatim/data/country_osm_grid.sql.gz https://www.nominatim.org/data/country_grid.sql.gz
135 ```
136
137 ### Building Nominatim
138
139 The code must be built in a separate directory. Create the directory and
140 change into it.
141
142 ```
143 mkdir build
144 cd build
145 ```
146
147 Nominatim uses cmake and make for building. Assuming that you have created the
148 build at the same level as the Nominatim source directory run:
149
150 ```
151 cmake ../Nominatim
152 make
153 sudo make install
154 ```
155
156 Nominatim installs itself into `/usr/local` per default. To choose a different
157 installation directory add `-DCMAKE_INSTALL_PREFIX=<install root>` to the
158 cmake command. Make sure that the `bin` directory is available in your path
159 in that case, e.g.
160
161 ```
162 export PATH=<install root>/bin:$PATH
163 ```
164
165 Now continue with [importing the database](Import.md).