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