more library documentation

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

diff --git a/docs/admin/Installation.md b/docs/admin/Installation.md
index 8ca41e8f407592fe6327e30e58d6dd18f03fc337..abcd89d8d540e844102179ab35dfba4adb49f547 100644 (file)
--- a/docs/admin/Installation.md
+++ b/docs/admin/Installation.md
@@ -4,10 +4,8 @@ This page contains generic installation instructions for Nominatim and its
 prerequisites. There are also step-by-step instructions available for
 the following operating systems:
 
 prerequisites. There are also step-by-step instructions available for
 the following operating systems:
 

+  * [Ubuntu 22.04](../appendix/Install-on-Ubuntu-22.md)

   * [Ubuntu 20.04](../appendix/Install-on-Ubuntu-20.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 +15,18 @@ 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.
+    Query performance has marked improvements with PostgreSQL 13+ and PostGIS 3.2+.
+

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


@@ -30,23 +34,40 @@ 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/)
+  * [nlohmann/json](https://json.nlohmann.me/)

   * [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+)
-  * [PostGIS](https://postgis.net) (2.2+)
-  * [Python 3](https://www.python.org/)
-  * [Psycopg2](https://www.psycopg.org)
-  * [PHP](https://php.net) (7.0 or later)
+  * [PostgreSQL](https://www.postgresql.org) (9.6+ will work, 11+ strongly recommended)
+  * [PostGIS](https://postgis.net) (2.2+ will work, 3.0+ strongly recommended)
+  * [Python 3](https://www.python.org/) (3.7+)
+  * [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/)
+  * [SQLAlchemy](https://www.sqlalchemy.org/) (1.4.31+ with greenlet support)
+  * [asyncpg](https://magicstack.github.io/asyncpg) (0.8+)
+  * [PyICU](https://pypi.org/project/PyICU/)
+  * [PyYaml](https://pyyaml.org/) (5.1+)
+  * [datrie](https://github.com/pytries/datrie)
+  * [PHP](https://php.net) (7.3+)

   * PHP-pgsql
   * PHP-intl (bundled with PHP)
 
 For running continuous updates:
 
   * PHP-pgsql
   * PHP-intl (bundled with PHP)
 
 For running continuous updates:
 

-  * [pyosmium](https://osmcode.org/pyosmium/) (with Python 3)
+  * [pyosmium](https://osmcode.org/pyosmium/)
+
+For running the experimental Python frontend:
+
+  * one of the following web frameworks:
+    * [falcon](https://falconframework.org/) (3.0+)
+    * [starlette](https://www.starlette.io/)
+  * [uvicorn](https://www.uvicorn.org/)

 
 For dependencies for running tests and building documentation, see
 the [Development section](../develop/Development-Environment.md).
 
 For dependencies for running tests and building documentation, see
 the [Development section](../develop/Development-Environment.md).


@@ -54,15 +75,15 @@ the [Development section](../develop/Development-Environment.md).
 ### 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 64GB of RAM or more are strongly recommended. Do not report
+planet import 128GB of RAM or more are strongly recommended. Do not report

 out of memory problems if you have less than 64GB RAM.
 
 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 1TB 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.

 
 ## Tuning the PostgreSQL database
 
 
 ## Tuning the PostgreSQL database
 


@@ -76,8 +97,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 # only for postgresql <= 9.4
-    max_wal_size = 1GB # postgresql > 9.4
+    max_wal_size = 1GB

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


@@ -100,7 +120,7 @@ For the initial import, you should also set:
     fsync = off
     full_page_writes = off
 
     fsync = off
     full_page_writes = off
 

-Don't forget to reenable them after the initial import or you risk database
+Don't forget to re-enable them after the initial import or you risk database

 corruption.
 
 
 corruption.
 
 


@@ -117,13 +137,13 @@ If you want to install latest development version from github, make sure to
 also check out the osm2pgsql subproject:
 
 ```
 also check out the osm2pgsql subproject:
 
 ```

-git clone --recursive git://github.com/openstreetmap/Nominatim.git
+git clone --recursive https://github.com/openstreetmap/Nominatim.git

 ```
 
 The development version does not include the country grid. Download it separately:
 
 ```
 ```
 
 The development version does not include the country grid. Download it separately:
 
 ```

-wget -O Nominatim/data/country_osm_grid.sql.gz https://www.nominatim.org/data/country_grid.sql.gz
+wget -O Nominatim/data/country_osm_grid.sql.gz https://nominatim.org/data/country_grid.sql.gz

 ```
 
 ### Building Nominatim
 ```
 
 ### Building Nominatim


@@ -142,6 +162,27 @@ build at the same level as the Nominatim source directory run:
 ```
 cmake ../Nominatim
 make
 ```
 cmake ../Nominatim
 make

+sudo make install
+```
+
+!!! warning
+    The default installation no longer compiles the PostgreSQL module that
+    is needed for the legacy tokenizer from older Nominatim versions. If you
+    are upgrading an older database or want to run the
+    [legacy tokenizer](../customize/Tokenizers.md#legacy-tokenizer) for
+    some other reason, you need to enable the PostgreSQL module via
+    cmake: `cmake -DBUILD_MODULE=on ../Nominatim`. To compile the module
+    you need to have the server development headers for PostgreSQL installed.
+    On Ubuntu/Debian run: `sudo apt install postgresql-server-dev-<postgresql version>`
+
+
+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.md).
 ```
 
 Now continue with [importing the database](Import.md).