add /lookup endpoint to monitored API calls

[nominatim.git] / docs / Installation.md

diff --git a/docs/Installation.md b/docs/Installation.md
index ddd0fc7b6dbaf802b75ce426fc00d4148344c47d..41f76df1dba87a8190de25e2be81f251f4f61cc0 100644 (file)
--- a/docs/Installation.md
+++ b/docs/Installation.md
@@ -1,4 +1,4 @@
-Nominatim Installation
+Nominatim installation

 ======================
 
 This page contains generic installation instructions for Nominatim and its
 ======================
 
 This page contains generic installation instructions for Nominatim and its


@@ -28,8 +28,7 @@ required for compiling osm2pgsql.
 
 For running tests:
 
 
 For running tests:
 

-  * [lettuce](http://lettuce.it)
-  * [Shapely](http://toblerity.org/shapely/index.html)
+  * [behave](http://pythonhosted.org/behave/)

   * [Psycopg2](http://initd.org/psycopg)
   * [nose](https://nose.readthedocs.io)
   * [phpunit](https://phpunit.de)
   * [Psycopg2](http://initd.org/psycopg)
   * [nose](https://nose.readthedocs.io)
   * [phpunit](https://phpunit.de)


@@ -38,14 +37,14 @@ For running Nominatim:
 
   * [PostgreSQL](http://www.postgresql.org) (9.1 or later)
   * [PostGIS](http://postgis.refractions.net) (2.0 or later)
 
   * [PostgreSQL](http://www.postgresql.org) (9.1 or later)
   * [PostGIS](http://postgis.refractions.net) (2.0 or later)

-  * [PHP](http://php.net)
+  * [PHP](http://php.net) (5.4 or later)

   * PHP-pgsql
   * [PEAR::DB](http://pear.php.net/package/DB)
   * a webserver (apache or nginx are recommended)
 
 For running continuous updates:
 
   * PHP-pgsql
   * [PEAR::DB](http://pear.php.net/package/DB)
   * a webserver (apache or nginx are recommended)
 
 For running continuous updates:
 

-  * [osmosis](http://wiki.openstreetmap.org/wiki/Osmosis)
+  * [pyosmium](http://osmcode.org/pyosmium/)

 
 ### Hardware
 
 
 ### Hardware
 


@@ -60,10 +59,10 @@ 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 bit more than 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
 
 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


@@ -74,7 +73,7 @@ your `postgresql.conf` file.
     work_mem (50MB)
     effective_cache_size (24GB)
     synchronous_commit = off
     work_mem (50MB)
     effective_cache_size (24GB)
     synchronous_commit = off

-    checkpoint_segments = 100
+    checkpoint_segments = 100 # only for postgresql <= 9.4

     checkpoint_timeout = 10min
     checkpoint_completion_target = 0.9
 
     checkpoint_timeout = 10min
     checkpoint_completion_target = 0.9
 


@@ -103,7 +102,8 @@ directory and create an alias:
 
     <Directory "/srv/nominatim/build/website">
       Options FollowSymLinks MultiViews
 
     <Directory "/srv/nominatim/build/website">
       Options FollowSymLinks MultiViews

-      AddTpe text/html   .php
+      AddType text/html   .php
+      DirectoryIndex search.php

       Require all granted
     </Directory>
     Alias /nominatim /srv/nominatim/build/website
       Require all granted
     </Directory>
     Alias /nominatim /srv/nominatim/build/website


@@ -134,13 +134,15 @@ follows:
 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.
 
 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.
 

+    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;
     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 index.php;
+        fastcgi_index search.php;

         include fastcgi.conf;
     }
 
         include fastcgi.conf;
     }