Merge remote-tracking branch 'upstream/pull/4970'

[rails.git] / VAGRANT.md

diff --git a/VAGRANT.md b/VAGRANT.md
index 03861e18fbd3a57ac76512fa29ff7db05c236714..ed84eed57a823df9d000ac29a0d77979d224cb69 100644 (file)
--- a/VAGRANT.md
+++ b/VAGRANT.md
@@ -6,15 +6,19 @@ On Ubuntu, it should be as simple as:
 sudo apt-get install vagrant
 ```
 
-Other Linux distributions should have similar installation instructions using `yum` or similar.
+Other Linux distributions should have similar installation instructions using `dnf`, `pacman`, or similar.
 
-Installers are available for Mac OS X and Windows, please see the [Vagrant project download page](http://www.vagrantup.com/downloads) for more information.
+Installers are available for Mac OS X and Windows, please see the [Vagrant project download page](https://www.vagrantup.com/downloads.html) for more information.
+
+We currently support three Vagrant providers, namely `virtualbox`, `lxc` and `libvirt`. You might need to install one of these, for example virtualbox, and specify the provider, e.g. `--provider virtualbox`, when setting up your environment.
 
 # Setting up openstreetmap-website
 
-Once Vagrant has been installed, you can start an environment by changing to the directory which contains the Vagrantfile and typing:
+Once Vagrant has been installed, you can start an environment by checking out the openstreetmap-website code if you haven't already, then changing to the directory which contains the Vagrantfile by typing:
 
 ```
+git clone git@github.com:openstreetmap/openstreetmap-website.git
+cd openstreetmap-website
 vagrant up
 ```
 
@@ -28,7 +32,17 @@ Within this login shell, you can do development, run the server or the tests. Fo
 
 ```
 cd /srv/openstreetmap-website/
-rake test
+bundle exec rails test:all
+```
+
+To access the web pages you run the following commands then access the site in your [local browser](http://localhost:3000):
+
+```
+vagrant ssh
+cd /srv/openstreetmap-website/
+bundle exec rails server --binding=0.0.0.0
 ```
 
+You edit the code on your computer using the code editor you are used to using, then through shared folders the code is updated on the VM instantly.
+
 You should run the tests before submitting any patch or Pull Request back to the original repository. Please see [CONTRIBUTING.md](CONTRIBUTING.md) for more information.