]> git.openstreetmap.org Git - nominatim.git/blob - docs/admin/Installation.md
replace Symfony dotenv dependency with Python dotenv
[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   * [Boost libraries](https://www.boost.org/), including system and filesystem
34   * PostgreSQL client libraries
35   * a recent C++ compiler (gcc 5+ or Clang 3.8+)
36
37 For running Nominatim:
38
39   * [PostgreSQL](https://www.postgresql.org) (9.3+)
40   * [PostGIS](https://postgis.net) (2.2+)
41   * [Python 3](https://www.python.org/) (3.4+)
42   * [Psycopg2](https://www.psycopg.org)
43   * [PHP](https://php.net) (7.0 or later)
44   * PHP-pgsql
45   * PHP-intl (bundled with PHP)
46   * [Python Dotenv](https://github.com/theskumar/python-dotenv)
47
48 For running continuous updates:
49
50   * [pyosmium](https://osmcode.org/pyosmium/) (with Python 3)
51
52 For dependencies for running tests and building documentation, see
53 the [Development section](../develop/Development-Environment.md).
54
55 ### Hardware
56
57 A minimum of 2GB of RAM is required or installation will fail. For a full
58 planet import 64GB of RAM or more are strongly recommended. Do not report
59 out of memory problems if you have less than 64GB RAM.
60
61 For a full planet install you will need at least 900GB of hard disk space.
62 Take into account that the OSM database is growing fast.
63 Fast disks are essential. Using NVME disks is recommended.
64
65 Even on a well configured machine the import of a full planet takes
66 around 2 days. On traditional spinning disks, 7-8 days are more realistic.
67
68 ## Tuning the PostgreSQL database
69
70 You might want to tune your PostgreSQL installation so that the later steps
71 make best use of your hardware. You should tune the following parameters in
72 your `postgresql.conf` file.
73
74     shared_buffers = 2GB
75     maintenance_work_mem = (10GB)
76     autovacuum_work_mem = 2GB
77     work_mem = (50MB)
78     effective_cache_size = (24GB)
79     synchronous_commit = off
80     checkpoint_segments = 100 # only for postgresql <= 9.4
81     max_wal_size = 1GB # postgresql > 9.4
82     checkpoint_timeout = 10min
83     checkpoint_completion_target = 0.9
84
85 The numbers in brackets behind some parameters seem to work fine for
86 64GB RAM machine. Adjust to your setup. A higher number for `max_wal_size`
87 means that PostgreSQL needs to run checkpoints less often but it does require
88 the additional space on your disk.
89
90 Autovacuum must not be switched off because it ensures that the
91 tables are frequently analysed. If your machine has very little memory,
92 you might consider setting:
93
94     autovacuum_max_workers = 1
95
96 and even reduce `autovacuum_work_mem` further. This will reduce the amount
97 of memory that autovacuum takes away from the import process.
98
99 For the initial import, you should also set:
100
101     fsync = off
102     full_page_writes = off
103
104 Don't forget to reenable them after the initial import or you risk database
105 corruption.
106
107
108 ## Downloading and building Nominatim
109
110 ### Downloading the latest release
111
112 You can download the [latest release from nominatim.org](https://nominatim.org/downloads/).
113 The release contains all necessary files. Just unpack it.
114
115 ### Downloading the latest development version
116
117 If you want to install latest development version from github, make sure to
118 also check out the osm2pgsql subproject:
119
120 ```
121 git clone --recursive git://github.com/openstreetmap/Nominatim.git
122 ```
123
124 The development version does not include the country grid. Download it separately:
125
126 ```
127 wget -O Nominatim/data/country_osm_grid.sql.gz https://www.nominatim.org/data/country_grid.sql.gz
128 ```
129
130 ### Building Nominatim
131
132 The code must be built in a separate directory. Create the directory and
133 change into it.
134
135 ```
136 mkdir build
137 cd build
138 ```
139
140 Nominatim uses cmake and make for building. Assuming that you have created the
141 build at the same level as the Nominatim source directory run:
142
143 ```
144 cmake ../Nominatim
145 make
146 ```
147
148 Now continue with [importing the database](Import.md).