]> git.openstreetmap.org Git - nominatim.git/blobdiff - docs/admin/Installation.md
projects / nominatim.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
switch actions to pip-based install
[nominatim.git] / docs / admin / Installation.md
diff --git a/docs/admin/Installation.md b/docs/admin/Installation.md
index 98cfe573c6018fb088b22726d566a7da38819dad..dadbe4601238fe387c846b31b5bb29a058df97ef 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 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)
+  * [Ubuntu 24.04](Install-on-Ubuntu-24.md)
+  * [Ubuntu 22.04](Install-on-Ubuntu-22.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,64 +15,62 @@ 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
 
-For compiling:
+For running Nominatim:
 
 
-  * [cmake](https://cmake.org/)
-  * [expat](https://libexpat.github.io/)
-  * [proj](https://proj.org/)
-  * [bzip2](http://www.bzip.org/)
-  * [zlib](https://www.zlib.net/)
-  * [Boost libraries](https://www.boost.org/), including system and filesystem
-  * PostgreSQL client libraries
-  * a recent C++ compiler (gcc 5+ or Clang 3.8+)
+  * [PostgreSQL](https://www.postgresql.org) (12+ will work, 13+ strongly recommended)
+  * [PostGIS](https://postgis.net) (3.0+ will work, 3.2+ strongly recommended)
+  * [osm2pgsql](https://osm2pgsql.org) (1.8+, optional when building with CMake)
+  * [Python 3](https://www.python.org/) (3.7+)
 
 
-For running Nominatim:
+Furthermore the following Python libraries are required:
 
 
-  * [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)
-  * [PHP](https://php.net) (7.0 or later)
-  * PHP-pgsql
-  * PHP-intl (bundled with PHP)
-  * a webserver (apache or nginx are recommended)
+  * [Psycopg3](https://www.psycopg.org)
+  * [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)
 
 
-!!! 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.
+These will be installed automatically when using pip installation.
 
 For running continuous updates:
 
 
 For running continuous updates:
 
-  * [pyosmium](https://osmcode.org/pyosmium/) (with Python 3)
+  * [pyosmium](https://osmcode.org/pyosmium/)
+
+For running the Python frontend:
 
 
-For running tests:
+  * [SQLAlchemy](https://www.sqlalchemy.org/) (1.4.31+ with greenlet support)
+  * [asyncpg](https://magicstack.github.io/asyncpg) (0.8+, only when using SQLAlchemy < 2.0)
+  * one of the following web frameworks:
+    * [falcon](https://falconframework.org/) (3.0+)
+    * [starlette](https://www.starlette.io/)
+  * [uvicorn](https://www.uvicorn.org/)
 
 
-  * [behave](http://pythonhosted.org/behave/)
-  * [nose](https://nose.readthedocs.io)
-  * [phpunit](https://phpunit.de) >= 7.3
+For dependencies for running tests and building documentation, see
+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.5 days. When using traditional SSDs, 4-5 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
@@ -84,15 +80,16 @@ your `postgresql.conf` file.
     maintenance_work_mem = (10GB)
     autovacuum_work_mem = 2GB
     work_mem = (50MB)
     maintenance_work_mem = (10GB)
     autovacuum_work_mem = 2GB
     work_mem = (50MB)
-    effective_cache_size = (24GB)
     synchronous_commit = off
     synchronous_commit = off
-    checkpoint_segments = 100 # only for postgresql <= 9.4
-    max_wal_size = 1GB # postgresql > 9.4
-    checkpoint_timeout = 10min
+    max_wal_size = 1GB
+    checkpoint_timeout = 60min
     checkpoint_completion_target = 0.9
     checkpoint_completion_target = 0.9
+    random_page_cost = 1.0
+    wal_level = minimal
+    max_wal_senders = 0
 
 The numbers in brackets behind some parameters seem to work fine for
 
 The numbers in brackets behind some parameters seem to work fine for
-64GB RAM machine. Adjust to your setup. A higher number for `max_wal_size`
+128GB 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.
 
 means that PostgreSQL needs to run checkpoints less often but it does require
 the additional space on your disk.
 
@@ -105,87 +102,37 @@ you might consider setting:
 and even reduce `autovacuum_work_mem` further. This will reduce the amount
 of memory that autovacuum takes away from the import process.
 
 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:
-
-    fsync = off
-    full_page_writes = off
-
-Don't forget to reenable them after the initial import or you risk database
-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.
-
-#### Configure for use with Apache
-
-Make sure your Apache configuration contains the required permissions for the
-directory and create an alias:
-
-    <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 and building Nominatim
 
 
-`/srv/nominatim/build` should be replaced with the location of your
-build directory.
+### Downloading the latest release
 
 
-After making changes in the apache config you need to restart apache.
-The website should now be available on http://localhost/nominatim.
+You can download the [latest release from nominatim.org](https://nominatim.org/downloads/).
+The release contains all necessary files. Just unpack it.
 
 
-#### Configure for use with Nginx
+### Downloading the latest development version
 
 
-Use php-fpm as a deamon for serving PHP cgi. Install php-fpm together with nginx.
+If you want to install latest development version from github:
 
 
-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:
+```
+git clone https://github.com/osm-search/Nominatim.git
+```
 
 
-    ; Comment out the tcp listener and add the unix socket
-    ;listen = 127.0.0.1:9000
-    listen = /var/run/php5-fpm.sock
+The development version does not include the country grid. Download it separately:
 
 
-    ; Ensure that the daemon runs as the correct user
-    listen.owner = www-data
-    listen.group = www-data
-    listen.mode = 0666
+```
+wget -O Nominatim/data/country_osm_grid.sql.gz https://nominatim.org/data/country_grid.sql.gz
+```
 
 
-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.
+### Building Nominatim
 
 
-    root /srv/nominatim/build/website;
-    index search.php;
-    location / {
-        try_files $uri $uri/ @php;
-    }
+Nominatim is easiest to run from its own virtual environment. To create one, run:
 
 
-    location @php {
-        fastcgi_param SCRIPT_FILENAME "$document_root$uri.php";
-        fastcgi_param PATH_TRANSLATED "$document_root$uri.php";
-        fastcgi_param QUERY_STRING    $args;
-        fastcgi_pass unix:/var/run/php/php7.3-fpm.sock;
-        fastcgi_index index.php;
-        include fastcgi_params;
-    }
+    sudo apt-get install virtualenv
+    virtualenv /srv/nominatim-venv
 
 
-    location ~ [^/]\.php(/|$) {
-        fastcgi_split_path_info ^(.+?\.php)(/.*)$;
-        if (!-f $document_root$fastcgi_script_name) {
-            return 404;
-        }
-        fastcgi_pass unix:/var/run/php7.3-fpm.sock;
-        fastcgi_index search.php;
-        include fastcgi.conf;
-    }
+To install Nominatim directly from the source tree into the virtual environment, run:
 
 
-Restart the nginx and php5-fpm services and the website should now be available
-at `http://localhost/`.
+    /srv/nominatim-venv/bin/pip install packaging/nominatim-{db,api}
 
 
 
 
-Now continue with [importing the database](Import-and-Update.md).
+Now continue with [importing the database](Import.md).
Open Source search based on OpenStreetMap data