X-Git-Url: https://git.openstreetmap.org./nominatim.git/blobdiff_plain/139cea5720e3b1030ec9a10c678d723752d707f4..f535340d5af0b59c1bbdfde885b62dd483a9e38e:/docs/admin/Installation.md diff --git a/docs/admin/Installation.md b/docs/admin/Installation.md index cb0df5c1..e67371bd 100644 --- a/docs/admin/Installation.md +++ b/docs/admin/Installation.md @@ -4,8 +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: - * [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. @@ -36,19 +36,15 @@ For running Nominatim: 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: @@ -69,12 +65,14 @@ 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/) -For running the legacy PHP frontend: +For running the legacy PHP frontend (deprecated, will be removed in Nominatim 5.0): * [PHP](https://php.net) (7.3+) * PHP-pgsql @@ -162,7 +160,7 @@ Nominatim is easiest to run from its own virtual environment. To create one, run 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 @@ -196,6 +194,7 @@ sudo make install 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-` + The legacy tokenizer is deprecated and will be removed in Nominatim 5.0 Nominatim installs itself into `/usr/local` per default. To choose a different