docs/Installation.md

   1 Nominatim installation
   2 ======================
   3
   4 This page contains generic installation instructions for Nominatim and its
   5 prerequisites. There are also step-by-step instructions available for
   6 the following operating systems:
   7
   8   * [Ubuntu 16.04](install-on-ubuntu-16.md)
   9   * [CentOS 7.2](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 Prerequisites
  15 -------------
  16
  17 ### Software
  18
  19 For compiling:
  20
  21   * [cmake](https://cmake.org/)
  22   * [libxml2](http://xmlsoft.org/)
  23   * a recent C++ compiler
  24
  25 Nominatim comes with its own version of osm2pgsql. See the
  26 [osm2pgsql README](../osm2pgsql/README.md) for additional dependencies
  27 required for compiling osm2pgsql.
  28
  29 For running tests:
  30
  31   * [lettuce](http://lettuce.it)
  32   * [Shapely](http://toblerity.org/shapely/index.html)
  33   * [Psycopg2](http://initd.org/psycopg)
  34   * [nose](https://nose.readthedocs.io)
  35   * [phpunit](https://phpunit.de)
  36
  37 For running Nominatim:
  38
  39   * [PostgreSQL](http://www.postgresql.org) (9.1 or later)
  40   * [PostGIS](http://postgis.refractions.net) (2.0 or later)
  41   * [PHP](http://php.net)
  42   * PHP-pgsql
  43   * [PEAR::DB](http://pear.php.net/package/DB)
  44   * a webserver (apache or nginx are recommended)
  45
  46 For running continuous updates:
  47
  48   * [osmosis](http://wiki.openstreetmap.org/wiki/Osmosis)
  49
  50 ### Hardware
  51
  52 A minimum of 2GB of RAM is required or installation will fail. For a full
  53 planet import 32GB of RAM or more strongly are recommended.
  54
  55 For a full planet install you will need about 500GB of hard disk space (as of
  56 June 2016, take into account that the OSM database is growing fast). SSD disks
  57 will help considerably to speed up import and queries.
  58
  59 On a 6-core machine with 32GB RAM and SSDs the import of a full planet takes
  60 a bit more than 2 days. Without SSDs 7-8 days are more realistic.
  61
  62
  63 Setup of the server
  64 -------------------
  65
  66 ### PostgreSQL tuning
  67
  68 You might want to tune your PostgreSQL installation so that the later steps
  69 make best use of your hardware. You should tune the following parameters in
  70 your `postgresql.conf` file.
  71
  72     shared_buffers (2GB)
  73     maintenance_work_mem (10GB)
  74     work_mem (50MB)
  75     effective_cache_size (24GB)
  76     synchronous_commit = off
  77     checkpoint_segments = 100 # only for postgresql <= 9.4
  78     checkpoint_timeout = 10min
  79     checkpoint_completion_target = 0.9
  80
  81 The numbers in brackets behind some parameters seem to work fine for
  82 32GB RAM machine. Adjust to your setup.
  83
  84 For the initial import, you should also set:
  85
  86     fsync = off
  87     full_page_writes = off
  88
  89 Don't forget to reenable them after the initial import or you risk database
  90 corruption. Autovacuum must not be switched off because it ensures that the
  91 tables are frequently analysed.
  92
  93 ### Webserver setup
  94
  95 The `website/` directory in the build directory contains the configured
  96 website. Include the directory into your webbrowser to serve php files
  97 from there.
  98
  99 #### Configure for use with Apache
 100
 101 Make sure your Apache configuration contains the required permissions for the
 102 directory and create an alias:
 103
 104     <Directory "/srv/nominatim/build/website">
 105       Options FollowSymLinks MultiViews
 106       AddType text/html   .php
 107       Require all granted
 108     </Directory>
 109     Alias /nominatim /srv/nominatim/build/website
 110
 111 `/srv/nominatim/build` should be replaced with the location of your
 112 build directory.
 113
 114 After making changes in the apache config you need to restart apache.
 115 The website should now be available on http://localhost/nominatim.
 116
 117 #### Configure for use with Nginx
 118
 119 Use php-fpm as a deamon for serving PHP cgi. Install php-fpm together with nginx.
 120
 121 By default php listens on a network socket. If you want it to listen to a
 122 Unix socket instead, change the pool configuration (`pool.d/www.conf`) as
 123 follows:
 124
 125     ; Comment out the tcp listener and add the unix socket
 126     ;listen = 127.0.0.1:9000
 127     listen = /var/run/php5-fpm.sock
 128
 129     ; Ensure that the daemon runs as the correct user
 130     listen.owner = www-data
 131     listen.group = www-data
 132     listen.mode = 0666
 133
 134 Tell nginx that php files are special and to fastcgi_pass to the php-fpm
 135 unix socket by adding the location definition to the default configuration.
 136
 137     location ~ [^/]\.php(/|$) {
 138         fastcgi_split_path_info ^(.+?\.php)(/.*)$;
 139         if (!-f $document_root$fastcgi_script_name) {
 140             return 404;
 141         }
 142         fastcgi_pass unix:/var/run/php5-fpm.sock;
 143         fastcgi_index index.php;
 144         include fastcgi.conf;
 145     }
 146
 147 Restart the nginx and php5-fpm services and the website should now be available
 148 on http://localhost/.
 149
 150
 151 Now continue with [importing the database](Import_and_update.md).