getNearestNamed*Feature functions better return values

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

diff --git a/docs/admin/Installation.md b/docs/admin/Installation.md
index 7ce1ea678b3d1be9d9ebb92f5deb842defb492d7..c67ff46ff3f15cd115f85aa76545b2e92e511ffa 100644 (file)
--- a/docs/admin/Installation.md
+++ b/docs/admin/Installation.md
@@ -26,44 +26,44 @@ For compiling:
 
   * [cmake](https://cmake.org/)
   * [libxml2](http://xmlsoft.org/)
 
   * [cmake](https://cmake.org/)
   * [libxml2](http://xmlsoft.org/)

-  * a recent C++ compiler
+  * a recent C++ compiler (gcc 5+ or Clang 3.8+)

 
 Nominatim comes with its own version of osm2pgsql. See the
 
 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.3 or later)
-  * [PostGIS](http://postgis.refractions.net) (2.2 or later)
-  * [PHP](http://php.net) (7.0 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
 
 A minimum of 2GB of RAM is required or installation will fail. For a full
 
 ### Hardware
 
 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 at least 700GB of hard disk space
+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.
 
 (take into account that the OSM database is growing fast). SSD disks
 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
 


@@ -73,17 +73,30 @@ 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.
 
 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:
 


@@ -91,8 +104,8 @@ 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
 
 
 ### Webserver setup