prerequisites. There are also step-by-step instructions available for
the following operating systems:
- * [Ubuntu 24.04](../appendix/Install-on-Ubuntu-24.md)
- * [Ubuntu 22.04](../appendix/Install-on-Ubuntu-22.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 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)
+ * [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+)
Furthermore the following Python libraries are required:
- * [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/)
- * [SQLAlchemy](https://www.sqlalchemy.org/) (1.4.31+ with greenlet support)
- * one of
- * [psycopg3](https://www.psycopg.org)
- * [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)
-These will be installed automatically, when using pip installation.
+These will be installed automatically when using pip installation.
When using legacy CMake-based installation:
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/)
-For running the legacy PHP frontend:
-
- * [PHP](https://php.net) (7.3+)
- * PHP-pgsql
- * PHP-intl (bundled with PHP)
-
-
For dependencies for running tests and building documentation, see
the [Development section](../develop/Development-Environment.md).
To install Nominatim directly from the source tree into the virtual environment, run:
- /srv/nominatim-venv/bin/pip install packaging/nominatim-{core,db,api}
+ /srv/nominatim-venv/bin/pip install packaging/nominatim-{db,api}
#### Building in legacy CMake mode
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