CI: make type checking strict

[nominatim.git] / vagrant / Install-on-Ubuntu-20.sh

diff --git a/vagrant/Install-on-Ubuntu-20.sh b/vagrant/Install-on-Ubuntu-20.sh
old mode 100644 (file)
new mode 100755 (executable)
index b182ecf..365f609
--- a/vagrant/Install-on-Ubuntu-20.sh
+++ b/vagrant/Install-on-Ubuntu-20.sh
@@ -1,8 +1,7 @@
-#!/bin/bash
+#!/bin/bash -e

 #
 # hacks for broken vagrant box      #DOCS:
 sudo rm -f /var/lib/dpkg/lock       #DOCS:
 #
 # hacks for broken vagrant box      #DOCS:
 sudo rm -f /var/lib/dpkg/lock       #DOCS:

-sudo update-locale LANG=en_US.UTF-8 #DOCS:

 export APT_LISTCHANGES_FRONTEND=none #DOCS:
 export DEBIAN_FRONTEND=noninteractive #DOCS:
 
 export APT_LISTCHANGES_FRONTEND=none #DOCS:
 export DEBIAN_FRONTEND=noninteractive #DOCS:
 


@@ -14,14 +13,9 @@ export DEBIAN_FRONTEND=noninteractive #DOCS:
 #
 # These instructions expect that you have a freshly installed Ubuntu 20.04.
 #
 #
 # These instructions expect that you have a freshly installed Ubuntu 20.04.
 #

-# Make sure all packages are are up-to-date by running:
+# Make sure all packages are up-to-date by running:

 #
 
 #
 

-#DOCS:    :::sh
-    sudo apt-get \ #DOCS:
-        -o DPkg::options::="--force-confdef" -o DPkg::options::="--force-confold" \ #DOCS:
-        --allow-downgrades --allow-remove-essential --allow-change-held-packages \ #DOCS:
-        -fuy install grub-pc #DOCS:

     sudo apt update -qq
 
 # Now you can install all packages needed for Nominatim:
     sudo apt update -qq
 
 # Now you can install all packages needed for Nominatim:


@@ -30,10 +24,16 @@ export DEBIAN_FRONTEND=noninteractive #DOCS:
     sudo apt install -y build-essential cmake g++ libboost-dev libboost-system-dev \
                         libboost-filesystem-dev libexpat1-dev zlib1g-dev \
                         libbz2-dev libpq-dev libproj-dev \
     sudo apt install -y build-essential cmake g++ libboost-dev libboost-system-dev \
                         libboost-filesystem-dev libexpat1-dev zlib1g-dev \
                         libbz2-dev libpq-dev libproj-dev \

-                        postgresql-server-dev-12 postgresql-12-postgis-3 \
-                        postgresql-contrib postgresql-12-postgis-3-scripts \
-                        php php-pgsql php-intl \
-                        python3-psycopg2 git
+                        postgresql-12-postgis-3 \
+                        postgresql-contrib-12 postgresql-12-postgis-3-scripts \
+                        php php-pgsql php-intl libicu-dev python3-dotenv \
+                        python3-psycopg2 python3-psutil python3-jinja2 \
+                        python3-icu python3-datrie python3-yaml python3-pip git
+
+# Nominatim uses some typing features only available in later Python versions.
+# Install the latest version of the backport package:
+
+    pip3 install --user typing-extensions

 
 #
 # System Configuration
 
 #
 # System Configuration


@@ -58,8 +58,10 @@ export DEBIAN_FRONTEND=noninteractive #DOCS:
 # To be able to copy and paste instructions from this manual, export
 # user name and home directory now like this:
 #
 # To be able to copy and paste instructions from this manual, export
 # user name and home directory now like this:
 #

+if [ "x$USERNAME" == "x" ]; then #DOCS:

     export USERNAME=vagrant        #DOCS:    export USERNAME=nominatim
     export USERHOME=/home/vagrant  #DOCS:    export USERHOME=/srv/nominatim
     export USERNAME=vagrant        #DOCS:    export USERNAME=nominatim
     export USERHOME=/home/vagrant  #DOCS:    export USERHOME=/srv/nominatim

+fi                                 #DOCS:

 #
 # **Never, ever run the installation as a root user.** You have been warned.
 #
 #
 # **Never, ever run the installation as a root user.** You have been warned.
 #


@@ -77,8 +79,11 @@ export DEBIAN_FRONTEND=noninteractive #DOCS:
 #
 # Restart the postgresql service after updating this config file.
 
 #
 # Restart the postgresql service after updating this config file.
 

+if [ "x$NOSYSTEMD" == "xyes" ]; then  #DOCS:
+    sudo pg_ctlcluster 12 main start  #DOCS:
+else                                  #DOCS:

     sudo systemctl restart postgresql
     sudo systemctl restart postgresql

-
+fi                                    #DOCS:

 #
 # Finally, we need to add two postgres users: one for the user that does
 # the import and another for the webserver which should access the database
 #
 # Finally, we need to add two postgres users: one for the user that does
 # the import and another for the webserver which should access the database


@@ -99,7 +104,7 @@ export DEBIAN_FRONTEND=noninteractive #DOCS:
 #
 if [ "x$1" == "xyes" ]; then  #DOCS:    :::sh
     cd $USERHOME
 #
 if [ "x$1" == "xyes" ]; then  #DOCS:    :::sh
     cd $USERHOME

-    git clone --recursive git://github.com/openstreetmap/Nominatim.git
+    git clone --recursive https://github.com/openstreetmap/Nominatim.git

     cd Nominatim
 else                               #DOCS:
     cd $USERHOME/Nominatim         #DOCS:
     cd Nominatim
 else                               #DOCS:
     cd $USERHOME/Nominatim         #DOCS:


@@ -115,11 +120,11 @@ fi                                 #DOCS:
 # The code must be built in a separate directory. Create this directory,
 # then configure and build Nominatim in there:
 
 # The code must be built in a separate directory. Create this directory,
 # then configure and build Nominatim in there:
 

-    cd $USERHOME
-    mkdir build
-    cd build
+    mkdir $USERHOME/build
+    cd $USERHOME/build

     cmake $USERHOME/Nominatim
     make
     cmake $USERHOME/Nominatim
     make

+    sudo make install

 
 # 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
 
 # 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


@@ -127,6 +132,17 @@ fi                                 #DOCS:
 #
 # Setting up a webserver
 # ======================
 #
 # Setting up a webserver
 # ======================

+#
+# The webserver should serve the php scripts from the website directory of your
+# [project directory](../admin/Import.md#creating-the-project-directory).
+# This directory needs to exist when being configured.
+# Therefore set up a project directory and create a website directory:
+
+    mkdir $USERHOME/nominatim-project
+    mkdir $USERHOME/nominatim-project/website
+
+# The import process will populate the directory later.
+

 #
 # Option 1: Using Apache
 # ----------------------
 #
 # Option 1: Using Apache
 # ----------------------


@@ -143,14 +159,14 @@ if [ "x$2" == "xinstall-apache" ]; then #DOCS:
 
 #DOCS:```sh
 sudo tee /etc/apache2/conf-available/nominatim.conf << EOFAPACHECONF
 
 #DOCS:```sh
 sudo tee /etc/apache2/conf-available/nominatim.conf << EOFAPACHECONF

-<Directory "$USERHOME/build/website">
+<Directory "$USERHOME/nominatim-project/website">

   Options FollowSymLinks MultiViews
   AddType text/html   .php
   DirectoryIndex search.php
   Require all granted
 </Directory>
 
   Options FollowSymLinks MultiViews
   AddType text/html   .php
   DirectoryIndex search.php
   Require all granted
 </Directory>
 

-Alias /nominatim $USERHOME/build/website
+Alias /nominatim $USERHOME/nominatim-project/website

 EOFAPACHECONF
 #DOCS:```
 
 EOFAPACHECONF
 #DOCS:```
 


@@ -159,17 +175,11 @@ EOFAPACHECONF
 #
 
     sudo a2enconf nominatim
 #
 
     sudo a2enconf nominatim

+if [ "x$NOSYSTEMD" == "xyes" ]; then  #DOCS:
+    sudo apache2ctl start             #DOCS:
+else                                  #DOCS:

     sudo systemctl restart apache2
     sudo systemctl restart apache2

-
-# You need to create a minimal configuration file that tells nominatim
-# where it is located on the webserver:
-
-#DOCS:```sh
-tee settings/local.php << EOF
-<?php
- @define('CONST_Website_BaseURL', '/nominatim/');
-EOF
-#DOCS:```
+fi                                    #DOCS:

 
 # The Nominatim API is now available at `http://localhost/nominatim/`.
 
 
 # The Nominatim API is now available at `http://localhost/nominatim/`.
 


@@ -217,7 +227,7 @@ server {
     listen 80 default_server;
     listen [::]:80 default_server;
 
     listen 80 default_server;
     listen [::]:80 default_server;
 

-    root $USERHOME/build/website;
+    root $USERHOME/nominatim-project/website;

     index search.php index.html;
     location / {
         try_files \$uri \$uri/ @php;
     index search.php index.html;
     location / {
         try_files \$uri \$uri/ @php;


@@ -245,11 +255,19 @@ server {
 EOF_NGINX_CONF
 #DOCS:```
 
 EOF_NGINX_CONF
 #DOCS:```
 

+# If you have some errors, make sure that php7.4-fpm.sock is well under
+# /var/run/ and not under /var/run/php. Otherwise change the Nginx configuration
+# to /var/run/php/php7.4-fpm.sock.

 #
 # Enable the configuration and restart Nginx
 #
 
 #
 # Enable the configuration and restart Nginx
 #
 

+if [ "x$NOSYSTEMD" == "xyes" ]; then  #DOCS:
+    sudo /usr/sbin/php-fpm7.4 --nodaemonize --fpm-config /etc/php/7.4/fpm/php-fpm.conf & #DOCS:
+    sudo /usr/sbin/nginx &            #DOCS:
+else                                  #DOCS:

     sudo systemctl restart php7.4-fpm nginx
     sudo systemctl restart php7.4-fpm nginx

+fi                                    #DOCS:

 
 # The Nominatim API is now available at `http://localhost/`.
 
 
 # The Nominatim API is now available at `http://localhost/`.