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 a02b48e2a2d7fcaea3202ef54f8fe8f1cdecbf9a..6b63b0d3cfe62266240d4067ff75cb7315e742e6 100644 (file)
--- a/docs/admin/Installation.md
+++ b/docs/admin/Installation.md
@@ -7,7 +7,6 @@ the following operating systems:
   * [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)
   * [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
 in the `vagrant/` directory.
 
 These OS-specific instructions can also be found in executable form
 in the `vagrant/` directory.


@@ -17,12 +16,17 @@ and can't offer support.
 
   * [Docker](https://github.com/mediagis/nominatim-docker)
   * [Docker on Kubernetes](https://github.com/peter-evans/nominatim-k8s)
 
   * [Docker](https://github.com/mediagis/nominatim-docker)
   * [Docker on Kubernetes](https://github.com/peter-evans/nominatim-k8s)

+  * [Kubernetes with Helm](https://github.com/robjuz/helm-charts/blob/master/charts/nominatim/README.md)

   * [Ansible](https://github.com/synthesio/infra-ansible-nominatim)
 
 ## Prerequisites
 
 ### Software
 
   * [Ansible](https://github.com/synthesio/infra-ansible-nominatim)
 
 ## Prerequisites
 
 ### Software
 

+!!! Warning
+    For larger installations you **must have** PostgreSQL 11+ and Postgis 3+
+    otherwise import and queries will be slow to the point of being unusable.
+

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


@@ -30,34 +34,34 @@ For compiling:
   * [proj](https://proj.org/)
   * [bzip2](http://www.bzip.org/)
   * [zlib](https://www.zlib.net/)
   * [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:
 
   * [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:
 

-  * [PostgreSQL](https://www.postgresql.org) (9.3 - 11)
-  * [PostGIS](https://postgis.org) (2.2 - 2.5)
-  * [Python 3](https://www.python.org/)
-  * [Psycopg2](https://initd.org/psycopg)
+  * [PostgreSQL](https://www.postgresql.org) (9.5+ will work, 11+ strongly recommended)
+  * [PostGIS](https://postgis.net) (2.2+ will work, 3.0+ strongly recommended)
+  * [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/)
+  * [PyYaml](https://pyyaml.org/) (5.1+)
+  * [datrie](https://github.com/pytries/datrie)

   * [PHP](https://php.net) (7.0 or later)
   * PHP-pgsql
   * PHP-intl (bundled with PHP)
   * [PHP](https://php.net) (7.0 or later)
   * PHP-pgsql
   * PHP-intl (bundled with PHP)

-  * a webserver (apache or nginx are recommended)
-
-!!! danger "Important"
-    Postgresql 12+ and Postgis 3.0+ are known to cause performance issues. They are
-    not recommended for a production installation at the moment.
+  * PHP-cgi (for running queries from the command line)

 
 For running continuous updates:
 
 
 For running continuous updates:
 

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

 
 

-  * [behave](http://pythonhosted.org/behave/)
-  * [nose](https://nose.readthedocs.io)
-  * [phpunit](https://phpunit.de)
+For dependencies for running tests and building documentation, see
+the [Development section](../develop/Development-Environment.md).

 
 ### Hardware
 
 
 ### Hardware
 


@@ -65,16 +69,14 @@ 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.
 
 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 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.
+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.

 
 Even on a well configured machine the import of a full planet takes
 
 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.
+around 2 days. On traditional spinning disks, 7-8 days are more realistic.

 
 

-## Setup of the server
-
-### 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
 
 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


@@ -114,65 +116,54 @@ Don't forget to reenable them after the initial import or you risk database
 corruption.
 
 
 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).