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:
10 # *Note:* these installation instructions are also available in executable
11 # form for use with vagrant under vagrant/install-on-ubuntu-16.sh.
13 # Installing the Required Software
14 # ================================
16 # These instructions expect that you have a freshly installed Ubuntu 16.04.
18 # Make sure all packages are are up-to-date by running:
21 sudo apt-get update -qq
22 sudo apt-get -o Dpkg::Options::="--force-confold" --force-yes -fuy dist-upgrade #DOCS: sudo apt-get upgrade
24 # Now you can install all packages needed for Nominatim:
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 libgeos-dev libgeos++-dev libproj-dev \
29 postgresql-server-dev-9.5 postgresql-9.5-postgis-2.2 postgresql-contrib-9.5 \
30 apache2 php php-pgsql libapache2-mod-php php-pear php-db \
33 # If you want to run the test suite, you need to install the following
34 # additional packages:
36 sudo apt-get install -y python-dev python-pip python-levenshtein python-shapely \
37 python-psycopg2 tidy python-nose python-tidylib \
40 pip install --user lettuce==0.2.18 six==1.7 haversine
41 sudo pear install PHP_CodeSniffer
44 # System Configuration
45 # ====================
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.
51 # Creating Dedicated User Accounts
52 # --------------------------------
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:
59 # sudo useradd -d /srv/nominatim -s /bin/bash -m nominatim
61 # You may find a more suitable location if you wish.
63 # To be able to copy and paste instructions from this manual, export
64 # user name and home directory now like this:
66 export USERNAME=vagrant #DOCS: export USERNAME=nominatim
67 export USERHOME=/home/vagrant #DOCS: export USERHOME=/srv/nominatim
69 # **Never, ever run the installation as a root user.** You have been warned.
71 # Make sure that system servers can read from the home directory:
75 # Setting up PostgreSQL
76 # ---------------------
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](Installation.md) for the parameters to change.
82 # Restart the postgresql service after updating this config file.
84 sudo systemctl restart postgresql
87 # Finally, we need to add two postgres users: one for the user that does
88 # the import and another for the webserver which should access the database
92 sudo -u postgres createuser -s $USERNAME
93 sudo -u postgres createuser www-data
96 # Setting up the Apache Webserver
97 # -------------------------------
99 # You need to create an alias to the website directory in your apache
100 # configuration. Add a separate nominatim configuration to your webserver:
103 sudo tee /etc/apache2/conf-available/nominatim.conf << EOFAPACHECONF
104 <Directory "$USERHOME/build/website"> #DOCS:<Directory "$USERHOME/Nominatim/build/website">
105 Options FollowSymLinks MultiViews
106 AddType text/html .php
107 DirectoryIndex search.php
111 Alias /nominatim $USERHOME/build/website #DOCS:Alias /nominatim $USERHOME/Nominatim/build/website
115 sudo sed -i 's:#.*::' /etc/apache2/conf-available/nominatim.conf #DOCS:
118 # Then enable the configuration and restart apache
121 sudo a2enconf nominatim
122 sudo systemctl restart apache2
125 # Installing Nominatim
126 # ====================
128 # Building and Configuration
129 # --------------------------
131 # Get the source code from Github and change into the source directory
133 if [ "x$1" == "xyes" ]; then #DOCS:
136 git clone --recursive git://github.com/twain47/Nominatim.git
143 # The code must be built in a separate directory. Create this directory,
144 # then configure and build Nominatim in there:
148 cmake $USERHOME/Nominatim
151 # You need to create a minimal configuration file that tells nominatim
152 # where it is located on the webserver:
155 tee settings/local.php << EOF
157 @define('CONST_Website_BaseURL', '/nominatim/');
162 # Nominatim is now ready to use. Continue with
163 # [importing a database from OSM data](Import_and_update.md).