aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorDave Whiteland <dave@mysociety.org>2015-02-11 11:54:28 +0000
committerDave Whiteland <dave@mysociety.org>2015-02-11 11:54:28 +0000
commit0c2596903c85ff9b51879b29ce948f5544412b7f (patch)
treeedce7c6effe6964d73e4c107e01efdf16aad2e88 /docs
parent8c392ca65ed169a6ab188d6261f0b1f7ff2bc403 (diff)
update Vagrant page
Specically I've needed to shut the server down on my Vagrant without having access to the terminal window that was running the server, and was troubled by the classic docs error of showing how to start something without also knowing how to stop it (driving instructors: show the brake pedal before showing the accelerator ;-) )
Diffstat (limited to 'docs')
-rw-r--r--docs/installing/vagrant.md51
1 files changed, 38 insertions, 13 deletions
diff --git a/docs/installing/vagrant.md b/docs/installing/vagrant.md
index 8938d496b..e4b90584d 100644
--- a/docs/installing/vagrant.md
+++ b/docs/installing/vagrant.md
@@ -5,35 +5,38 @@ title: Vagrant
# Alaveteli using Vagrant
<p class="lead">
-Vagrant provides an easy method to set up virtual development environments; for
-further information see <a href="http://www.vagrantup.com">the Vagrant website</a>.
-We bundle an example Vagrantfile in the repository, which runs the
-<a href="{{ site.baseurl }}docs/installing/script/">install script</a> for you.
+ <a href="https://www.vagrantup.com">Vagrant</a> provides an easy method to set
+ up virtual development environments We bundle an example Vagrantfile in the
+ repository, which runs the
+ <a href="{{ site.baseurl}}docs/installing/script/">install script</a> for you.
</p>
Note that this is just one of [several ways to install Alaveteli]({{ site.baseurl }}docs/installing/).
The included steps will use vagrant to create a development environment
-where you can run the test suite, the development server and make
+where you can run the test suite and the development server, and make
changes to the codebase.
-The basic process is to create a base virtual machine, and then
+The basic process is to create a base virtual machine (VM), and then
provision it with the software packages and setup needed. The supplied
scripts will create you a Vagrant VM based on the server edition of
Ubuntu 12.04 LTS that contains everything you need to work on Alaveteli.
-1. Get a copy of Alaveteli from GitHub and create the Vagrant instance.
- This will provision the system and can take some time - usually at
- least 20 minutes.
+1. Get a copy of Alaveteli from
+ <a href="{{ site.baseurl }}docs/glossary/#git" class="glossary__link">GitHub</a>:
# on your machine
$ git clone git@github.com:mysociety/alaveteli.git
$ cd alaveteli
$ git submodule update --init
+
+2. Create the Vagrant VM. This will provision the system and can take some time
+ &mdash; sometimes as long as 20 minutes.
+
$ vagrant --no-color up
-2. You should now be able to ssh in to the Vagrant guest OS and run the
- test suite:
+3. You should now be able to log in to the Vagrant guest OS with `ssh` and run
+ the test suite:
$ vagrant ssh
@@ -42,12 +45,34 @@ Ubuntu 12.04 LTS that contains everything you need to work on Alaveteli.
$ bundle exec rake spec
-3. Run the rails server and visit the application in your host browser
- at http://10.10.10.30:3000
+4. Run the rails server:
# in the virtual machine terminal
bundle exec rails server
+You can now visit the application in your browser (on the same machine that is
+running Vagrant) at `http://10.10.10.30:3000`.
+
+If you need to stop the server, simply press **Ctl-C** within that shell.
+
+It's also possible to stop the server from a different terminal shell in the
+Vagrant VM. Log in, find the process ID for the Alaveteli server (in the example
+below, this is `1234`), and issue the `kill` command:
+
+ $ vagrant ssh
+
+ # now in a terminal on the virtual machine
+ $ cat /home/vagrant/alaveteli/tmp/pids/server.pid
+ 1234
+ $ kill -2 1234
+
+Alternatively, you can stop down the whole VM without deleting it with the
+command <code>vagrant&nbsp;halt</code>
+on the host command line. To start it up again, go to step 2, above &mdash; it
+won't take so long this time, because the files are already in place.
+See [the Vagrant documentation](https://docs.vagrantup.com/v2/)
+for full instructions on using Vagrant.
+
## What next?
Check out the [next steps]({{ site.baseurl }}docs/installing/next_steps/).