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