]> git.openstreetmap.org Git - nominatim.git/blob - vagrant/install-on-ubuntu-16.sh
Merge remote-tracking branch 'upstream/master' into cmake-port
[nominatim.git] / 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 update -qq
22     sudo apt-get -o Dpkg::Options::="--force-confold" --force-yes -fuy dist-upgrade #DOCS:    sudo apt-get upgrade
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 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 \
31                             git
32
33 # If you want to run the test suite, you need to install the following
34 # additional packages:
35
36     sudo apt-get install -y python-dev python-pip python-levenshtein python-shapely \
37                             python-psycopg2 tidy python-nose python-tidylib \
38                             python-numpy phpunit
39
40     pip install --user lettuce==0.2.18 six==1.7 haversine
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](Installation.md) for the parameters to change.
81 #
82 # Restart the postgresql service after updating this config file.
83
84     sudo systemctl restart postgresql
85
86 #
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
89 # for reading only:
90 #
91
92     sudo -u postgres createuser -s $USERNAME
93     sudo -u postgres createuser www-data
94
95 #
96 # Setting up the Apache Webserver
97 # -------------------------------
98 #
99 # You need to create an alias to the website directory in your apache
100 # configuration. Add a separate nominatim configuration to your webserver:
101
102 #DOCS:```
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   Require all granted
108 </Directory>
109
110 Alias /nominatim $USERHOME/build/website  #DOCS:Alias /nominatim $USERHOME/Nominatim/build/website
111 EOFAPACHECONF
112 #DOCS:```
113
114 sudo sed -i 's:#.*::' /etc/apache2/conf-available/nominatim.conf #DOCS:
115
116 #
117 # Then enable the configuration and restart apache
118 #
119
120     sudo a2enconf nominatim
121     sudo systemctl restart apache2
122
123 #
124 # Installing Nominatim
125 # ====================
126 #
127 # Building and Configuration
128 # --------------------------
129 #
130 # Get the source code from Github and change into the source directory
131 #
132 if [ "x$1" == "xyes" ]; then  #DOCS:
133
134     cd $USERHOME
135     git clone --recursive git://github.com/twain47/Nominatim.git
136 #DOCS:    cd Nominatim
137
138 else                               #DOCS:
139     cd $USERHOME                   #DOCS:
140 fi                                 #DOCS:
141
142 # The code must be built in a separate directory. Create this directory,
143 # then configure and build Nominatim in there:
144
145     mkdir build
146     cd build
147     cmake $USERHOME/Nominatim
148     make
149
150 # You need to create a minimal configuration file that tells nominatim
151 # where it is located on the webserver:
152
153 #DOCS:```
154 tee settings/local.php << EOF
155 <?php
156  @define('CONST_Website_BaseURL', '/nominatim/');
157 EOF
158 #DOCS:```
159
160
161 # Nominatim is now ready to use. Continue with
162 # [importing a database from OSM data](Import_and_update.md).