Home

Dreambox

Getting Started

To use the example Vagrantfile as a starting point, pull the example Vagrantfile into your project directory:

curl https://raw.githubusercontent.com/goodguyry/dreambox/master/Vagrantfile-example > Vagrantfile

To add Dreambox to an existing project, add the following to your project's Vagrantfile:

config.vm.box = "goodguyry/dreambox"

Or, start from scratch by initializing a new project using this box:

vagrant init goodguyry/dreambox

Additional Setup

$user_vars

DreamBox is meant to replicate both the hosting environment and the shared hosting setup (the full path to the web root).

A user setup script is automatically run by Dreambox during vagrant up. The following Hash must be in your Vagrantfile for Dreambox to provision correctly:

# Environment variables for automating user_setup
$user_vars = {
  'DREAMBOX_USER_NAME' => 'my-user',      # DreamHost username
  'DREAMBOX_SITE_ROOT' => 'example.com',  # Site root directory
  'DREAMBOX_PROJECT_DIR' => 'web'         # Relative to project root
}

See the example Vagrantfile for a basic Dreambox Vagrantfile setup.

MySQL Setup (Optional)

To set a password for the root mysql user, run mysql_secure_installation from within the VM.

vagrant up
vagrant ssh
mysql_secure_installation