]> git.openstreetmap.org Git - nominatim.git/blob - VAGRANT.md
Merge pull request #613 from mtmail/travis-behave-and-split-tests
[nominatim.git] / VAGRANT.md
1 # Install Nominatim in a virtual machine for development and testing
2
3 This document describes how you can install Nominatim inside a Ubuntu 14
4 virtual machine on your desktop/laptop (host machine). The goal is to give
5 you a development environment to easily edit code and run the test suite
6 without affecting the rest of your system. 
7
8 The installation can run largely unsupervised. You should expect 1-2h from
9 start to finish depending on how fast your computer and download speed
10 is.
11
12 ## Prerequisites
13
14 1. [Virtualbox](https://www.virtualbox.org/wiki/Downloads)
15
16 2. [Vagrant](https://www.vagrantup.com/downloads.html)
17
18 3. Nominatim 
19
20         git clone --recursive https://github.com/twain47/Nominatim.git
21
22     If you haven't used `--recursive`, then you can load the submodules using
23     
24         git submodule init
25         git submodule update
26
27
28
29 ## Installation
30
31 1. Start the virtual machine
32
33         vagrant up ubuntu
34
35 2. Log into the virtual machine
36
37         vagrant ssh ubuntu
38
39 3. Import a small country (Monaco)
40
41     You need to give the virtual machine more memory (2GB) for an import,
42     see `Vagrantfile`. Otherwise 1GB is enough.
43     
44     See the FAQ how to skip this step and point Nominatim to an existing database.
45
46   ```
47   # inside the virtual machine:
48   mkdir data
49   cd build
50     wget --no-verbose --output-document=../data/monaco.osm.pbf http://download.geofabrik.de/europe/monaco-latest.osm.pbf
51     ./utils/setup.php --osm-file ../data/monaco.osm.pbf --osm2pgsql-cache 1000 --all 2>&1 | tee monaco.$$.log
52     ```
53
54   To repeat an import you'd need to delete the database first
55
56         dropdb -if-exists nominatim
57
58
59
60 ## Development
61
62 Vagrant maps the virtual machine's port 8089 to your host machine. Thus you can
63 see Nominatim in action on [locahost:8089](http://localhost:8089/nominatim/).
64
65 You edit code on your host machine in any editor you like. There is no need to
66 restart any software: just refresh your browser window.
67
68 PHP errors are written to `/var/log/apache2/error.log`.
69
70 With `echo` and `var_dump()` you write into the output (HTML/XML/JSON) when
71 you either add `&debug=1` to the URL (preferred) or set
72 `@define('CONST_Debug', true);` in `settings/local.php`.
73
74
75
76
77 ## Running functional tests
78
79 Tests in `/features/db` and `/features/osm2pgsql` have to pass 100%. Other
80 tests might require full planet-wide data. Sadly even if you have your own
81 planet-wide data there will be enough differences to the openstreetmap.org
82 installation to cause false positives in the other tests (see FAQ). 
83
84 To run the full test suite
85
86     cd ~/Nominatim/tests
87     NOMINATIM_SERVER=http://localhost:8089/nominatim lettuce features
88
89 To run a single file
90
91     NOMINATIM_SERVER=http://localhost:8089/nominatim lettuce features/api/reverse.feature
92     
93 To run specific tests you can add tags just before the `Scenario line`, e.g.
94
95     @bug-34
96     Scenario: address lookup for non-existing or invalid node, way, relation
97
98 and then
99
100     NOMINATIM_SERVER=http://localhost:8089/nominatim lettuce -t bug-34
101
102
103 ## Running unit tests
104
105     cd ~/Nominatim/tests-php
106     phpunit ./
107
108
109
110
111
112
113 ## FAQ
114
115 ##### Will it run on Windows?
116
117 Yes, Vagrant and Virtualbox can be installed on MS Windows just fine. You need a 64bit
118 version of Windows.
119
120
121 ##### Why Monaco, can I use another country?
122
123 Of course! The Monaco import takes less than 30 minutes and works with 2GB RAM.
124
125 ##### Will the results be the same as those from nominatim.openstreetmap.org?
126
127 No. Long running Nominatim installations will differ once new import features (or
128 bug fixes) get added since those usually only get applied to new/changed data.
129
130 Also this document skips the optional Wikipedia data import which affects ranking
131 of search results. See [Nominatim installation](http://wiki.openstreetmap.org/wiki/Nominatim/Installation) for details.
132
133 ##### Why Ubuntu and CentOS, can I test CentOS/CoreOS/FreeBSD?
134
135 There is a Vagrant script for CentOS available. Simply start your box
136 with `vagrant up centos` and then log in with `vagrant ssh centos`.
137 In general Nominatim will also run in the other environments. The installation steps
138 are slightly different, e.g. the name of the package manager, Apache2 package
139 name, location of files. We chose Ubuntu because that is closest to the
140 nominatim.openstreetmap.org production environment.
141
142 You can configure/download other Vagrant boxes from [vagrantbox.es](http://www.vagrantbox.es/).
143
144
145 ##### How can I connect to an existing database?
146
147 Let's say you have a Postgres database named `nominatim_it` on server `your-server.com` and port `5432`. The Postgres username is `postgres`. You can edit `settings/local.php` and point Nominatim to it.
148
149     pgsql://postgres@your-server.com:5432/nominatim_it
150     
151 No data import necessary, no restarting necessary.
152
153 If the Postgres installation is behind a firewall, you can try
154
155     ssh -L 9999:localhost:5432 your-username@your-server.com
156
157 inside the virtual machine. It will map the port to `localhost:9999` and then
158 you edit `settings/local.php` with
159
160     pgsql://postgres@localhost:9999/nominatim_it
161
162 To access postgres directly remember to specify the hostname, e.g. `psql --host localhost --port 9999 nominatim_it`
163
164
165 ##### My computer is slow and the import takes too long. Can I start the virtual machine "in the cloud"?
166
167 Yes. It's possible to start the virtual machine on [Amazon AWS (plugin)](https://github.com/mitchellh/vagrant-aws) or [DigitalOcean (plugin)](https://github.com/smdahlen/vagrant-digitalocean).
168
169
170
171