X-Git-Url: https://git.openstreetmap.org./nominatim.git/blobdiff_plain/d89000cc3de6ecdca64e87c05836f6d4cc25b7d1..9934421442bf1a815096ef06ffa3f8c9ea11c0ac:/docs/admin/Installation.md diff --git a/docs/admin/Installation.md b/docs/admin/Installation.md index cf994c4c..2ae594ba 100644 --- a/docs/admin/Installation.md +++ b/docs/admin/Installation.md @@ -17,12 +17,17 @@ and can't offer support. * [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 +!!! 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/) @@ -30,30 +35,34 @@ For compiling: * [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: - * [PostgreSQL](https://www.postgresql.org) (9.3+) - * [PostGIS](https://postgis.org) (2.2+) - * [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) - * a webserver (apache or nginx are recommended) + * PHP-cgi (for running queries from the command line) 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) >= 7.3 +For dependencies for running tests and building documentation, see +the [Development section](../develop/Development-Environment.md). ### Hardware @@ -61,16 +70,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. -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 -at least 2 days. Without SSDs 7-8 days are more realistic. - -## Setup of the server +around 2 days. On traditional spinning disks, 7-8 days are more realistic. -### 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 @@ -110,82 +117,54 @@ Don't forget to reenable them after the initial import or you risk database corruption. -### Webserver setup +## Downloading and building Nominatim + +### Downloading the latest release + +You can download the [latest release from nominatim.org](https://nominatim.org/downloads/). +The release contains all necessary files. Just unpack it. + +### Downloading the latest development version + +If you want to install latest development version from github, make sure to +also check out the osm2pgsql subproject: + +``` +git clone --recursive git://github.com/openstreetmap/Nominatim.git +``` + +The development version does not include the country grid. Download it separately: -The `website/` directory in the build directory contains the configured -website. Include the directory into your webbrowser to serve php files -from there. +``` +wget -O Nominatim/data/country_osm_grid.sql.gz https://www.nominatim.org/data/country_grid.sql.gz +``` -#### Configure for use with Apache +### Building Nominatim -Make sure your Apache configuration contains the required permissions for the -directory and create an alias: +The code must be built in a separate directory. Create the directory and +change into it. -``` apache - - Options FollowSymLinks MultiViews - AddType text/html .php - DirectoryIndex search.php - Require all granted - -Alias /nominatim /srv/nominatim/build/website +``` +mkdir build +cd build ``` -`/srv/nominatim/build` should be replaced with the location of your -build directory. - -After making changes in the apache config you need to restart apache. -The website should now be available on http://localhost/nominatim. - -#### Configure for use with Nginx - -Use php-fpm as a deamon for serving PHP cgi. Install php-fpm together with nginx. - -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: - - ; Comment out the tcp listener and add the unix socket - ;listen = 127.0.0.1:9000 - listen = /var/run/php5-fpm.sock - - ; Ensure that the daemon runs as the correct user - listen.owner = www-data - listen.group = www-data - listen.mode = 0666 - -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. - -``` nginx -root /srv/nominatim/build/website; -index search.php; -location / { - try_files $uri $uri/ @php; -} - -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; -} - -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; -} +Nominatim uses cmake and make for building. Assuming that you have created the +build at the same level as the Nominatim source directory run: + +``` +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=` to the +cmake command. Make sure that the `bin` directory is available in your path +in that case, e.g. +``` +export PATH=/bin:$PATH +``` -Now continue with [importing the database](Import-and-Update.md). +Now continue with [importing the database](Import.md).