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