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