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