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 18.04](../appendix/Install-on-Ubuntu-18.md)
   8   * [Ubuntu 16.04](../appendix/Install-on-Ubuntu-16.md)
   9   * [CentOS 7.2](../appendix/Install-on-Centos-7.md)
  10
  11 These OS-specific instructions can also be found in executable form
  12 in the `vagrant/` directory.
  13
  14 Users have created instructions for other frameworks. We haven't tested those
  15 and can't offer support.
  16
  17   * [Docker](https://github.com/mediagis/nominatim-docker)
  18   * [Docker on Kubernetes](https://github.com/peter-evans/nominatim-k8s)
  19   * [Ansible](https://github.com/synthesio/infra-ansible-nominatim)
  20
  21 ## Prerequisites
  22
  23 ### Software
  24
  25 For compiling:
  26
  27   * [cmake](https://cmake.org/)
  28   * [libxml2](http://xmlsoft.org/)
  29   * a recent C++ compiler
  30
  31 Nominatim comes with its own version of osm2pgsql. See the
  32 osm2pgsql README for additional dependencies required for compiling osm2pgsql.
  33
  34 For running tests:
  35
  36   * [behave](http://pythonhosted.org/behave/)
  37   * [Psycopg2](http://initd.org/psycopg)
  38   * [nose](https://nose.readthedocs.io)
  39   * [phpunit](https://phpunit.de)
  40
  41 For running Nominatim:
  42
  43   * [PostgreSQL](http://www.postgresql.org) (9.1 or later)
  44   * [PostGIS](http://postgis.refractions.net) (2.0 or later)
  45   * [PHP](http://php.net) (5.4 or later)
  46   * PHP-pgsql
  47   * PHP-intl (bundled with PHP)
  48   * [PEAR::DB](http://pear.php.net/package/DB)
  49   * a webserver (apache or nginx are recommended)
  50
  51 For running continuous updates:
  52
  53   * [pyosmium](http://osmcode.org/pyosmium/)
  54
  55 ### Hardware
  56
  57 A minimum of 2GB of RAM is required or installation will fail. For a full
  58 planet import 32GB of RAM or more strongly are recommended.
  59
  60 For a full planet install you will need at least 700GB of hard disk space
  61 (take into account that the OSM database is growing fast). SSD disks
  62 will help considerably to speed up import and queries.
  63
  64 On a 6-core machine with 32GB RAM and SSDs the import of a full planet takes
  65 a bit more than 2 days. Without SSDs 7-8 days are more realistic.
  66
  67
  68 ## Setup of the server
  69
  70 ### PostgreSQL tuning
  71
  72 You might want to tune your PostgreSQL installation so that the later steps
  73 make best use of your hardware. You should tune the following parameters in
  74 your `postgresql.conf` file.
  75
  76     shared_buffers (2GB)
  77     maintenance_work_mem (10GB)
  78     work_mem (50MB)
  79     effective_cache_size (24GB)
  80     synchronous_commit = off
  81     checkpoint_segments = 100 # only for 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 32GB RAM machine. Adjust to your setup.
  87
  88 For the initial import, you should also set:
  89
  90     fsync = off
  91     full_page_writes = off
  92
  93 Don't forget to reenable them after the initial import or you risk database
  94 corruption. Autovacuum must not be switched off because it ensures that the
  95 tables are frequently analysed.
  96
  97 ### Webserver setup
  98
  99 The `website/` directory in the build directory contains the configured
 100 website. Include the directory into your webbrowser to serve php files
 101 from there.
 102
 103 #### Configure for use with Apache
 104
 105 Make sure your Apache configuration contains the required permissions for the
 106 directory and create an alias:
 107
 108     <Directory "/srv/nominatim/build/website">
 109       Options FollowSymLinks MultiViews
 110       AddType text/html   .php
 111       DirectoryIndex search.php
 112       Require all granted
 113     </Directory>
 114     Alias /nominatim /srv/nominatim/build/website
 115
 116 `/srv/nominatim/build` should be replaced with the location of your
 117 build directory.
 118
 119 After making changes in the apache config you need to restart apache.
 120 The website should now be available on http://localhost/nominatim.
 121
 122 #### Configure for use with Nginx
 123
 124 Use php-fpm as a deamon for serving PHP cgi. Install php-fpm together with nginx.
 125
 126 By default php listens on a network socket. If you want it to listen to a
 127 Unix socket instead, change the pool configuration (`pool.d/www.conf`) as
 128 follows:
 129
 130     ; Comment out the tcp listener and add the unix socket
 131     ;listen = 127.0.0.1:9000
 132     listen = /var/run/php5-fpm.sock
 133
 134     ; Ensure that the daemon runs as the correct user
 135     listen.owner = www-data
 136     listen.group = www-data
 137     listen.mode = 0666
 138
 139 Tell nginx that php files are special and to fastcgi_pass to the php-fpm
 140 unix socket by adding the location definition to the default configuration.
 141
 142     root /srv/nominatim/build/website;
 143     index search.php index.html;
 144     location / {
 145             try_files $uri $uri/ @php;
 146     }
 147
 148     location @php {
 149             fastcgi_param SCRIPT_FILENAME "$document_root$uri.php";
 150             fastcgi_param PATH_TRANSLATED "$document_root$uri.php";
 151             fastcgi_param QUERY_STRING    $args;
 152             fastcgi_pass unix:/var/run/php/php7.2-fpm.sock;
 153             fastcgi_index index.php;
 154             include fastcgi_params;
 155     }
 156
 157     location ~ [^/]\.php(/|$) {
 158         fastcgi_split_path_info ^(.+?\.php)(/.*)$;
 159         if (!-f $document_root$fastcgi_script_name) {
 160             return 404;
 161         }
 162         fastcgi_pass unix:/var/run/php7.2-fpm.sock;
 163         fastcgi_index search.php;
 164         include fastcgi.conf;
 165     }
 166
 167 Restart the nginx and php5-fpm services and the website should now be available
 168 at `http://localhost/`.
 169
 170
 171 Now continue with [importing the database](Import-and-Update.md).