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.org) (2.2+)
  41   * [Python 3](https://www.python.org/)
  42   * [Psycopg2](https://initd.org/psycopg)
  43   * [PHP](https://php.net) (7.0 or later)
  44   * PHP-pgsql
  45   * PHP-intl (bundled with PHP)
  46   * a webserver (apache or nginx are recommended)
  47
  48 For running continuous updates:
  49
  50   * [pyosmium](https://osmcode.org/pyosmium/) (with Python 3)
  51
  52 For running tests:
  53
  54   * [behave](http://pythonhosted.org/behave/)
  55   * [nose](https://nose.readthedocs.io)
  56   * [phpunit](https://phpunit.de) >= 7.3
  57
  58 ### Hardware
  59
  60 A minimum of 2GB of RAM is required or installation will fail. For a full
  61 planet import 64GB of RAM or more are strongly recommended. Do not report
  62 out of memory problems if you have less than 64GB RAM.
  63
  64 For a full planet install you will need at least 800GB of hard disk space
  65 (take into account that the OSM database is growing fast). SSD disks
  66 will help considerably to speed up import and queries.
  67
  68 Even on a well configured machine the import of a full planet takes
  69 at least 2 days. Without SSDs 7-8 days are more realistic.
  70
  71 ## Setup of the server
  72
  73 ### PostgreSQL tuning
  74
  75 You might want to tune your PostgreSQL installation so that the later steps
  76 make best use of your hardware. You should tune the following parameters in
  77 your `postgresql.conf` file.
  78
  79     shared_buffers = 2GB
  80     maintenance_work_mem = (10GB)
  81     autovacuum_work_mem = 2GB
  82     work_mem = (50MB)
  83     effective_cache_size = (24GB)
  84     synchronous_commit = off
  85     checkpoint_segments = 100 # only for postgresql <= 9.4
  86     max_wal_size = 1GB # postgresql > 9.4
  87     checkpoint_timeout = 10min
  88     checkpoint_completion_target = 0.9
  89
  90 The numbers in brackets behind some parameters seem to work fine for
  91 64GB RAM machine. Adjust to your setup. A higher number for `max_wal_size`
  92 means that PostgreSQL needs to run checkpoints less often but it does require
  93 the additional space on your disk.
  94
  95 Autovacuum must not be switched off because it ensures that the
  96 tables are frequently analysed. If your machine has very little memory,
  97 you might consider setting:
  98
  99     autovacuum_max_workers = 1
 100
 101 and even reduce `autovacuum_work_mem` further. This will reduce the amount
 102 of memory that autovacuum takes away from the import process.
 103
 104 For the initial import, you should also set:
 105
 106     fsync = off
 107     full_page_writes = off
 108
 109 Don't forget to reenable them after the initial import or you risk database
 110 corruption.
 111
 112
 113 ### Webserver setup
 114
 115 The `website/` directory in the build directory contains the configured
 116 website. Include the directory into your webbrowser to serve php files
 117 from there.
 118
 119 #### Configure for use with Apache
 120
 121 Make sure your Apache configuration contains the required permissions for the
 122 directory and create an alias:
 123
 124 ``` apache
 125 <Directory "/srv/nominatim/build/website">
 126   Options FollowSymLinks MultiViews
 127   AddType text/html   .php
 128   DirectoryIndex search.php
 129   Require all granted
 130 </Directory>
 131 Alias /nominatim /srv/nominatim/build/website
 132 ```
 133
 134 `/srv/nominatim/build` should be replaced with the location of your
 135 build directory.
 136
 137 After making changes in the apache config you need to restart apache.
 138 The website should now be available on http://localhost/nominatim.
 139
 140 #### Configure for use with Nginx
 141
 142 Use php-fpm as a deamon for serving PHP cgi. Install php-fpm together with nginx.
 143
 144 By default php listens on a network socket. If you want it to listen to a
 145 Unix socket instead, change the pool configuration (`pool.d/www.conf`) as
 146 follows:
 147
 148     ; Comment out the tcp listener and add the unix socket
 149     ;listen = 127.0.0.1:9000
 150     listen = /var/run/php5-fpm.sock
 151
 152     ; Ensure that the daemon runs as the correct user
 153     listen.owner = www-data
 154     listen.group = www-data
 155     listen.mode = 0666
 156
 157 Tell nginx that php files are special and to fastcgi_pass to the php-fpm
 158 unix socket by adding the location definition to the default configuration.
 159
 160 ``` nginx
 161 root /srv/nominatim/build/website;
 162 index search.php;
 163 location / {
 164     try_files $uri $uri/ @php;
 165 }
 166
 167 location @php {
 168     fastcgi_param SCRIPT_FILENAME "$document_root$uri.php";
 169     fastcgi_param PATH_TRANSLATED "$document_root$uri.php";
 170     fastcgi_param QUERY_STRING    $args;
 171     fastcgi_pass unix:/var/run/php/php7.3-fpm.sock;
 172     fastcgi_index index.php;
 173     include fastcgi_params;
 174 }
 175
 176 location ~ [^/]\.php(/|$) {
 177     fastcgi_split_path_info ^(.+?\.php)(/.*)$;
 178     if (!-f $document_root$fastcgi_script_name) {
 179         return 404;
 180     }
 181     fastcgi_pass unix:/var/run/php7.3-fpm.sock;
 182     fastcgi_index search.php;
 183     include fastcgi.conf;
 184 }
 185 ```
 186
 187 Restart the nginx and php5-fpm services and the website should now be available
 188 at `http://localhost/`.
 189
 190
 191 Now continue with [importing the database](Import.md).