Turnkey TubePress development environment
PHP JavaScript CSS HTML Puppet Ruby
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
src
.gitignore
README.md

README.md

TubePress Development Environment

The TubePress Development Environment (tubepress/dev-environment) is a turnkey virtual machine designed for TubePress development and testing.

Credits

This project is inspired by Varying Vagrant Vagrants and relies heavily on Puppet, Vagrant, VirtualBox, Git, Ubuntu, and thousands of other awesome open source projects too numerous to list.

How to Use

Requirements

On your local machine, you'll need recent versions of the following software:

These packages are all free, open source, and lightweight. Please ensure that you have everything installed before proceeding.

First Start

  1. Start with any local operating system such as Mac OS X, Linux, or Windows.

  2. Clone or extract this repository into a local directory
    • git clone git://github.com/tubepress/dev-environment tubepress-dev-environment

  3. In a command prompt, change into the src/vagrant directory with cd tubepress-dev-environment/src/vagrant

  4. Start the Vagrant environment with vagrant up

    • On your first run, this will take a while (between 5 and 20 minutes, depending on your host machine). Enjoy a beverage while you wait.

    • As the script ends, as an administrator or su password will likely be required to properly modify the hosts file on your local machine.

  5. With your favorite web browser, visit http://tubepress-test.com. If everything went right, you should see the following page:

    tubepress development environment

What Did That Do?

The first time you run vagrant up, a virtual machine with Ubuntu 14.04 is downloaded to your local machine and cached for future use. Once booted, Vagrant uses Puppet to provision the machine with the required software and configuration.

On future runs of vagrant up, Vagrant will only need to apply the requested provisioning and the boot process will take just a few seconds.

Now What?

Now that you're up and running, start poking around and modifying things.

  1. Access the server via the command line with vagrant ssh from your tubepress-dev-environment/src/vagrant directory. You can do almost anything you would do with a standard Ubuntu installation on a full server.

    • MS Windows users: An SSH client is generally not distributed with Windows PCs by default. However, a terminal emulator such as PuTTY will provide access immediately. For detailed instructions on connecting with PuTTY, consult this page.

  2. Power off the box with vagrant halt and turn it back on with vagrant up.

  3. Suspend the box's state in memory with vagrant suspend and bring it right back with vagrant resume.

  4. Every once in a while, reapply provisioning to a running box with vagrant provision.

  5. Destroy the box with vagrant destroy.