Merge remote-tracking branch 'upstream/master'

[nominatim.git] / docs / admin / Installation.md

diff --git a/docs/admin/Installation.md b/docs/admin/Installation.md
index 67c4fe3c6687639423ef3ed465619ee1516347c8..cc1edf590abdfa041ceffedd9bce05c7c5d87809 100644 (file)
--- a/docs/admin/Installation.md
+++ b/docs/admin/Installation.md
@@ -1,8 +1,12 @@
+# Basic Installation
+

 This page contains generic installation instructions for Nominatim and its
 prerequisites. There are also step-by-step instructions available for
 the following operating systems:
 
 This page contains generic installation instructions for Nominatim and its
 prerequisites. There are also step-by-step instructions available for
 the following operating systems:
 

-  * [Ubuntu 16.04](../appendix/Install-on-Ubuntu-16.md)
+  * [Ubuntu 20.04](../appendix/Install-on-Ubuntu-20.md)
+  * [Ubuntu 18.04](../appendix/Install-on-Ubuntu-18.md)
+  * [CentOS 8](../appendix/Install-on-Centos-8.md)

   * [CentOS 7.2](../appendix/Install-on-Centos-7.md)
 
 These OS-specific instructions can also be found in executable form
   * [CentOS 7.2](../appendix/Install-on-Centos-7.md)
 
 These OS-specific instructions can also be found in executable form


@@ -15,72 +19,88 @@ and can't offer support.
   * [Docker on Kubernetes](https://github.com/peter-evans/nominatim-k8s)
   * [Ansible](https://github.com/synthesio/infra-ansible-nominatim)
 
   * [Docker on Kubernetes](https://github.com/peter-evans/nominatim-k8s)
   * [Ansible](https://github.com/synthesio/infra-ansible-nominatim)
 

-# Prerequisites
+## Prerequisites

 
 

-## Software
+### Software

 
 For compiling:
 
   * [cmake](https://cmake.org/)
 
 For compiling:
 
   * [cmake](https://cmake.org/)

-  * [libxml2](http://xmlsoft.org/)
-  * a recent C++ compiler
-
-Nominatim comes with its own version of osm2pgsql. See the
-osm2pgsql README for additional dependencies required for compiling osm2pgsql.
-
-For running tests:
-
-  * [behave](http://pythonhosted.org/behave/)
-  * [Psycopg2](http://initd.org/psycopg)
-  * [nose](https://nose.readthedocs.io)
-  * [phpunit](https://phpunit.de)
+  * [expat](https://libexpat.github.io/)
+  * [proj](https://proj.org/)
+  * [bzip2](http://www.bzip.org/)
+  * [zlib](https://www.zlib.net/)
+  * [ICU](http://site.icu-project.org/)
+  * [Boost libraries](https://www.boost.org/), including system and filesystem
+  * PostgreSQL client libraries
+  * a recent C++ compiler (gcc 5+ or Clang 3.8+)

 
 For running Nominatim:
 
 
 For running Nominatim:
 

-  * [PostgreSQL](http://www.postgresql.org) (9.1 or later)
-  * [PostGIS](http://postgis.refractions.net) (2.0 or later)
-  * [PHP](http://php.net) (5.4 or later)
+  * [PostgreSQL](https://www.postgresql.org) (9.3+ will work, 11+ strongly recommended)
+  * [PostGIS](https://postgis.net) (2.2+)
+  * [Python 3](https://www.python.org/) (3.6+)
+  * [Psycopg2](https://www.psycopg.org) (2.7+)
+  * [Python Dotenv](https://github.com/theskumar/python-dotenv)
+  * [psutil](https://github.com/giampaolo/psutil)
+  * [Jinja2](https://palletsprojects.com/p/jinja/)
+  * [PyICU](https://pypi.org/project/PyICU/)
+  * [datrie](https://github.com/pytries/datrie)
+  * [PHP](https://php.net) (7.0 or later)

   * PHP-pgsql
   * PHP-intl (bundled with PHP)
   * PHP-pgsql
   * PHP-intl (bundled with PHP)

-  * [PEAR::DB](http://pear.php.net/package/DB)
-  * a webserver (apache or nginx are recommended)
+  * PHP-cgi (for running queries from the command line)

 
 For running continuous updates:
 
 
 For running continuous updates:
 

-  * [pyosmium](http://osmcode.org/pyosmium/)
-
-## Hardware
+  * [pyosmium](https://osmcode.org/pyosmium/)

 
 

-A minimum of 2GB of RAM is required or installation will fail. For a full
-planet import 32GB of RAM or more strongly are recommended.
+For dependencies for running tests and building documentation, see
+the [Development section](../develop/Development-Environment.md).

 
 

-For a full planet install you will need about 600GB of hard disk space (as of
-January 2017, take into account that the OSM database is growing fast). SSD disks
-will help considerably to speed up import and queries.
+### Hardware

 
 

-On a 6-core machine with 32GB RAM and SSDs the import of a full planet takes
-a bit more than 2 days. Without SSDs 7-8 days are more realistic.
+A minimum of 2GB of RAM is required or installation will fail. For a full
+planet import 64GB of RAM or more are strongly recommended. Do not report
+out of memory problems if you have less than 64GB RAM.

 
 

+For a full planet install you will need at least 900GB of hard disk space.
+Take into account that the OSM database is growing fast.
+Fast disks are essential. Using NVME disks is recommended.

 
 

-# Setup of the server
+Even on a well configured machine the import of a full planet takes
+around 2 days. On traditional spinning disks, 7-8 days are more realistic.

 
 

-## PostgreSQL tuning
+## Tuning the PostgreSQL database

 
 You might want to tune your PostgreSQL installation so that the later steps
 make best use of your hardware. You should tune the following parameters in
 your `postgresql.conf` file.
 
 
 You might want to tune your PostgreSQL installation so that the later steps
 make best use of your hardware. You should tune the following parameters in
 your `postgresql.conf` file.
 

-    shared_buffers (2GB)
-    maintenance_work_mem (10GB)
-    work_mem (50MB)
-    effective_cache_size (24GB)
+    shared_buffers = 2GB
+    maintenance_work_mem = (10GB)
+    autovacuum_work_mem = 2GB
+    work_mem = (50MB)
+    effective_cache_size = (24GB)

     synchronous_commit = off
     checkpoint_segments = 100 # only for postgresql <= 9.4
     synchronous_commit = off
     checkpoint_segments = 100 # only for postgresql <= 9.4

+    max_wal_size = 1GB # postgresql > 9.4

     checkpoint_timeout = 10min
     checkpoint_completion_target = 0.9
 
 The numbers in brackets behind some parameters seem to work fine for
     checkpoint_timeout = 10min
     checkpoint_completion_target = 0.9
 
 The numbers in brackets behind some parameters seem to work fine for

-32GB RAM machine. Adjust to your setup.
+64GB RAM machine. Adjust to your setup. A higher number for `max_wal_size`
+means that PostgreSQL needs to run checkpoints less often but it does require
+the additional space on your disk.
+
+Autovacuum must not be switched off because it ensures that the
+tables are frequently analysed. If your machine has very little memory,
+you might consider setting:
+
+    autovacuum_max_workers = 1
+
+and even reduce `autovacuum_work_mem` further. This will reduce the amount
+of memory that autovacuum takes away from the import process.

 
 For the initial import, you should also set:
 
 
 For the initial import, you should also set:
 


@@ -88,68 +108,57 @@ For the initial import, you should also set:
     full_page_writes = off
 
 Don't forget to reenable them after the initial import or you risk database
     full_page_writes = off
 
 Don't forget to reenable them after the initial import or you risk database

-corruption. Autovacuum must not be switched off because it ensures that the
-tables are frequently analysed.
+corruption.

 
 

-## Webserver setup

 
 

-The `website/` directory in the build directory contains the configured
-website. Include the directory into your webbrowser to serve php files
-from there.
+## Downloading and building Nominatim

 
 

-### Configure for use with Apache
+### Downloading the latest release

 
 

-Make sure your Apache configuration contains the required permissions for the
-directory and create an alias:
+You can download the [latest release from nominatim.org](https://nominatim.org/downloads/).
+The release contains all necessary files. Just unpack it.

 
 

-    <Directory "/srv/nominatim/build/website">
-      Options FollowSymLinks MultiViews
-      AddType text/html   .php
-      DirectoryIndex search.php
-      Require all granted
-    </Directory>
-    Alias /nominatim /srv/nominatim/build/website
+### Downloading the latest development version

 
 

-`/srv/nominatim/build` should be replaced with the location of your
-build directory.
+If you want to install latest development version from github, make sure to
+also check out the osm2pgsql subproject:

 
 

-After making changes in the apache config you need to restart apache.
-The website should now be available on http://localhost/nominatim.
+```
+git clone --recursive git://github.com/openstreetmap/Nominatim.git
+```

 
 

-### Configure for use with Nginx
+The development version does not include the country grid. Download it separately:

 
 

-Use php-fpm as a deamon for serving PHP cgi. Install php-fpm together with nginx.
+```
+wget -O Nominatim/data/country_osm_grid.sql.gz https://www.nominatim.org/data/country_grid.sql.gz
+```

 
 

-By default php listens on a network socket. If you want it to listen to a
-Unix socket instead, change the pool configuration (`pool.d/www.conf`) as
-follows:
+### Building Nominatim

 
 

-    ; Comment out the tcp listener and add the unix socket
-    ;listen = 127.0.0.1:9000
-    listen = /var/run/php5-fpm.sock
+The code must be built in a separate directory. Create the directory and
+change into it.

 
 

-    ; Ensure that the daemon runs as the correct user
-    listen.owner = www-data
-    listen.group = www-data
-    listen.mode = 0666
+```
+mkdir build
+cd build
+```

 
 

-Tell nginx that php files are special and to fastcgi_pass to the php-fpm
-unix socket by adding the location definition to the default configuration.
+Nominatim uses cmake and make for building. Assuming that you have created the
+build at the same level as the Nominatim source directory run:

 
 

-    root /srv/nominatim/build/website;
-    index search.php index.html;
-    location ~ [^/]\.php(/|$) {
-        fastcgi_split_path_info ^(.+?\.php)(/.*)$;
-        if (!-f $document_root$fastcgi_script_name) {
-            return 404;
-        }
-        fastcgi_pass unix:/var/run/php5-fpm.sock;
-        fastcgi_index search.php;
-        include fastcgi.conf;
-    }
+```
+cmake ../Nominatim
+make
+sudo make install
+```

 
 

-Restart the nginx and php5-fpm services and the website should now be available
-at `http://localhost/`.
+Nominatim installs itself into `/usr/local` per default. To choose a different
+installation directory add `-DCMAKE_INSTALL_PREFIX=<install root>` to the
+cmake command. Make sure that the `bin` directory is available in your path
+in that case, e.g.

 
 

+```
+export PATH=<install root>/bin:$PATH
+```

 
 

-Now continue with [importing the database](Import-and-Update.md).
+Now continue with [importing the database](Import.md).