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 18.04](../appendix/Install-on-Ubuntu-18.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.
### 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:
+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/)
- * [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+)
+ * [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.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.6+)
- * [Psycopg2](https://www.psycopg.org) (2.7+)
+ * [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)
- * [PHP](https://php.net) (7.0 or later)
- * PHP-pgsql
- * PHP-intl (bundled with PHP)
- * PHP-cgi (for running queries from the command line)
+
+These will be installed automatically when using pip installation.
For running continuous updates:
* [pyosmium](https://osmcode.org/pyosmium/)
-For running the experimental Python frontend:
+For running the Python frontend:
- * [SQLAlchemy](https://www.sqlalchemy.org/) (1.4+ with greenlet support)
+ * [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+)
- * [sanic](https://sanic.dev)
* [starlette](https://www.starlette.io/)
- * [uvicorn](https://www.uvicorn.org/) (only with falcon and starlette framworks)
+ * [uvicorn](https://www.uvicorn.org/)
For dependencies for running tests and building documentation, see
the [Development section](../develop/Development-Environment.md).
Fast disks are essential. Using NVME disks is recommended.
Even on a well configured machine the import of a full planet takes
-around 2 days. On traditional spinning disks, 7-8 days are more realistic.
+around 2.5 days. When using traditional SSDs, 4-5 days are more realistic.
## Tuning the PostgreSQL database
maintenance_work_mem = (10GB)
autovacuum_work_mem = 2GB
work_mem = (50MB)
- effective_cache_size = (24GB)
synchronous_commit = off
max_wal_size = 1GB
- checkpoint_timeout = 10min
+ 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:
-
- fsync = off
- full_page_writes = off
-
-Don't forget to re-enable them after the initial import or you risk database
-corruption.
-
-
## Downloading and building Nominatim
### Downloading the latest release
### Downloading the latest development version
-If you want to install latest development version from github, make sure to
-also check out the osm2pgsql subproject:
+If you want to install latest development version from github:
```
-git clone --recursive https://github.com/openstreetmap/Nominatim.git
+git clone https://github.com/osm-search/Nominatim.git
```
The development version does not include the country grid. Download it separately:
### Building Nominatim
-The code must be built in a separate directory. Create the directory and
-change into it.
+Nominatim is easiest to run from its own virtual environment. To create one, run:
-```
-mkdir build
-cd build
-```
-
-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
-```
-
-!!! 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>`
+ sudo apt-get install virtualenv
+ virtualenv /srv/nominatim-venv
+To install Nominatim directly from the source tree into the virtual environment, run:
-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.
+ /srv/nominatim-venv/bin/pip install packaging/nominatim-{db,api}
-```
-export PATH=<install root>/bin:$PATH
-```
Now continue with [importing the database](Import.md).
projects / nominatim.git / blobdiff