update osm2pgsql (gazetteer output tests)

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

diff --git a/docs/admin/Installation.md b/docs/admin/Installation.md
index 67c4fe3c6687639423ef3ed465619ee1516347c8..89afd2bcdda3cb011c13d0264c166a24fd48a7e8 100644 (file)
--- a/docs/admin/Installation.md
+++ b/docs/admin/Installation.md
@@ -1,7 +1,10 @@
+# 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 18.04](../appendix/Install-on-Ubuntu-18.md)

   * [Ubuntu 16.04](../appendix/Install-on-Ubuntu-16.md)
   * [CentOS 7.2](../appendix/Install-on-Centos-7.md)
 
   * [Ubuntu 16.04](../appendix/Install-on-Ubuntu-16.md)
   * [CentOS 7.2](../appendix/Install-on-Centos-7.md)
 


@@ -15,9 +18,9 @@ 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:
 
 
 For compiling:
 


@@ -26,61 +29,65 @@ For compiling:
   * a recent C++ compiler
 
 Nominatim comes with its own version of osm2pgsql. See the
   * a recent C++ compiler
 
 Nominatim comes with its own version of osm2pgsql. See the

-osm2pgsql README for additional dependencies required for compiling osm2pgsql.
+[osm2pgsql README](https://github.com/openstreetmap/osm2pgsql/blob/master/README.md#building)
+for additional dependencies required for compiling osm2pgsql.

 
 For running tests:
 
   * [behave](http://pythonhosted.org/behave/)
 
 For running tests:
 
   * [behave](http://pythonhosted.org/behave/)

-  * [Psycopg2](http://initd.org/psycopg)
+  * [Psycopg2](https://initd.org/psycopg)

   * [nose](https://nose.readthedocs.io)
   * [phpunit](https://phpunit.de)
 
 For running Nominatim:
 
   * [nose](https://nose.readthedocs.io)
   * [phpunit](https://phpunit.de)
 
 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 or later)
+  * [PostGIS](https://postgis.org) (2.2 or later)
+  * [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)
 
 For running continuous updates:
 
   * a webserver (apache or nginx are recommended)
 
 For running continuous updates:
 

-  * [pyosmium](http://osmcode.org/pyosmium/)
+  * [pyosmium](https://osmcode.org/pyosmium/) (with Python 3)

 
 

-## Hardware
+### Hardware

 
 A minimum of 2GB of RAM is required or installation will fail. For a full
 
 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.
+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 about 600GB of hard disk space (as of
-January 2017, take into account that the OSM database is growing fast). SSD disks
+For a full planet install you will need at least 800GB of hard disk space
+(take into account that the OSM database is growing fast). SSD disks

 will help considerably to speed up import and queries.
 
 will help considerably to speed up import and queries.
 

-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.
-
+Even on a well configured machine the import of a full planet takes
+at least 2 days. Without SSDs 7-8 days are more realistic.

 
 

-# Setup of the server
+## Setup of the server

 
 

-## PostgreSQL tuning
+### PostgreSQL tuning

 
 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.

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


@@ -91,13 +98,13 @@ 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. Autovacuum must not be switched off because it ensures that the
 tables are frequently analysed.
 

-## Webserver setup
+### 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.
 
 
 The `website/` directory in the build directory contains the configured
 website. Include the directory into your webbrowser to serve php files
 from there.
 

-### Configure for use with Apache
+#### Configure for use with Apache

 
 Make sure your Apache configuration contains the required permissions for the
 directory and create an alias:
 
 Make sure your Apache configuration contains the required permissions for the
 directory and create an alias:


@@ -116,7 +123,7 @@ build directory.
 After making changes in the apache config you need to restart apache.
 The website should now be available on http://localhost/nominatim.
 
 After making changes in the apache config you need to restart apache.
 The website should now be available on http://localhost/nominatim.
 

-### Configure for use with Nginx
+#### Configure for use with Nginx

 
 Use php-fpm as a deamon for serving PHP cgi. Install php-fpm together with nginx.
 
 
 Use php-fpm as a deamon for serving PHP cgi. Install php-fpm together with nginx.