From 6e3670bce58ccb1d9357e9bc558d10db3f27931b Mon Sep 17 00:00:00 2001 From: Sarah Hoffmann Date: Fri, 24 Aug 2018 21:33:24 +0200 Subject: [PATCH] add vagrant and installation instructions for ubuntu 18 --- Vagrantfile | 9 ++ docs/CMakeLists.txt | 1 + docs/admin/Installation.md | 1 + docs/mkdocs.yml | 1 + vagrant/Install-on-Ubuntu-18.sh | 171 ++++++++++++++++++++++++++++++++ 5 files changed, 183 insertions(+) create mode 100755 vagrant/Install-on-Ubuntu-18.sh diff --git a/Vagrantfile b/Vagrantfile index 5c9563bd..bd610e7e 100644 --- a/Vagrantfile +++ b/Vagrantfile @@ -15,6 +15,15 @@ Vagrant.configure("2") do |config| end config.vm.define "ubuntu", primary: true do |sub| + sub.vm.box = "bento/ubuntu-18.04" + sub.vm.provision :shell do |s| + s.path = "vagrant/Install-on-Ubuntu-18.sh" + s.privileged = false + s.args = [checkout] + end + end + + config.vm.define "ubuntu16" do |sub| sub.vm.box = "bento/ubuntu-16.04" sub.vm.provision :shell do |s| s.path = "vagrant/Install-on-Ubuntu-16.sh" diff --git a/docs/CMakeLists.txt b/docs/CMakeLists.txt index f50b38ab..cbe91b91 100644 --- a/docs/CMakeLists.txt +++ b/docs/CMakeLists.txt @@ -14,6 +14,7 @@ ADD_CUSTOM_TARGET(doc COMMAND ${CMAKE_COMMAND} -E create_symlink ${CMAKE_CURRENT_SOURCE_DIR}/extra.css ${CMAKE_CURRENT_BINARY_DIR}/extra.css COMMAND ${CMAKE_CURRENT_SOURCE_DIR}/bash2md.sh ${PROJECT_SOURCE_DIR}/vagrant/Install-on-Centos-7.sh ${CMAKE_CURRENT_BINARY_DIR}/appendix/Install-on-Centos-7.md COMMAND ${CMAKE_CURRENT_SOURCE_DIR}/bash2md.sh ${PROJECT_SOURCE_DIR}/vagrant/Install-on-Ubuntu-16.sh ${CMAKE_CURRENT_BINARY_DIR}/appendix/Install-on-Ubuntu-16.md + COMMAND ${CMAKE_CURRENT_SOURCE_DIR}/bash2md.sh ${PROJECT_SOURCE_DIR}/vagrant/Install-on-Ubuntu-18.sh ${CMAKE_CURRENT_BINARY_DIR}/appendix/Install-on-Ubuntu-18.md COMMAND mkdocs build -d ${CMAKE_CURRENT_BINARY_DIR}/../site-html -f ${CMAKE_CURRENT_BINARY_DIR}/../mkdocs.yml ) diff --git a/docs/admin/Installation.md b/docs/admin/Installation.md index 3d276c06..592c6cc1 100644 --- a/docs/admin/Installation.md +++ b/docs/admin/Installation.md @@ -4,6 +4,7 @@ This page contains generic installation instructions for Nominatim and its prerequisites. There are also step-by-step instructions available for the following operating systems: + * [Ubuntu 18.04](../appendix/Install-on-Ubuntu-18.md) * [Ubuntu 16.04](../appendix/Install-on-Ubuntu-16.md) * [CentOS 7.2](../appendix/Install-on-Centos-7.md) diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 219176f6..b620decf 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -23,6 +23,7 @@ pages: - 'Appendix': - 'Installation on CentOS 7' : 'appendix/Install-on-Centos-7.md' - 'Installation on Ubuntu 16' : 'appendix/Install-on-Ubuntu-16.md' + - 'Installation on Ubuntu 18' : 'appendix/Install-on-Ubuntu-18.md' markdown_extensions: - codehilite: use_pygments: False diff --git a/vagrant/Install-on-Ubuntu-18.sh b/vagrant/Install-on-Ubuntu-18.sh new file mode 100755 index 00000000..062d7cee --- /dev/null +++ b/vagrant/Install-on-Ubuntu-18.sh @@ -0,0 +1,171 @@ +#!/bin/bash +# +# 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: + +# +# *Note:* these installation instructions are also available in executable +# form for use with vagrant under vagrant/Install-on-Ubuntu-18.sh. +# +# Installing the Required Software +# ================================ +# +# These instructions expect that you have a freshly installed Ubuntu 18.04. +# +# Make sure all packages are are up-to-date by running: +# + +#DOCS: :::sh + sudo apt-get -o DPkg::options::="--force-confdef" -o DPkg::options::="--force-confold" --force-yes -fuy install grub-pc #DOCS: + sudo apt-get 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 libxml2-dev\ + libbz2-dev libpq-dev libproj-dev \ + postgresql-server-dev-10 postgresql-10-postgis-2.4 \ + postgresql-contrib-10 \ + apache2 php php-pgsql libapache2-mod-php php-pear php-db \ + php-intl git + +# If you want to run the test suite, you need to install the following +# additional packages: + + sudo apt-get install -y python3-setuptools python3-dev python3-pip \ + python3-psycopg2 python3-tidylib phpunit php-cgi + + pip3 install --user behave nose + sudo pear install PHP_CodeSniffer + +# +# System Configuration +# ==================== +# +# The following steps are meant to configure a fresh Ubuntu installation +# for use with Nominatim. You may skip some of the steps if you have your +# OS already configured. +# +# Creating Dedicated User Accounts +# -------------------------------- +# +# Nominatim will run as a global service on your machine. It is therefore +# best to install it under its own separate user account. In the following +# we assume this user is called nominatim and the installation will be in +# /srv/nominatim. To create the user and directory run: +# +# sudo useradd -d /srv/nominatim -s /bin/bash -m nominatim +# +# You may find a more suitable location if you wish. +# +# To be able to copy and paste instructions from this manual, export +# user name and home directory now like this: +# + export USERNAME=vagrant #DOCS: export USERNAME=nominatim + export USERHOME=/home/vagrant #DOCS: export USERHOME=/srv/nominatim +# +# **Never, ever run the installation as a root user.** You have been warned. +# +# Make sure that system servers can read from the home directory: + + chmod a+x $USERHOME + +# Setting up PostgreSQL +# --------------------- +# +# Tune the postgresql configuration, which is located in +# `/etc/postgresql/9.5/main/postgresql.conf`. See section *Postgres Tuning* in +# [the installation page](../admin/Installation.md#postgresql-tuning) +# for the parameters to change. +# +# Restart the postgresql service after updating this config file. + + sudo systemctl restart postgresql + +# +# 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 +# for reading only: +# + + 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 +# ==================== +# +# Building and Configuration +# -------------------------- +# +# Get the source code from Github and change into the source directory +# +if [ "x$1" == "xyes" ]; then #DOCS: :::sh + cd $USERHOME + git clone --recursive git://github.com/openstreetmap/Nominatim.git + cd Nominatim +else #DOCS: + cd $USERHOME/Nominatim #DOCS: +fi #DOCS: + +# When installing the latest source from github, you also need to +# download the country grid: + +if [ ! -f data/country_osm_grid.sql.gz ]; then #DOCS: :::sh + wget -O data/country_osm_grid.sql.gz https://www.nominatim.org/data/country_grid.sql.gz +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 + cmake $USERHOME/Nominatim + make + +# You need to create a minimal configuration file that tells nominatim +# where it is located on the webserver: + +#DOCS:```sh +tee settings/local.php << EOF +