README.vagrant
author Ed Morley <emorley@mozilla.com>
Wed, 01 Apr 2015 14:04:18 +0400
changeset 1519 134bdfcf7e2d4a46ef468d5d4f687b257504c19a
parent 1408 79597a29ab41af5fdd6f955ff31214d09322aa01
permissions -rw-r--r--
Bug 1054977 - Revert EOL changes to make future local use easier TBPL has now been switched off in production, so the src repo is no longer being used. However in case anyone in the future wants to try using TBPL locally (eg for a side by side comparison when debugging a Treeherder issue), let's revert a bunch of the EOL changes we made, so it's not quite so limited in functionality.

---
INSTALL
---

TBPL now has a Vagrant project file, which Vagrant will use to set up a VirtualBox VM
from scratch (no manual OS install required), with all the dependencies required to
run a local TBPL server instance. You will need approximately 2GB of free disk space.

1) Install the latest Virtualbox from http://www.virtualbox.org/

2) Install the latest Vagrant from http://vagrantup.com/

3) hg clone https://hg.mozilla.org/webtools/tbpl/ tbpl

4) Add the following to /etc/hosts (C:\Windows\System32\drivers\etc\hosts on Windows):
10.33.33.33	tbpl

5) From the toplevel TBPL directory, run:
   $ vagrant up

6) That's it! Open http://tbpl/ and enjoy your Mozilla TBPL environment!

Optional: For improved I/O performance, install an NFS server. See:
http://docs.vagrantup.com/v2/synced-folders/nfs.html

---
CONNECTING TO THE VM
---

If you should need to SSH into your VM:
$ vagrant ssh

Or on Windows use PuTTY (http://www.chiark.greenend.org.uk/~sgtatham/putty/) and convert
the key given after running 'vagrant ssh' into a .ppk using PuTTYgen.

---
phpMyAdmin
---

The Vagrant environment installs phpMyAdmin (not present in production), accessed via:
http://tbpl/phpmyadmin
Username: tbpl
Password: tbpl

---
KNOWN ISSUES
---

* depends on external buildbot/hgpushlog/bugzilla/etc
* On Windows, to avoid multiple UAC prompts launch cmd.exe as admin, when giving vagrant commands.
* If Vagrant hangs for more than a few minutes at "Waiting for VM to boot.", you may have hit a 
  VirtualBox bug with certain network configurations. For workarounds, see:
  https://github.com/mitchellh/vagrant/issues/455#issuecomment-1741950
  https://github.com/mitchellh/vagrant/issues/391