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.
* [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
-For compiling:
+!!! 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 running Nominatim:
+
+ * [PostgreSQL](https://www.postgresql.org) (9.6+ will work, 11+ strongly recommended)
+ * [PostGIS](https://postgis.net) (2.2+ will work, 3.0+ strongly recommended)
+ * [osm2pgsql](https://osm2pgsql.org) (1.8+, optional when building with CMake)
+ * [Python 3](https://www.python.org/) (3.7+)
+
+Furthermore the following Python libraries are required:
+
+ * [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)
+
+These will be installed automatically when using pip installation.
+
+When using legacy CMake-based installation:
* [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
+ * [ICU](http://site.icu-project.org/)
+ * [nlohmann/json](https://json.nlohmann.me/)
+ * [Boost libraries](https://www.boost.org/), including system and file system
* PostgreSQL client libraries
* a recent C++ compiler (gcc 5+ or Clang 3.8+)
-For running Nominatim:
+For running continuous updates:
- * [PostgreSQL](https://www.postgresql.org) (9.3+)
- * [PostGIS](https://postgis.org) (2.2+)
- * [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)
+ * [pyosmium](https://osmcode.org/pyosmium/)
-For running continuous updates:
+For running the Python frontend:
+
+ * [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/)
- * [pyosmium](https://osmcode.org/pyosmium/) (with Python 3)
+For running the legacy PHP frontend:
-For running tests:
+ * [PHP](https://php.net) (7.3+)
+ * PHP-pgsql
+ * PHP-intl (bundled with PHP)
- * [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
-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.
-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
-at least 2 days. Without SSDs 7-8 days are more realistic.
-
-## Setup of the server
+around 2.5 days. When using traditional SSDs, 4-5 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
maintenance_work_mem = (10GB)
autovacuum_work_mem = 2GB
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
- checkpoint_timeout = 10min
+ max_wal_size = 1GB
+ checkpoint_timeout = 60min
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
-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.
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:
+## Downloading and building Nominatim
- fsync = off
- full_page_writes = off
+### Downloading the latest release
-Don't forget to reenable them after the initial import or you risk database
-corruption.
+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
-### Webserver setup
+If you want to install latest development version from github, make sure to
+also check out the osm2pgsql subproject:
-The `website/` directory in the build directory contains the configured
-website. Include the directory into your webbrowser to serve php files
-from there.
+```
+git clone --recursive https://github.com/openstreetmap/Nominatim.git
+```
-#### Configure for use with Apache
+The development version does not include the country grid. Download it separately:
-Make sure your Apache configuration contains the required permissions for the
-directory and create an alias:
+```
+wget -O Nominatim/data/country_osm_grid.sql.gz https://nominatim.org/data/country_grid.sql.gz
+```
+
+### Building Nominatim
+
+#### Building the latest development version with pip
+
+Nominatim is easiest to run from its own virtual environment. To create one, run:
+
+ sudo apt-get install virtualenv
+ virtualenv /srv/nominatim-venv
+
+To install Nominatim directly from the source tree into the virtual environment, run:
+
+ /srv/nominatim-venv/bin/pip install packaging/nominatim-{db,api}
+
+#### Building in legacy CMake mode
-``` apache
-<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
+!!! warning
+ Installing Nominatim through CMake is now deprecated. The infrastructure
+ will be removed in Nominatim 5.0. Please switch to pip installation.
+
+The code must be built in a separate directory. Create the directory and
+change into it.
+
+```
+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/`.
+!!! 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>`
-Now continue with [importing the database](Import-and-Update.md).
+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).
projects / nominatim.git / blobdiff