Bug 1328874 - Add Vagrantfile for production-like development VMs

1 files changed, 77 insertions, 0 deletions

diff --git a/README.rst b/README.rst
new file mode 100644
index 000000000..8eb5d1761
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,77 @@
+=========================
+BMO: bugzilla.mozilla.org
+=========================
+
+BMO is a Mozilla's highly customized version of Bugzilla.
+
+If you are looking to run bugzilla, you should see https://github.com/bugzilla/bugzilla.
+
+If you want to contribute to BMO, you can fork this repo and get a local copy
+of BMO running in a few minutes.
+
+Install Vagrant
+===============
+
+You will need to install the following software:
+
+* Vagrant 1.9.1 or later
+
+Doing this on OSX can be accomplished with homebrew:
+
+.. code-block:: bash
+
+    brew install vagrant
+
+For Ubuntu 16.04:
+download the vagrant .dpkg directly from https://vagrantup.com,
+the one that ships with Ubuntu is too old.
+
+Setup Vagrant VMs
+=================
+
+From your BMO checkout run the following command
+
+.. code-block:: bash
+
+    vagrant up
+
+Depending on your machine, this will take a few minutes to much longer
+depending on your internet connection speed and the speed of your computer.
+
+If this fails, please file a bug `using this link <https://bugzilla.mozilla.org/enter_bug.cgi?assigned_to=nobody%40mozilla.org&bug_file_loc=http%3A%2F%2F&bug_ignored=0&bug_severity=normal&bug_status=NEW&cf_fx_iteration=---&cf_fx_points=---&component=Developer%20Box&contenttypemethod=autodetect&contenttypeselection=text%2Fplain&defined_groups=1&flag_type-254=X&flag_type-4=X&flag_type-607=X&flag_type-791=X&flag_type-800=X&flag_type-803=X&form_name=enter_bug&maketemplate=Remember%20values%20as%20bookmarkable%20template&op_sys=Unspecified&priority=--&product=bugzilla.mozilla.org&rep_platform=Unspecified&target_milestone=---&version=Production>`__
+
+Otherwise, you should have a working bmo developer machine setup!
+
+To test it, you'll want to add an entry to /etc/hosts
+for bmo-web.vm pointing to 192.168.3.43
+
+After that, you should be able to visit http://bmo-web.vm/ from your browser.
+You can login as vagrant@bmo-web.vm with the password "vagrant01!" (without quotes).
+
+Making Changes and Seeing them
+==============================
+
+After editing files in the bmo directory, you will need to run
+
+.. code-block:: bash
+
+    vagrant rsync && vagrant provision web
+
+to see the changes applied to your vagrant VM.
+
+Technical Details
+=================
+
+This is a very complete but scaled-down version of production BMO.  It is using
+roughly the same RPMS (centos 6 vs. EL 6 in production) and the same perl
+dependencies (via https://github.com/mozilla-bteam/carton-bundles).
+
+It includes most of the products, groups, and users too (with the users having
+their password reset as mentioned above). Email is disabled for all users,
+however it is safe to enable email as the box is configured to send all email
+to the 'vagrant' user on the web vm.
+
+Most of the cron jobs and the jobqueue daemon are running.  The push connector
+is not currently configured, nor is it configured to talk to Pulse.
+
+It is configured to use memcached as well.