X-Git-Url: https://git.openstreetmap.org./nominatim.git/blobdiff_plain/7282d816c8d70fa70e199ec8e4b5b679fbaa1caa..a894e0f3a49c1789814777ac4520baf202d404ab:/docs/admin/Installation.md?ds=sidebyside diff --git a/docs/admin/Installation.md b/docs/admin/Installation.md index cd561718..d8374399 100644 --- a/docs/admin/Installation.md +++ b/docs/admin/Installation.md @@ -22,16 +22,11 @@ and can't offer support. ### 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) - * [osm2pgsql](https://osm2pgsql.org) (1.8+, optional when building with CMake) + * [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+) * [Python 3](https://www.python.org/) (3.7+) Furthermore the following Python libraries are required: @@ -46,19 +41,6 @@ Furthermore the following Python libraries are required: 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/) - * [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 continuous updates: * [pyosmium](https://osmcode.org/pyosmium/) @@ -72,13 +54,6 @@ For running the Python frontend: * [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). @@ -127,6 +102,15 @@ you might consider setting: and even reduce `autovacuum_work_mem` further. This will reduce the amount of memory that autovacuum takes away from the import process. +## Installing the latest release + +Nominatim is easiest installed directly from Pypi. Make sure you have installed +osm2pgsql, PostgreSQL/PostGIS and libICU together with its header files. + +Then you can install Nominatim with: + + pip install nominatim-db nominatim-api + ## Downloading and building Nominatim ### Downloading the latest release @@ -136,11 +120,10 @@ 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: +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: @@ -151,8 +134,6 @@ wget -O Nominatim/data/country_osm_grid.sql.gz https://nominatim.org/data/countr ### 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 @@ -162,47 +143,5 @@ To install Nominatim directly from the source tree into the virtual environment, /srv/nominatim-venv/bin/pip install packaging/nominatim-{db,api} -#### Building in legacy CMake mode - -!!! 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 -``` - -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-` - - -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.md).