]> git.openstreetmap.org Git - nominatim.git/blob - vagrant/Install-on-Ubuntu-16.sh
Merge remote-tracking branch 'upstream/master'
[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 -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 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                             php-intl 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 python3-setuptools python3-dev python3-pip \
37                             python3-psycopg2 python3-tidylib phpunit php-cgi
38
39     pip3 install --user behave nose # urllib3
40     sudo pear install PHP_CodeSniffer
41
42 #
43 # System Configuration
44 # ====================
45 #
46 # The following steps are meant to configure a fresh Ubuntu installation
47 # for use with Nominatim. You may skip some of the steps if you have your
48 # OS already configured.
49 #
50 # Creating Dedicated User Accounts
51 # --------------------------------
52 #
53 # Nominatim will run as a global service on your machine. It is therefore
54 # best to install it under its own separate user account. In the following
55 # we assume this user is called nominatim and the installation will be in
56 # /srv/nominatim. To create the user and directory run:
57 #
58 #     sudo useradd -d /srv/nominatim -s /bin/bash -m nominatim
59 #
60 # You may find a more suitable location if you wish.
61 #
62 # To be able to copy and paste instructions from this manual, export
63 # user name and home directory now like this:
64 #
65     export USERNAME=vagrant        #DOCS:    export USERNAME=nominatim
66     export USERHOME=/home/vagrant  #DOCS:    export USERHOME=/srv/nominatim
67 #
68 # **Never, ever run the installation as a root user.** You have been warned.
69 #
70 # Make sure that system servers can read from the home directory:
71
72     chmod a+x $USERHOME
73
74 # Setting up PostgreSQL
75 # ---------------------
76 #
77 # Tune the postgresql configuration, which is located in 
78 # `/etc/postgresql/9.5/main/postgresql.conf`. See section *Postgres Tuning* in
79 # [the installation page](Installation.md) for the parameters to change.
80 #
81 # Restart the postgresql service after updating this config file.
82
83     sudo systemctl restart postgresql
84
85 #
86 # Finally, we need to add two postgres users: one for the user that does
87 # the import and another for the webserver which should access the database
88 # for reading only:
89 #
90
91     sudo -u postgres createuser -s $USERNAME
92     sudo -u postgres createuser www-data
93
94 #
95 # Setting up the Apache Webserver
96 # -------------------------------
97 #
98 # You need to create an alias to the website directory in your apache
99 # configuration. Add a separate nominatim configuration to your webserver:
100
101 #DOCS:```
102 sudo tee /etc/apache2/conf-available/nominatim.conf << EOFAPACHECONF
103 <Directory "$USERHOME/build/website"> #DOCS:<Directory "$USERHOME/Nominatim/build/website">
104   Options FollowSymLinks MultiViews
105   AddType text/html   .php
106   DirectoryIndex search.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/openstreetmap/Nominatim.git
136     cd Nominatim
137
138 else                               #DOCS:
139     cd $USERHOME/Nominatim         #DOCS:
140 fi                                 #DOCS:
141
142 # When installing the latest source from github, you also need to
143 # download the country grid:
144
145 if [ ! -f data/country_osm_grid.sql.gz ]; then       #DOCS:
146     wget -O data/country_osm_grid.sql.gz http://www.nominatim.org/data/country_grid.sql.gz
147 fi                                 #DOCS:
148
149 # The code must be built in a separate directory. Create this directory,
150 # then configure and build Nominatim in there:
151
152     cd $USERHOME                   #DOCS:
153     mkdir build
154     cd build
155     cmake $USERHOME/Nominatim
156     make
157
158 # You need to create a minimal configuration file that tells nominatim
159 # where it is located on the webserver:
160
161 #DOCS:```
162 tee settings/local.php << EOF
163 <?php
164  @define('CONST_Website_BaseURL', '/nominatim/');
165 EOF
166 #DOCS:```
167
168
169 # Nominatim is now ready to use. Continue with
170 # [importing a database from OSM data](Import-and-Update.md).