]> git.openstreetmap.org Git - nominatim.git/blob - vagrant/Install-on-Ubuntu-24.sh
Merge pull request #3517 from lonvia/improve-custom-formatter
[nominatim.git] / vagrant / Install-on-Ubuntu-24.sh
1 #!/bin/bash -e
2 #
3 # hacks for broken vagrant box      #DOCS:
4 sudo rm -f /var/lib/dpkg/lock       #DOCS:
5 export APT_LISTCHANGES_FRONTEND=none #DOCS:
6 export DEBIAN_FRONTEND=noninteractive #DOCS:
7
8 # *Note:* these installation instructions are also available in executable
9 #         form for use with vagrant under vagrant/Install-on-Ubuntu-24.sh.
10 #
11 # Installing the Required Software
12 # ================================
13 #
14 # These instructions expect that you have a freshly installed Ubuntu 24.04.
15 #
16 # Make sure all packages are up-to-date by running:
17 #
18
19     sudo apt-get update -qq
20
21 # Now you can install all packages needed for Nominatim:
22
23     sudo apt-get install -y osm2pgsql postgresql-postgis postgresql-postgis-scripts \
24                             pkg-config libicu-dev virtualenv git
25
26
27 #
28 # System Configuration
29 # ====================
30 #
31 # The following steps are meant to configure a fresh Ubuntu installation
32 # for use with Nominatim. You may skip some of the steps if you have your
33 # OS already configured.
34 #
35 # Creating Dedicated User Accounts
36 # --------------------------------
37 #
38 # Nominatim will run as a global service on your machine. It is therefore
39 # best to install it under its own separate user account. In the following
40 # we assume this user is called nominatim and the installation will be in
41 # /srv/nominatim. To create the user and directory run:
42 #
43 #     sudo useradd -d /srv/nominatim -s /bin/bash -m nominatim
44 #
45 # You may find a more suitable location if you wish.
46 #
47 # The following instructions assume you are logged in as this user.
48 # You can also switch to the user with:
49 #
50 #     sudo -u nominatim bash
51 #
52 # To be able to copy and paste instructions from this manual, export
53 # user name and home directory now like this:
54 #
55 if [ "x$USERNAME" == "x" ]; then #DOCS:
56     export USERNAME=vagrant        #DOCS:    export USERNAME=nominatim
57     export USERHOME=/home/vagrant  #DOCS:    export USERHOME=/srv/nominatim
58 fi                                 #DOCS:
59 #
60 # **Never, ever run the installation as a root user.** You have been warned.
61 #
62 # Make sure that system servers can read from the home directory:
63
64     chmod a+x $USERHOME
65
66 # Setting up PostgreSQL
67 # ---------------------
68 #
69 # Tune the postgresql configuration, which is located in 
70 # `/etc/postgresql/16/main/postgresql.conf`. See section *Tuning the PostgreSQL database*
71 # in [the installation page](../admin/Installation.md#tuning-the-postgresql-database)
72 # for the parameters to change.
73 #
74 # Restart the postgresql service after updating this config file.
75
76 if [ "x$NOSYSTEMD" == "xyes" ]; then  #DOCS:
77     sudo pg_ctlcluster 16 main start  #DOCS:
78 else                                  #DOCS:
79     sudo systemctl restart postgresql
80 fi                                    #DOCS:
81 #
82 # Finally, we need to add two postgres users: one for the user that does
83 # the import and another for the webserver which should access the database
84 # for reading only:
85 #
86
87     sudo -u postgres createuser -s $USERNAME
88     sudo -u postgres createuser www-data
89
90 #
91 # Installing Nominatim
92 # ====================
93 #
94 # Building and Configuration
95 # --------------------------
96 #
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
114 # Nominatim should be installed in a separate Python virtual environment.
115 # Create the virtual environment:
116
117     virtualenv $USERHOME/nominatim-venv
118
119 # Now install Nominatim using pip:
120
121     cd $USERHOME/Nominatim
122     $USERHOME/nominatim-venv/bin/pip install packaging/nominatim-db
123
124 # Nominatim is now ready to use. The nominatim binary is available at
125 # `$USERHOME/venv/bin/nominatim`. If you want to have 'nominatim' in your
126 # path, simply activate the virtual environment:
127 #
128 #DOCS:```sh
129 # . $USERHOME/nominatim-venv/bin/activate
130 #DOCS:```
131 #
132 # You can continue with
133 # [importing a database from OSM data](../admin/Import.md). If you want to set up
134 # the API frontend first, continue reading.
135 #
136 # Setting up the Python frontend
137 # ==============================
138 #
139 # The Python frontend is contained in the nominatim-api package. To run
140 # the API as a webservice, you also need falcon with uvicorn to serve the API.
141 # It is generally recommended to run falcon/uvicorn on top of gunicorn.
142 #
143 # To install all packages, run:
144
145 #DOCS:```sh
146 $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
149 #DOCS:```
150
151 # Next you need to create a systemd job that runs Nominatim on gunicorn.
152 # First create a systemd job that manages the socket file:
153
154 #DOCS:```sh
155 sudo tee /etc/systemd/system/nominatim.socket << EOFSOCKETSYSTEMD
156 [Unit]
157 Description=Gunicorn socket for Nominatim
158
159 [Socket]
160 ListenStream=/run/nominatim.sock
161 SocketUser=www-data
162
163 [Install]
164 WantedBy=multi-user.target
165 EOFSOCKETSYSTEMD
166 #DOCS:```
167
168 # Then create the service for Nominatim itself.
169
170 #DOCS:```sh
171 sudo tee /etc/systemd/system/nominatim.service << EOFNOMINATIMSYSTEMD
172 [Unit]
173 Description=Nominatim running as a gunicorn application
174 After=network.target
175 Requires=nominatim.socket
176
177 [Service]
178 Type=simple
179 User=www-data
180 Group=www-data
181 WorkingDirectory=$USERHOME/nominatim-project
182 ExecStart=$USERHOME/nominatim-venv/bin/gunicorn -b unix:/run/nominatim.sock -w 4 -k uvicorn.workers.UvicornWorker nominatim_api.server.falcon.server:run_wsgi
183 ExecReload=/bin/kill -s HUP \$MAINPID
184 StandardOutput=append:/var/log/gunicorn-nominatim.log
185 StandardError=inherit
186 PrivateTmp=true
187 TimeoutStopSec=5
188 KillMode=mixed
189
190 [Install]
191 WantedBy=multi-user.target
192 EOFNOMINATIMSYSTEMD
193 #DOCS:```
194
195 # Activate the services:
196
197 if [ "x$NOSYSTEMD" != "xyes" ]; then  #DOCS:
198     sudo systemctl daemon-reload
199     sudo systemctl enable nominatim.socket
200     sudo systemctl start nominatim.socket
201     sudo systemctl enable nominatim.service
202 fi                                    #DOCS:
203
204 # Setting up a webserver
205 # ======================
206 #
207 # The webserver is only needed as a proxy between the public interface
208 # and the gunicorn service.
209 #
210 # The frontend will need configuration information from the project
211 # directory, which will be populated later
212 # [during the import process](../admin/Import.md#creating-the-project-directory)
213 # Already create the project directory itself now:
214
215     mkdir $USERHOME/nominatim-project
216
217 #
218 # Option 1: Using Apache
219 # ----------------------
220 #
221 if [ "x$2" == "xinstall-apache" ]; then #DOCS:
222 #
223 # First install apache itself and enable the proxy module:
224
225     sudo apt-get install -y apache2
226     sudo a2enmod proxy_http
227
228 #
229 # To set up proxying for Apache add the following configuration:
230
231 #DOCS:```sh
232 sudo tee /etc/apache2/conf-available/nominatim.conf << EOFAPACHECONF
233
234 ProxyPass /nominatim "unix:/run/nominatim.sock|http://localhost/"
235 EOFAPACHECONF
236 #DOCS:```
237
238 #
239 # Then enable the configuration and restart apache
240 #
241
242 #DOCS:```sh
243 sudo a2enconf nominatim
244 #DOCS:```
245
246 if [ "x$NOSYSTEMD" == "xyes" ]; then  #DOCS:
247     sudo apache2ctl start             #DOCS:
248 else                                  #DOCS:
249     sudo systemctl restart apache2
250 fi                                    #DOCS:
251
252 # The Nominatim API is now available at `http://localhost/nominatim/`. Point your browser
253 # to the status output `http://localhost/nominatim/status` to test if everything is ok.
254
255 fi   #DOCS:
256
257 #
258 # Option 2: Using nginx
259 # ---------------------
260 #
261 if [ "x$2" == "xinstall-nginx" ]; then #DOCS:
262
263 # First install nginx itself:
264
265     sudo apt-get install -y nginx
266
267
268 # Then create a Nginx configuration to forward http requests to that socket.
269
270 #DOCS:```sh
271 sudo tee /etc/nginx/sites-available/default << EOF_NGINX_CONF
272 server {
273     listen 80 default_server;
274     listen [::]:80 default_server;
275
276     root $USERHOME/nominatim-project/website;
277     index /search;
278
279     location /nominatim/ {
280             proxy_set_header Host \$http_host;
281             proxy_set_header X-Forwarded-For \$proxy_add_x_forwarded_for;
282             proxy_set_header X-Forwarded-Proto \$scheme;
283             proxy_redirect off;
284             proxy_pass http://unix:/run/nominatim.sock:/;
285     }
286 }
287 EOF_NGINX_CONF
288 #DOCS:```
289
290 # Enable the configuration and restart Nginx
291 #
292
293 if [ "x$NOSYSTEMD" == "xyes" ]; then  #DOCS:
294     sudo /usr/sbin/nginx &            #DOCS:
295 else                                  #DOCS:
296     sudo systemctl restart nginx
297 fi                                    #DOCS:
298
299 # The Nominatim API is now available at `http://localhost/nominatim/`. Point your browser
300 # to the status output `http://localhost/nominatim/status` to test if everything is ok.
301
302 fi   #DOCS: