Merge remote-tracking branch 'upstream/master'

[nominatim.git] / VAGRANT.md

diff --git a/VAGRANT.md b/VAGRANT.md
index d97fb3f788d2531490b30003d9934016214d6535..41d3024efe5749abf2e9841bc5ebb8cbcd348299 100644 (file)
--- a/VAGRANT.md
+++ b/VAGRANT.md
@@ -17,7 +17,7 @@ is.
 
 3. Nominatim 
 
 
 3. Nominatim 
 

-        git clone --recursive https://github.com/twain47/Nominatim.git
+        git clone --recursive https://github.com/openstreetmap/Nominatim.git

 
     If you haven't used `--recursive`, then you can load the submodules using
     
 
     If you haven't used `--recursive`, then you can load the submodules using
     


@@ -30,30 +30,30 @@ is.
 
 1. Start the virtual machine
 
 
 1. Start the virtual machine
 

-        vagrant up
+        vagrant up ubuntu

 
 2. Log into the virtual machine
 
 
 2. Log into the virtual machine
 

-        vagrant ssh
+        vagrant ssh ubuntu

 
 3. Import a small country (Monaco)
 
 
 3. Import a small country (Monaco)
 

-    You need to give the virtual machine more memory (2GB) for an import, see `Vagrantfile`.
+    You need to give the virtual machine more memory (2GB) for an import,
+    see `Vagrantfile`. Otherwise 1GB is enough.

     
     See the FAQ how to skip this step and point Nominatim to an existing database.
 
     
     See the FAQ how to skip this step and point Nominatim to an existing database.
 

-  ```
-  # inside the virtual machine:
-  cd Nominatim
-    wget --no-verbose --output-document=data/monaco.osm.pbf http://download.geofabrik.de/europe/monaco-latest.osm.pbf
-    utils/setup.php --osm-file data/monaco.osm.pbf --osm2pgsql-cache 1000 --all | tee monaco.$$.log
-    ./utils/specialphrases.php --countries > data/specialphrases_countries.sql
-    psql -d nominatim -f data/specialphrases_countries.sql
-    ```
+      ```
+      # inside the virtual machine:
+      mkdir data
+      cd build
+      wget --no-verbose --output-document=../data/monaco.osm.pbf http://download.geofabrik.de/europe/monaco-latest.osm.pbf
+      ./utils/setup.php --osm-file ../data/monaco.osm.pbf --osm2pgsql-cache 1000 --all 2>&1 | tee monaco.$$.log
+      ```

 
 

-  To repeat an import you'd need to delete the database first
+    To repeat an import you'd need to delete the database first

 
 

-        dropdb --username postgres -if-exists nominatim
+        dropdb --if-exists nominatim

 
 
 
 
 
 


@@ -102,7 +102,7 @@ and then
 
 ## Running unit tests
 
 
 ## Running unit tests
 

-    cd ~/Nominatim/tests-php
+    cd ~/Nominatim/tests/php

     phpunit ./
 
 
     phpunit ./
 
 


@@ -128,11 +128,13 @@ 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
 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 instllation](http://wiki.openstreetmap.org/wiki/Nominatim/Installation) for details.
+of search results. See [Nominatim installation](http://wiki.openstreetmap.org/wiki/Nominatim/Installation) for details.

 
 

-##### Why Ubuntu, can I test CentOS/CoreOS/FreeBSD?
+##### Why Ubuntu and CentOS, can I test CentOS/CoreOS/FreeBSD?

 
 

-In general Nominatim will run in all these environment. The installation steps
+There is a Vagrant script for CentOS available. Simply start your box
+with `vagrant up centos` and then log in with `vagrant ssh centos`.
+In general Nominatim will also run in the other environments. The installation steps

 are slightly different, e.g. the name of the package manager, Apache2 package
 name, location of files. We chose Ubuntu because that is closest to the
 nominatim.openstreetmap.org production environment.
 are slightly different, e.g. the name of the package manager, Apache2 package
 name, location of files. We chose Ubuntu because that is closest to the
 nominatim.openstreetmap.org production environment.


@@ -157,6 +159,8 @@ you edit `settings/local.php` with
 
     pgsql://postgres@localhost:9999/nominatim_it
 
 
     pgsql://postgres@localhost:9999/nominatim_it
 

+To access postgres directly remember to specify the hostname, e.g. `psql --host localhost --port 9999 nominatim_it`
+

 
 ##### My computer is slow and the import takes too long. Can I start the virtual machine "in the cloud"?
 
 
 ##### My computer is slow and the import takes too long. Can I start the virtual machine "in the cloud"?