]> git.openstreetmap.org Git - nominatim.git/blobdiff - VAGRANT.md
pylint: avoid explicit use of format() function
[nominatim.git] / VAGRANT.md
index b2dd3b8a0f2a9a279db77c7613e37bbb214fd619..b0df9a882f881a4117a0c12c1b1c95380108aab8 100644 (file)
@@ -19,7 +19,7 @@ is.
 
         git clone --recursive https://github.com/openstreetmap/Nominatim.git
 
-    If forgot `--recursive`, you can later load the submodules using
+    If you forgot `--recursive`, it you can later load the submodules using
     
         git submodule init
         git submodule update
@@ -42,9 +42,9 @@ is.
 
       ```
       # inside the virtual machine:
-      cd build
-      wget --no-verbose --output-document=/tmp/monaco.osm.pbf http://download.geofabrik.de/europe/monaco-latest.osm.pbf
-      ./utils/setup.php --osm-file /tmp/monaco.osm.pbf --osm2pgsql-cache 1000 --all 2>&1 | tee monaco.$$.log
+      cd nominatim-project
+      wget --no-verbose --output-document=monaco.osm.pbf http://download.geofabrik.de/europe/monaco-latest.osm.pbf
+      nominatim import --osm-file monaco.osm.pbf 2>&1 | tee monaco.$$.log
       ```
 
     To repeat an import you'd need to delete the database first
@@ -62,8 +62,9 @@ You edit code on your host machine in any editor you like. There is no need to
 restart any software: just refresh your browser window.
 
 Note that the webserver uses files from the /build directory. If you change
-files in Nominatim/lib for example you first need to copy them into the
-/build directory.
+files in Nominatim/website or Nominatim/utils for example you first need to
+copy them into the /build directory by running the `cmake` step from the
+installation.
 
 PHP errors are written to `/var/log/apache2/error.log`.
 
@@ -90,7 +91,7 @@ statements.
 
 ## Running functional tests
 
-Tests in `/features/db` and `/features/osm2pgsql` have to pass 100%. Other
+Tests in `test/bdd/db` and `test/bdd/osm2pgsql` have to pass 100%. Other
 tests might require full planet-wide data. Sadly even if you have your own
 planet-wide data there will be enough differences to the openstreetmap.org
 installation to cause false positives in the other tests (see FAQ). 
@@ -102,9 +103,13 @@ To run the full test suite
 
 To run a single file
 
-    behave -DBUILDDIR=/home/vagrant/build/ features/api/reverse.feature
+    behave -DBUILDDIR=/home/vagrant/build/ api/lookup/simple.feature
+
+Or a single test by line number
+
+    behave -DBUILDDIR=/home/vagrant/build/ api/lookup/simple.feature:34
     
-To run specific tests you can add tags just before the `Scenario line`, e.g.
+To run specific groups of tests you can add tags just before the `Scenario line`, e.g.
 
     @bug-34
     Scenario: address lookup for non-existing or invalid node, way, relation
@@ -136,7 +141,7 @@ No. Long running Nominatim installations will differ once new import features (o
 bug fixes) get added since those usually only get applied to new/changed data.
 
 Also this document skips the optional Wikipedia data import which affects ranking
-of search results. See [Nominatim installation](http://nominatim.org/release-docs/latest/Installation) for details.
+of search results. See [Nominatim installation](https://nominatim.org/release-docs/latest/admin/Installation) for details.
 
 ##### Why Ubuntu? Can I test CentOS/Fedora/CoreOS/FreeBSD?
 
@@ -155,9 +160,9 @@ You can configure/download other Vagrant boxes from [https://app.vagrantup.com/b
 
 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.
 
-    pgsql://postgres@your-server.com:5432/nominatim_it
+    pgsql:host=your-server.com;port=5432;user=postgres;dbname=nominatim_it
     
-No data import necessary or restarting necessary.
+No data import or restarting necessary.
 
 If the Postgres installation is behind a firewall, you can try
 
@@ -166,7 +171,7 @@ If the Postgres installation is behind a firewall, you can try
 inside the virtual machine. It will map the port to `localhost:9999` and then
 you edit `settings/local.php` with
 
-    @define('CONST_Database_DSN', 'pgsql://postgres@localhost:9999/nominatim_it');
+    @define('CONST_Database_DSN', 'pgsql:host=localhost;port=9999;user=postgres;dbname=nominatim_it');
 
 To access postgres directly remember to specify the hostname, e.g. `psql --host localhost --port 9999 nominatim_it`