X-Git-Url: https://git.openstreetmap.org./nominatim.git/blobdiff_plain/937c8ba23187e99358c234bb064fe83b0ddcddf4..7c869701f02369873c5573236398ec885c4a951f:/VAGRANT.md?ds=sidebyside diff --git a/VAGRANT.md b/VAGRANT.md index 2aafb7de..819c6071 100644 --- a/VAGRANT.md +++ b/VAGRANT.md @@ -1,6 +1,6 @@ # Install Nominatim in a virtual machine for development and testing -This document describes how you can install Nominatim inside a Ubuntu 16 +This document describes how you can install Nominatim inside a Ubuntu 22 virtual machine on your desktop/laptop (host machine). The goal is to give you a development environment to easily edit code and run the test suite without affecting the rest of your system. @@ -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 @@ -56,7 +56,7 @@ is. ## Development Vagrant maps the virtual machine's port 8089 to your host machine. Thus you can -see Nominatim in action on [locahost:8089](http://localhost:8089/nominatim/). +see Nominatim in action on [localhost:8089](http://localhost:8089/nominatim/). 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. @@ -69,8 +69,7 @@ installation. PHP errors are written to `/var/log/apache2/error.log`. With `echo` and `var_dump()` you write into the output (HTML/XML/JSON) when -you either add `&debug=1` to the URL (preferred) or set -`@define('CONST_Debug', true);` in `settings/local.php`. +you either add `&debug=1` to the URL. In the Python BDD test you can use `logger.info()` for temporary debug statements. @@ -91,7 +90,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). @@ -103,11 +102,11 @@ 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/ features/api/reverse.feature:34 + behave -DBUILDDIR=/home/vagrant/build/ api/lookup/simple.feature:34 To run specific groups of tests you can add tags just before the `Scenario line`, e.g. @@ -130,6 +129,10 @@ and then Yes, Vagrant and Virtualbox can be installed on MS Windows just fine. You need a 64bit version of Windows. +##### Will it run on Apple Silicon? + +You might need to replace Virtualbox with [Parallels](https://www.parallels.com/products/desktop/). +There is no free/open source version of Parallels. ##### Why Monaco, can I use another country? @@ -141,11 +144,12 @@ 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? -There is a Vagrant script for CentOS available, but the Nominatim directory +There used to be a Vagrant script for CentOS available, but the Nominatim directory isn't symlinked/mounted to the host which makes development trickier. We used it mainly for debugging installation with SELinux. @@ -154,26 +158,30 @@ 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. -You can configure/download other Vagrant boxes from [https://app.vagrantup.com/boxes/search](https://app.vagrantup.com/boxes/search). +You can configure/download other Vagrant boxes from +[https://app.vagrantup.com/boxes/search](https://app.vagrantup.com/boxes/search). ##### How can I connect to an existing database? -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. +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 the `.env` in your +project directory and point Nominatim to it. - pgsql://postgres@your-server.com:5432/nominatim_it - -No data import necessary or restarting necessary. + NOMINATIM_DATABASE_DSN="pgsql:host=your-server.com;port=5432;user=postgres;dbname=nominatim_it + +No data import or restarting necessary. If the Postgres installation is behind a firewall, you can try ssh -L 9999:localhost:5432 your-username@your-server.com inside the virtual machine. It will map the port to `localhost:9999` and then -you edit `settings/local.php` with +you edit `.env` file with - @define('CONST_Database_DSN', 'pgsql://postgres@localhost:9999/nominatim_it'); + NOMINATIM_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` +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"?