X-Git-Url: https://git.openstreetmap.org./nominatim.git/blobdiff_plain/3e64019afe8419ea5b35a3fbd1e6c9dabfc8d983..5302b5d411380251a91006853e28f506f63a83fa:/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 new mode 100755 index a7029be2..1fbabf24 --- 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: -sudo update-locale LANG=en_US.UTF-8 #DOCS: export APT_LISTCHANGES_FRONTEND=none #DOCS: export DEBIAN_FRONTEND=noninteractive #DOCS: @@ -14,26 +13,22 @@ export DEBIAN_FRONTEND=noninteractive #DOCS: # # 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: - 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 libproj-dev \ + postgresql-server-dev-12 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 git # # System Configuration @@ -58,8 +53,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: # +if [ "x$USERNAME" == "x" ]; then #DOCS: 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. # @@ -77,8 +74,11 @@ export DEBIAN_FRONTEND=noninteractive #DOCS: # # 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 - +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 @@ -88,35 +88,6 @@ export DEBIAN_FRONTEND=noninteractive #DOCS: sudo -u postgres createuser -s $USERNAME sudo -u postgres createuser www-data -# -# Setting up the Apache Webserver -# ------------------------------- -# -# 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 - #DOCS: - Options FollowSymLinks MultiViews - AddType text/html .php - DirectoryIndex search.php - Require all granted - - -Alias /nominatim $USERHOME/build/website #DOCS:Alias /nominatim $USERHOME/Nominatim/build/website -EOFAPACHECONF -#DOCS:``` - -sudo sed -i 's:#.*::' /etc/apache2/conf-available/nominatim.conf #DOCS: - -# -# Then enable the configuration and restart apache -# - - sudo a2enconf nominatim - sudo systemctl restart apache2 - # # Installing Nominatim # ==================== @@ -144,22 +115,157 @@ fi #DOCS: # The code must be built in a separate directory. Create this directory, # then configure and build Nominatim in there: - cd $USERHOME #DOCS: :::sh - mkdir build - cd build + 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. -# You need to create a minimal configuration file that tells nominatim -# where it is located on the webserver: +# +# 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 -tee settings/local.php << EOF - + Options FollowSymLinks MultiViews + AddType text/html .php + DirectoryIndex search.php + Require all granted + + +Alias /nominatim $USERHOME/nominatim-project/website +EOFAPACHECONF +#DOCS:``` + +# +# 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 +fi #DOCS: + +# The Nominatim API is now available at `http://localhost/nominatim/`. + +fi #DOCS: + +# +# Option 2: Using nginx +# --------------------- +# +if [ "x$2" == "xinstall-nginx" ]; then #DOCS: + +# Nginx has no native support for php scripts. You need to set up php-fpm for +# this purpose. First install nginx and php-fpm: + + sudo apt install -y nginx php-fpm + +# You need to configure php-fpm to listen on a Unix socket. + +#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/php7.4-fpm.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:``` + +# Then create a Nginx configuration to forward http requests to that socket. + +#DOCS:```sh +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/php7.4-fpm.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/php7.4-fpm.sock; + fastcgi_index search.php; + include fastcgi.conf; + } +} +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 +# + +if [ "x$NOSYSTEMD" == "xyes" ]; then #DOCS: + sudo /usr/sbin/php-fpm7.3 --nodaemonize --fpm-config /etc/php/7.3/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.md). +fi #DOCS: