vagrant/Install-on-Ubuntu-20.sh

   1 #!/bin/bash
   2 #
   3 # hacks for broken vagrant box      #DOCS:
   4 sudo rm -f /var/lib/dpkg/lock       #DOCS:
   5 sudo update-locale LANG=en_US.UTF-8 #DOCS:
   6 export APT_LISTCHANGES_FRONTEND=none #DOCS:
   7 export DEBIAN_FRONTEND=noninteractive #DOCS:
   8
   9 # *Note:* these installation instructions are also available in executable
  10 #         form for use with vagrant under vagrant/Install-on-Ubuntu-20.sh.
  11 #
  12 # Installing the Required Software
  13 # ================================
  14 #
  15 # These instructions expect that you have a freshly installed Ubuntu 20.04.
  16 #
  17 # Make sure all packages are are up-to-date by running:
  18 #
  19
  20 #DOCS:    :::sh
  21     sudo apt-get \ #DOCS:
  22         -o DPkg::options::="--force-confdef" -o DPkg::options::="--force-confold" \ #DOCS:
  23         --allow-downgrades --allow-remove-essential --allow-change-held-packages \ #DOCS:
  24         -fuy install grub-pc #DOCS:
  25     sudo apt update -qq
  26
  27 # Now you can install all packages needed for Nominatim:
  28
  29     sudo apt install -y php-cgi
  30     sudo apt install -y build-essential cmake g++ libboost-dev libboost-system-dev \
  31                         libboost-filesystem-dev libexpat1-dev zlib1g-dev \
  32                         libbz2-dev libpq-dev libproj-dev \
  33                         postgresql-server-dev-12 postgresql-12-postgis-3 \
  34                         postgresql-contrib-12 postgresql-12-postgis-3-scripts \
  35                         php php-pgsql php-intl libicu-dev python3-dotenv \
  36                         python3-psycopg2 python3-psutil python3-jinja2 python3-icu git
  37
  38 #
  39 # System Configuration
  40 # ====================
  41 #
  42 # The following steps are meant to configure a fresh Ubuntu installation
  43 # for use with Nominatim. You may skip some of the steps if you have your
  44 # OS already configured.
  45 #
  46 # Creating Dedicated User Accounts
  47 # --------------------------------
  48 #
  49 # Nominatim will run as a global service on your machine. It is therefore
  50 # best to install it under its own separate user account. In the following
  51 # we assume this user is called nominatim and the installation will be in
  52 # /srv/nominatim. To create the user and directory run:
  53 #
  54 #     sudo useradd -d /srv/nominatim -s /bin/bash -m nominatim
  55 #
  56 # You may find a more suitable location if you wish.
  57 #
  58 # To be able to copy and paste instructions from this manual, export
  59 # user name and home directory now like this:
  60 #
  61     export USERNAME=vagrant        #DOCS:    export USERNAME=nominatim
  62     export USERHOME=/home/vagrant  #DOCS:    export USERHOME=/srv/nominatim
  63 #
  64 # **Never, ever run the installation as a root user.** You have been warned.
  65 #
  66 # Make sure that system servers can read from the home directory:
  67
  68     chmod a+x $USERHOME
  69
  70 # Setting up PostgreSQL
  71 # ---------------------
  72 #
  73 # Tune the postgresql configuration, which is located in
  74 # `/etc/postgresql/12/main/postgresql.conf`. See section *Postgres Tuning* in
  75 # [the installation page](../admin/Installation.md#postgresql-tuning)
  76 # for the parameters to change.
  77 #
  78 # Restart the postgresql service after updating this config file.
  79
  80     sudo systemctl restart postgresql
  81
  82 #
  83 # Finally, we need to add two postgres users: one for the user that does
  84 # the import and another for the webserver which should access the database
  85 # for reading only:
  86 #
  87
  88     sudo -u postgres createuser -s $USERNAME
  89     sudo -u postgres createuser www-data
  90
  91 #
  92 # Installing Nominatim
  93 # ====================
  94 #
  95 # Building and Configuration
  96 # --------------------------
  97 #
  98 # Get the source code from Github and change into the source directory
  99 #
 100 if [ "x$1" == "xyes" ]; then  #DOCS:    :::sh
 101     cd $USERHOME
 102     git clone --recursive git://github.com/openstreetmap/Nominatim.git
 103     cd Nominatim
 104 else                               #DOCS:
 105     cd $USERHOME/Nominatim         #DOCS:
 106 fi                                 #DOCS:
 107
 108 # When installing the latest source from github, you also need to
 109 # download the country grid:
 110
 111 if [ ! -f data/country_osm_grid.sql.gz ]; then       #DOCS:    :::sh
 112     wget -O data/country_osm_grid.sql.gz https://www.nominatim.org/data/country_grid.sql.gz
 113 fi                                 #DOCS:
 114
 115 # The code must be built in a separate directory. Create this directory,
 116 # then configure and build Nominatim in there:
 117
 118     mkdir $USERHOME/build
 119     cd $USERHOME/build
 120     cmake $USERHOME/Nominatim
 121     make
 122     sudo make install
 123
 124 # Nominatim is now ready to use. You can continue with
 125 # [importing a database from OSM data](../admin/Import.md). If you want to set up
 126 # a webserver first, continue reading.
 127 #
 128 # Setting up a webserver
 129 # ======================
 130 #
 131 # The webserver should serve the php scripts from the website directory of your
 132 # [project directory](../admin/Import.md#creating-the-project-directory).
 133 # Therefore set up a project directory and populate the website directory:
 134
 135     mkdir $USERHOME/nominatim-project
 136     cd $USERHOME/nominatim-project
 137     nominatim refresh --website
 138
 139 #
 140 # Option 1: Using Apache
 141 # ----------------------
 142 #
 143 if [ "x$2" == "xinstall-apache" ]; then #DOCS:
 144 #
 145 # Apache has a PHP module that can be used to serve Nominatim. To install them
 146 # run:
 147
 148     sudo apt install -y apache2 libapache2-mod-php
 149
 150 # You need to create an alias to the website directory in your apache
 151 # configuration. Add a separate nominatim configuration to your webserver:
 152
 153 #DOCS:```sh
 154 sudo tee /etc/apache2/conf-available/nominatim.conf << EOFAPACHECONF
 155 <Directory "$USERHOME/nominatim-project/website">
 156   Options FollowSymLinks MultiViews
 157   AddType text/html   .php
 158   DirectoryIndex search.php
 159   Require all granted
 160 </Directory>
 161
 162 Alias /nominatim $USERHOME/nominatim-project/website
 163 EOFAPACHECONF
 164 #DOCS:```
 165
 166 #
 167 # Then enable the configuration and restart apache
 168 #
 169
 170     sudo a2enconf nominatim
 171     sudo systemctl restart apache2
 172
 173 # The Nominatim API is now available at `http://localhost/nominatim/`.
 174
 175 fi   #DOCS:
 176
 177 #
 178 # Option 2: Using nginx
 179 # ---------------------
 180 #
 181 if [ "x$2" == "xinstall-nginx" ]; then #DOCS:
 182
 183 # Nginx has no native support for php scripts. You need to set up php-fpm for
 184 # this purpose. First install nginx and php-fpm:
 185
 186     sudo apt install -y nginx php-fpm
 187
 188 # You need to configure php-fpm to listen on a Unix socket.
 189
 190 #DOCS:```sh
 191 sudo tee /etc/php/7.4/fpm/pool.d/www.conf << EOF_PHP_FPM_CONF
 192 [www]
 193 ; Replace the tcp listener and add the unix socket
 194 listen = /var/run/php7.4-fpm.sock
 195
 196 ; Ensure that the daemon runs as the correct user
 197 listen.owner = www-data
 198 listen.group = www-data
 199 listen.mode = 0666
 200
 201 ; Unix user of FPM processes
 202 user = www-data
 203 group = www-data
 204
 205 ; Choose process manager type (static, dynamic, ondemand)
 206 pm = ondemand
 207 pm.max_children = 5
 208 EOF_PHP_FPM_CONF
 209 #DOCS:```
 210
 211 # Then create a Nginx configuration to forward http requests to that socket.
 212
 213 #DOCS:```sh
 214 sudo tee /etc/nginx/sites-available/default << EOF_NGINX_CONF
 215 server {
 216     listen 80 default_server;
 217     listen [::]:80 default_server;
 218
 219     root $USERHOME/nominatim-project/website;
 220     index search.php index.html;
 221     location / {
 222         try_files \$uri \$uri/ @php;
 223     }
 224
 225     location @php {
 226         fastcgi_param SCRIPT_FILENAME "\$document_root\$uri.php";
 227         fastcgi_param PATH_TRANSLATED "\$document_root\$uri.php";
 228         fastcgi_param QUERY_STRING    \$args;
 229         fastcgi_pass unix:/var/run/php7.4-fpm.sock;
 230         fastcgi_index index.php;
 231         include fastcgi_params;
 232     }
 233
 234     location ~ [^/]\.php(/|$) {
 235         fastcgi_split_path_info ^(.+?\.php)(/.*)$;
 236         if (!-f \$document_root\$fastcgi_script_name) {
 237             return 404;
 238         }
 239         fastcgi_pass unix:/var/run/php7.4-fpm.sock;
 240         fastcgi_index search.php;
 241         include fastcgi.conf;
 242     }
 243 }
 244 EOF_NGINX_CONF
 245 #DOCS:```
 246
 247 #
 248 # Enable the configuration and restart Nginx
 249 #
 250
 251     sudo systemctl restart php7.4-fpm nginx
 252
 253 # The Nominatim API is now available at `http://localhost/`.
 254
 255
 256
 257 fi   #DOCS: