vagrant/Install-on-Ubuntu-18.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 #
  10 # *Note:* these installation instructions are also available in executable
  11 #         form for use with vagrant under vagrant/Install-on-Ubuntu-18.sh.
  12 #
  13 # Installing the Required Software
  14 # ================================
  15 #
  16 # These instructions expect that you have a freshly installed Ubuntu 18.04.
  17 #
  18 # Make sure all packages are are up-to-date by running:
  19 #
  20
  21 #DOCS:    :::sh
  22     sudo apt-get -o DPkg::options::="--force-confdef" -o DPkg::options::="--force-confold" --force-yes -fuy install grub-pc #DOCS:
  23     sudo apt-get update -qq
  24
  25 # Now you can install all packages needed for Nominatim:
  26
  27     sudo apt-get install -y build-essential cmake g++ libboost-dev libboost-system-dev \
  28                             libboost-filesystem-dev libexpat1-dev zlib1g-dev\
  29                             libbz2-dev libpq-dev libproj-dev \
  30                             postgresql-server-dev-10 postgresql-10-postgis-2.4 \
  31                             postgresql-contrib-10 postgresql-10-postgis-scripts \
  32                             apache2 php php-pgsql libapache2-mod-php \
  33                             php-intl python3-setuptools python3-dev python3-pip \
  34                             python3-psycopg2 python3-tidylib git
  35
  36
  37 #
  38 # System Configuration
  39 # ====================
  40 #
  41 # The following steps are meant to configure a fresh Ubuntu installation
  42 # for use with Nominatim. You may skip some of the steps if you have your
  43 # OS already configured.
  44 #
  45 # Creating Dedicated User Accounts
  46 # --------------------------------
  47 #
  48 # Nominatim will run as a global service on your machine. It is therefore
  49 # best to install it under its own separate user account. In the following
  50 # we assume this user is called nominatim and the installation will be in
  51 # /srv/nominatim. To create the user and directory run:
  52 #
  53 #     sudo useradd -d /srv/nominatim -s /bin/bash -m nominatim
  54 #
  55 # You may find a more suitable location if you wish.
  56 #
  57 # To be able to copy and paste instructions from this manual, export
  58 # user name and home directory now like this:
  59 #
  60     export USERNAME=vagrant        #DOCS:    export USERNAME=nominatim
  61     export USERHOME=/home/vagrant  #DOCS:    export USERHOME=/srv/nominatim
  62 #
  63 # **Never, ever run the installation as a root user.** You have been warned.
  64 #
  65 # Make sure that system servers can read from the home directory:
  66
  67     chmod a+x $USERHOME
  68
  69 # Setting up PostgreSQL
  70 # ---------------------
  71 #
  72 # Tune the postgresql configuration, which is located in
  73 # `/etc/postgresql/10/main/postgresql.conf`. See section *Postgres Tuning* in
  74 # [the installation page](../admin/Installation.md#postgresql-tuning)
  75 # for the parameters to change.
  76 #
  77 # Restart the postgresql service after updating this config file.
  78
  79     sudo systemctl restart postgresql
  80
  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 # Setting up the Apache Webserver
  92 # -------------------------------
  93 #
  94 # You need to create an alias to the website directory in your apache
  95 # configuration. Add a separate nominatim configuration to your webserver:
  96
  97 #DOCS:```sh
  98 sudo tee /etc/apache2/conf-available/nominatim.conf << EOFAPACHECONF
  99 <Directory "$USERHOME/build/website"> #DOCS:<Directory "$USERHOME/Nominatim/build/website">
 100   Options FollowSymLinks MultiViews
 101   AddType text/html   .php
 102   DirectoryIndex search.php
 103   Require all granted
 104 </Directory>
 105
 106 Alias /nominatim $USERHOME/build/website  #DOCS:Alias /nominatim $USERHOME/Nominatim/build/website
 107 EOFAPACHECONF
 108 #DOCS:```
 109
 110 sudo sed -i 's:#.*::' /etc/apache2/conf-available/nominatim.conf #DOCS:
 111
 112 #
 113 # Then enable the configuration and restart apache
 114 #
 115
 116     sudo a2enconf nominatim
 117     sudo systemctl restart apache2
 118
 119 #
 120 # Installing Nominatim
 121 # ====================
 122 #
 123 # Building and Configuration
 124 # --------------------------
 125 #
 126 # Get the source code from Github and change into the source directory
 127 #
 128 if [ "x$1" == "xyes" ]; then  #DOCS:    :::sh
 129     cd $USERHOME
 130     git clone --recursive git://github.com/openstreetmap/Nominatim.git
 131     cd Nominatim
 132 else                               #DOCS:
 133     cd $USERHOME/Nominatim         #DOCS:
 134 fi                                 #DOCS:
 135
 136 # When installing the latest source from github, you also need to
 137 # download the country grid:
 138
 139 if [ ! -f data/country_osm_grid.sql.gz ]; then       #DOCS:    :::sh
 140     wget -O data/country_osm_grid.sql.gz https://www.nominatim.org/data/country_grid.sql.gz
 141 fi                                 #DOCS:
 142
 143 # The code must be built in a separate directory. Create this directory,
 144 # then configure and build Nominatim in there:
 145
 146     cd $USERHOME                   #DOCS:    :::sh
 147     mkdir build
 148     cd build
 149     cmake $USERHOME/Nominatim
 150     make
 151
 152 # You need to create a minimal configuration file that tells nominatim
 153 # where it is located on the webserver:
 154
 155 #DOCS:```sh
 156 tee settings/local.php << EOF
 157 <?php
 158  @define('CONST_Website_BaseURL', '/nominatim/');
 159 EOF
 160 #DOCS:```
 161
 162
 163 # Nominatim is now ready to use. Continue with
 164 # [importing a database from OSM data](../admin/Import.md).