Skip to content

Commit 7683863

Browse files
committed
adapt docs for release
1 parent 3734f1d commit 7683863

File tree

4 files changed

+19
-40
lines changed

4 files changed

+19
-40
lines changed

docs/admin/Installation.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -131,9 +131,12 @@ of memory that autovacuum takes away from the import process.
131131

132132
### Downloading the latest release
133133

134-
You can download the [latest release from nominatim.org](https://nominatim.org/downloads/).
134+
If you want to build Nominatim from source, then
135+
you can download the [latest release from nominatim.org](https://nominatim.org/downloads/).
135136
The release contains all necessary files. Just unpack it.
136137

138+
Note that you don't need to do this when you install Nominatim from pip directly.
139+
137140
### Downloading the latest development version
138141

139142
If you want to install latest development version from github, make sure to
@@ -151,23 +154,25 @@ wget -O Nominatim/data/country_osm_grid.sql.gz https://nominatim.org/data/countr
151154

152155
### Building Nominatim
153156

154-
#### Building the latest development version with pip
157+
#### Building the latest release version with pip
155158

156159
Nominatim is easiest to run from its own virtual environment. To create one, run:
157160

158161
sudo apt-get install virtualenv
159162
virtualenv /srv/nominatim-venv
160163

161-
To install Nominatim directly from the source tree into the virtual environment, run:
164+
To install the latest release of Nominatim into the virtual environment, run:
162165

163-
/srv/nominatim-venv/bin/pip install packaging/nominatim-{db,api}
166+
/srv/nominatim-venv/bin/pip install nominatim-db nominatim-api
164167

165168
#### Building in legacy CMake mode
166169

167170
!!! warning
168171
Installing Nominatim through CMake is now deprecated. The infrastructure
169172
will be removed in Nominatim 5.0. Please switch to pip installation.
170173

174+
To build Nominatim with CMake, you need to download and unpack the source code
175+
as described above.
171176
The code must be built in a separate directory. Create the directory and
172177
change into it.
173178

mkdocs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
site_name: Nominatim Manual
1+
site_name: Nominatim 4.5.0 Manual
22
theme:
33
font: false
44
name: material

vagrant/Install-on-Ubuntu-22.sh

Lines changed: 5 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ export DEBIAN_FRONTEND=noninteractive #DOCS:
2828
libicu-dev python3-dotenv \
2929
python3-pip python3-psutil python3-jinja2 \
3030
python3-sqlalchemy python3-asyncpg \
31-
python3-icu python3-datrie python3-yaml git
31+
python3-icu python3-datrie python3-yaml
3232

3333
# Some of the Python packages that come with Ubuntu 22.04 are too old,
3434
# so install the latest version from pip:
@@ -105,29 +105,22 @@ fi #DOCS:
105105
# Building and Configuration
106106
# --------------------------
107107
#
108-
# Get the source code from Github and change into the source directory
108+
# Get the source code from the Nominatim website and unpack it
109109
#
110110
if [ "x$1" == "xyes" ]; then #DOCS: :::sh
111111
cd $USERHOME
112-
git clone --recursive https://github.com/openstreetmap/Nominatim.git
113-
cd Nominatim
112+
wget https://nominatim.org/release/Nominatim-4.5.0.tar.bz2
113+
tar xf Nominatim-4.5.0.tar.bz2
114114
else #DOCS:
115115
cd $USERHOME/Nominatim #DOCS:
116116
fi #DOCS:
117117

118-
# When installing the latest source from github, you also need to
119-
# download the country grid:
120-
121-
if [ ! -f data/country_osm_grid.sql.gz ]; then #DOCS: :::sh
122-
wget -O data/country_osm_grid.sql.gz https://nominatim.org/data/country_grid.sql.gz
123-
fi #DOCS:
124-
125118
# The code must be built in a separate directory. Create this directory,
126119
# then configure and build Nominatim in there:
127120

128121
mkdir $USERHOME/build
129122
cd $USERHOME/build
130-
cmake $USERHOME/Nominatim
123+
cmake $USERHOME/Nominatim-4.5.0
131124
make
132125
sudo make install
133126

vagrant/Install-on-Ubuntu-24.sh

Lines changed: 4 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ export DEBIAN_FRONTEND=noninteractive #DOCS:
2121
# Now you can install all packages needed for Nominatim:
2222

2323
sudo apt-get install -y osm2pgsql postgresql-postgis postgresql-postgis-scripts \
24-
pkg-config libicu-dev virtualenv git
24+
pkg-config libicu-dev virtualenv python3-pip
2525

2626

2727
#
@@ -94,32 +94,14 @@ fi #DOCS:
9494
# Building and Configuration
9595
# --------------------------
9696
#
97-
# Get the source code from Github and change into the source directory
98-
#
99-
if [ "x$1" == "xyes" ]; then #DOCS: :::sh
100-
cd $USERHOME
101-
git clone https://github.com/openstreetmap/Nominatim.git
102-
cd Nominatim
103-
else #DOCS:
104-
cd $USERHOME/Nominatim #DOCS:
105-
fi #DOCS:
106-
107-
# When installing the latest source from github, you also need to
108-
# download the country grid:
109-
110-
if [ ! -f data/country_osm_grid.sql.gz ]; then #DOCS: :::sh
111-
wget -O data/country_osm_grid.sql.gz https://nominatim.org/data/country_grid.sql.gz
112-
fi #DOCS:
113-
11497
# Nominatim should be installed in a separate Python virtual environment.
11598
# Create the virtual environment:
11699

117100
virtualenv $USERHOME/nominatim-venv
118101

119-
# Now install Nominatim using pip:
102+
# Now you can install the lastest version of Nominatim using pip:
120103

121-
cd $USERHOME/Nominatim
122-
$USERHOME/nominatim-venv/bin/pip install packaging/nominatim-db
104+
$USERHOME/nominatim-venv/bin/pip install nominatim-db
123105

124106
# Nominatim is now ready to use. The nominatim binary is available at
125107
# `$USERHOME/venv/bin/nominatim`. If you want to have 'nominatim' in your
@@ -144,8 +126,7 @@ fi #DOCS:
144126

145127
#DOCS:```sh
146128
$USERHOME/nominatim-venv/bin/pip install psycopg[binary] falcon uvicorn gunicorn
147-
cd $USERHOME/Nominatim
148-
$USERHOME/nominatim-venv/bin/pip install packaging/nominatim-api
129+
$USERHOME/nominatim-venv/bin/pip install nominatim-api
149130
#DOCS:```
150131

151132
# Next you need to create a systemd job that runs Nominatim on gunicorn.

0 commit comments

Comments
 (0)