add unit tests for lookup function

[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 9b79add..e6ad9ca
--- a/vagrant/Install-on-Ubuntu-20.sh
+++ b/vagrant/Install-on-Ubuntu-20.sh
@@ -1,17 +1,10 @@
-#!/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:
 

-#
-# !!! danger "Important"
-#     Ubuntu 20.04 uses Postgresql 12 and Postgis 3, which are known to cause
-#     performance issues. They are not recommended for a production
-#     installation at the moment.
-#

 # *Note:* these installation instructions are also available in executable
 #         form for use with vagrant under vagrant/Install-on-Ubuntu-20.sh.
 #
 # *Note:* these installation instructions are also available in executable
 #         form for use with vagrant under vagrant/Install-on-Ubuntu-20.sh.
 #


@@ -20,33 +13,29 @@ 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-get update -qq
+    sudo apt update -qq

 
 # Now you can install all packages needed for Nominatim:
 
 
 # Now you can install all packages needed for Nominatim:
 

-    sudo apt-get 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 \
-                            apache2 php php-pgsql libapache2-mod-php \
-                            php-intl python3-setuptools python3-dev python3-pip \
-                            python3-psycopg2 python3-tidylib git
+    sudo apt install -y php-cgi
+    sudo apt install -y build-essential cmake g++ libboost-dev libboost-system-dev \
+                        libboost-filesystem-dev libexpat1-dev zlib1g-dev \
+                        libbz2-dev libpq-dev liblua5.3-dev lua5.3 \
+                        postgresql-12-postgis-3 \
+                        postgresql-contrib-12 postgresql-12-postgis-3-scripts \
+                        php-cli php-pgsql php-intl libicu-dev python3-dotenv \
+                        python3-psycopg2 python3-psutil python3-jinja2 python3-pip \
+                        python3-icu python3-datrie python3-yaml git
+
+# Some of the Python packages that come with Ubuntu 20.04 are too old, so
+# install the latest version from pip:

 
 

-# If you want to run the test suite, you need to install the following
-# additional packages:
+    pip3 install --user sqlalchemy GeoAlchemy2 asyncpg

 
 

-    sudo apt-get install -y phpunit php-codesniffer php-cgi

 
 

-    pip3 install --user behave nose

 #
 # System Configuration
 # ====================
 #
 # System Configuration
 # ====================


@@ -70,8 +59,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.
 #


@@ -89,8 +80,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


@@ -101,77 +95,183 @@ export DEBIAN_FRONTEND=noninteractive #DOCS:
     sudo -u postgres createuser www-data
 
 #
     sudo -u postgres createuser www-data
 
 #

-# Setting up the Apache Webserver
-# -------------------------------
+# Installing Nominatim
+# ====================
+#
+# 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 --recursive https://github.com/openstreetmap/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:
+
+# The code must be built in a separate directory. Create this directory,
+# then configure and build Nominatim in there:
+
+    mkdir $USERHOME/build
+    cd $USERHOME/build
+    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
+# a webserver first, continue reading.
+#
+# 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
+# ----------------------

 #
 #

+if [ "x$2" == "xinstall-apache" ]; then #DOCS:
+#
+# Apache has a PHP module that can be used to serve Nominatim. To install them
+# run:
+
+    sudo apt install -y apache2 libapache2-mod-php
+

 # You need to create an alias to the website directory in your apache
 # configuration. Add a separate nominatim configuration to your webserver:
 
 #DOCS:```sh
 sudo tee /etc/apache2/conf-available/nominatim.conf << EOFAPACHECONF
 # You need to create an alias to the website directory in your apache
 # configuration. Add a separate nominatim configuration to your webserver:
 
 #DOCS:```sh
 sudo tee /etc/apache2/conf-available/nominatim.conf << EOFAPACHECONF

-<Directory "$USERHOME/build/website"> #DOCS:<Directory "$USERHOME/Nominatim/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  #DOCS:Alias /nominatim $USERHOME/Nominatim/build/website
+Alias /nominatim $USERHOME/nominatim-project/website

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

-sudo sed -i 's:#.*::' /etc/apache2/conf-available/nominatim.conf #DOCS:
-

 #
 # Then enable the configuration and restart apache
 #
 
     sudo a2enconf nominatim
 #
 # Then enable the configuration and restart apache
 #
 
     sudo a2enconf nominatim

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

     sudo systemctl restart apache2
     sudo systemctl restart apache2

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

 
 #
 
 #

-# Installing Nominatim
-# ====================
-#
-# Building and Configuration
-# --------------------------
-#
-# Get the source code from Github and change into the source directory
+# Option 2: Using nginx
+# ---------------------

 #
 #

-if [ "x$1" == "xyes" ]; then  #DOCS:    :::sh
-    cd $USERHOME
-    git clone --recursive git://github.com/openstreetmap/Nominatim.git
-    cd Nominatim
-else                               #DOCS:
-    cd $USERHOME/Nominatim         #DOCS:
-fi                                 #DOCS:
+if [ "x$2" == "xinstall-nginx" ]; then #DOCS:

 
 

-# When installing the latest source from github, you also need to
-# download the country grid:
+# Nginx has no native support for php scripts. You need to set up php-fpm for
+# this purpose. First install nginx and php-fpm:

 
 

-if [ ! -f data/country_osm_grid.sql.gz ]; then       #DOCS:    :::sh
-    wget -O data/country_osm_grid.sql.gz https://www.nominatim.org/data/country_grid.sql.gz
-fi                                 #DOCS:
+    sudo apt install -y nginx php-fpm

 
 

-# The code must be built in a separate directory. Create this directory,
-# then configure and build Nominatim in there:
+# You need to configure php-fpm to listen on a Unix socket.

 
 

-    cd $USERHOME                   #DOCS:    :::sh
-    mkdir build
-    cd build
-    cmake $USERHOME/Nominatim
-    make
+#DOCS:```sh
+sudo tee /etc/php/7.4/fpm/pool.d/www.conf << EOF_PHP_FPM_CONF
+[www]
+; Replace the tcp listener and add the unix socket
+listen = /var/run/php-fpm-nominatim.sock
+
+; Ensure that the daemon runs as the correct user
+listen.owner = www-data
+listen.group = www-data
+listen.mode = 0666
+
+; Unix user of FPM processes
+user = www-data
+group = www-data
+
+; Choose process manager type (static, dynamic, ondemand)
+pm = ondemand
+pm.max_children = 5
+EOF_PHP_FPM_CONF
+#DOCS:```

 
 

-# You need to create a minimal configuration file that tells nominatim
-# where it is located on the webserver:
+# Then create a Nginx configuration to forward http requests to that socket.

 
 #DOCS:```sh
 
 #DOCS:```sh

-tee settings/local.php << EOF
-<?php
- @define('CONST_Website_BaseURL', '/nominatim/');
-EOF
+sudo tee /etc/nginx/sites-available/default << EOF_NGINX_CONF
+server {
+    listen 80 default_server;
+    listen [::]:80 default_server;
+
+    root $USERHOME/nominatim-project/website;
+    index search.php index.html;
+    location / {
+        try_files \$uri \$uri/ @php;
+    }
+
+    location @php {
+        fastcgi_param SCRIPT_FILENAME "\$document_root\$uri.php";
+        fastcgi_param PATH_TRANSLATED "\$document_root\$uri.php";
+        fastcgi_param QUERY_STRING    \$args;
+        fastcgi_pass unix:/var/run/php-fpm-nominatim.sock;
+        fastcgi_index index.php;
+        include fastcgi_params;
+    }
+
+    location ~ [^/]\.php(/|$) {
+        fastcgi_split_path_info ^(.+?\.php)(/.*)$;
+        if (!-f \$document_root\$fastcgi_script_name) {
+            return 404;
+        }
+        fastcgi_pass unix:/var/run/php-fpm-nominatim.sock;
+        fastcgi_index search.php;
+        include fastcgi.conf;
+    }
+}
+EOF_NGINX_CONF

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

+# If you have some errors, make sure that php-fpm-nominatim.sock is well under
+# /var/run/ and not under /var/run/php. Otherwise change the Nginx configuration
+# to /var/run/php/php-fpm-nominatim.sock.
+#
+# 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
+fi                                    #DOCS:
+
+# The Nominatim API is now available at `http://localhost/`.
+
+

 
 

-# Nominatim is now ready to use. Continue with
-# [importing a database from OSM data](../admin/Import-and-Update.md).
+fi   #DOCS: