Install and Run Allura - Vagrant

Install Vagrant and VirtualBox

Install Vagrant by following the instructions here: http://docs.vagrantup.com/v2/installation/. The latest Allura VM was built with Vagrant v1.1.5, so make sure you have that version or later.

Vagrant uses VirtualBox, so install that from https://www.virtualbox.org/

Install Allura

First, we'll create and boot the Allura VM. Note that this will download a large (~700MB) file

$ cd ~ && mkdir vagrant-allura && cd vagrant-allura
$ git clone https://git-wip-us.apache.org/repos/asf/allura.git allura
$ vagrant box add allura http://sourceforge.net/projects/allura/files/vagrant/allura-ubuntu-1204-server-amd64-20141217.box
$ vagrant init allura
$ vagrant up

Connect to the VM and start Allura

Now that the VM is running, let's connect to it and start the Allura platform:

$ vagrant ssh  # password is "vagrant"
(env-allura)vagrant@vagrant-ubuntu-precise-64:~/src/allura$ ./update.sh
... lots of console output here ...
... its updating to the latest code & dependencies ...
(env-allura)vagrant@vagrant-ubuntu-precise-64:~/src/allura$ ~/start_allura

That's it! Allura is running, and you can browse it from your host OS at http://localhost:8080. To log in as an admin, use username/password root/foo.

Other Stuff You Might Want to Know

  • vagrant ssh connects you to the VM, activates the Allura virtualenv, and puts you in the root of the Allura source tree, a git clone of our public repo.
  • update.sh will get the latest code and dependencies. This will get it current, even if the vagrant box was made a while ago.
  • ~/start_allura is a helper script to make sure all Allura platform services are running. Run it as often as you like and it will do the right thing.
  • The Allura VM is configured with 512MB of RAM by default. For better performance it's recommended that you increase the memory by following the instructions here: http://docs.vagrantup.com/v2/virtualbox/configuration.html . Keep in mind that the VM is running Solr, mongodb, a python app server, and a python background worker!
  • If you are already using port 8080, or want to browse Allura on a different local port, you can change the port-forwarding rule in your Vagrantfile by following these instructions: http://docs.vagrantup.com/v2/networking/forwarded_ports.html
  • The allura source code is shared between the VM and your host machine, so you can develop Allura by editing the files with a regular editor on your host machine.

Related

Wiki: Home