From 212b69799ce33cffac1b4cf2e5ffefc0a6f13c31 Mon Sep 17 00:00:00 2001 From: Sarah Hoffmann Date: Wed, 29 Oct 2025 11:08:42 +0100 Subject: [PATCH] adapt docs for release --- docs/admin/Installation.md | 9 ++++++--- mkdocs.yml | 2 +- vagrant/Install-on-Ubuntu-22.sh | 27 +++------------------------ vagrant/Install-on-Ubuntu-24.sh | 26 +++----------------------- 4 files changed, 13 insertions(+), 51 deletions(-) diff --git a/docs/admin/Installation.md b/docs/admin/Installation.md index 99387ed6..1b0ee994 100644 --- a/docs/admin/Installation.md +++ b/docs/admin/Installation.md @@ -110,14 +110,17 @@ Then you can install Nominatim with: pip install nominatim-db nominatim-api -## Downloading and building Nominatim +## Downloading and building Nominatim from source + +The following instructions are only relevant, if you want to build and +install Nominatim **from source**. ### Downloading the latest release 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 +### Downloading the source for the latest development version If you want to install latest development version from github: @@ -131,7 +134,7 @@ The development version does not include the country grid. Download it separatel wget -O Nominatim/data/country_osm_grid.sql.gz https://nominatim.org/data/country_grid.sql.gz ``` -### Building Nominatim +### Building Nominatim from source Nominatim is easiest to run from its own virtual environment. To create one, run: diff --git a/mkdocs.yml b/mkdocs.yml index 3fd9cd5a..3e772eb1 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,4 +1,4 @@ -site_name: Nominatim Manual +site_name: Nominatim 5.2.0 Manual theme: font: false name: material diff --git a/vagrant/Install-on-Ubuntu-22.sh b/vagrant/Install-on-Ubuntu-22.sh index 2ad337bb..f399a8e1 100755 --- a/vagrant/Install-on-Ubuntu-22.sh +++ b/vagrant/Install-on-Ubuntu-22.sh @@ -25,7 +25,7 @@ export DEBIAN_FRONTEND=noninteractive #DOCS: libbz2-dev libpq-dev liblua5.3-dev lua5.3 lua-dkjson \ nlohmann-json3-dev postgresql-14-postgis-3 \ postgresql-contrib-14 postgresql-14-postgis-3-scripts \ - libicu-dev virtualenv git + libicu-dev virtualenv # # System Configuration @@ -97,23 +97,6 @@ fi #DOCS: # Building and Configuration # -------------------------- # -# Get the source code from Github and change into the source directory -# -if [ "x$1" == "xyes" ]; then #DOCS: :::sh - cd $USERHOME - git clone https://github.com/osm-search/Nominatim.git - cd Nominatim -else #DOCS: - cd $USERHOME/Nominatim #DOCS: -fi #DOCS: - -# When installing the latest source from github, you also need to -# download the country grid: - -if [ ! -f data/country_osm_grid.sql.gz ]; then #DOCS: :::sh - wget -O data/country_osm_grid.sql.gz https://nominatim.org/data/country_grid.sql.gz -fi #DOCS: - # Nominatim needs osm2pgsql >= 1.8. The version that comes with Ubuntu is # too old. Download and compile your own: @@ -124,7 +107,6 @@ fi #DOCS: cmake ../osm2pgsql make sudo make install - cd $USERHOME/Nominatim # Nominatim should be installed in a separate Python virtual environment. # Create the virtual environment: @@ -137,8 +119,7 @@ fi #DOCS: # Now install Nominatim using pip: - cd $USERHOME/Nominatim - $USERHOME/nominatim-venv/bin/pip install packaging/nominatim-db + $USERHOME/nominatim-venv/bin/pip install nominatim-db # Nominatim is now ready to use. You can continue with # [importing a database from OSM data](../admin/Import.md). If you want to set up @@ -154,9 +135,7 @@ fi #DOCS: # To install all packages, run: #DOCS:```sh -$USERHOME/nominatim-venv/bin/pip install falcon uvicorn gunicorn -cd $USERHOME/Nominatim -$USERHOME/nominatim-venv/bin/pip install packaging/nominatim-api +$USERHOME/nominatim-venv/bin/pip install falcon uvicorn gunicorn nominatim-api #DOCS:``` diff --git a/vagrant/Install-on-Ubuntu-24.sh b/vagrant/Install-on-Ubuntu-24.sh index b15eb3d8..b1ed344d 100755 --- a/vagrant/Install-on-Ubuntu-24.sh +++ b/vagrant/Install-on-Ubuntu-24.sh @@ -21,7 +21,7 @@ export DEBIAN_FRONTEND=noninteractive #DOCS: # Now you can install all packages needed for Nominatim: sudo apt-get install -y osm2pgsql postgresql-postgis postgresql-postgis-scripts \ - pkg-config libicu-dev virtualenv git + pkg-config libicu-dev virtualenv # @@ -94,23 +94,6 @@ fi #DOCS: # Building and Configuration # -------------------------- # -# Get the source code from Github and change into the source directory -# -if [ "x$1" == "xyes" ]; then #DOCS: :::sh - cd $USERHOME - git clone https://github.com/osm-search/Nominatim.git - cd Nominatim -else #DOCS: - cd $USERHOME/Nominatim #DOCS: -fi #DOCS: - -# When installing the latest source from github, you also need to -# download the country grid: - -if [ ! -f data/country_osm_grid.sql.gz ]; then #DOCS: :::sh - wget -O data/country_osm_grid.sql.gz https://nominatim.org/data/country_grid.sql.gz -fi #DOCS: - # Nominatim should be installed in a separate Python virtual environment. # Create the virtual environment: @@ -122,8 +105,7 @@ fi #DOCS: # Now install Nominatim using pip: - cd $USERHOME/Nominatim - $USERHOME/nominatim-venv/bin/pip install packaging/nominatim-db + $USERHOME/nominatim-venv/bin/pip install nominatim-db # Nominatim is now ready to use. The nominatim binary is available at # `$USERHOME/venv/bin/nominatim`. If you want to have 'nominatim' in your @@ -147,9 +129,7 @@ fi #DOCS: # To install all packages, run: #DOCS:```sh -$USERHOME/nominatim-venv/bin/pip install falcon uvicorn gunicorn -cd $USERHOME/Nominatim -$USERHOME/nominatim-venv/bin/pip install packaging/nominatim-api +$USERHOME/nominatim-venv/bin/pip install falcon uvicorn gunicorn nominatim-api #DOCS:``` # Next you need to create a systemd job that runs Nominatim on gunicorn.