isabella232 / vip-go-quickstart

Deprecated.

THIS PROJECT IS DEPRECATED. SEE LOCAL DEVELOPMENT FOR VIP GO FOR MORE UP-TO-DATE INFORMATION

Overview

VIP Go Quickstart is a local development environment for developers creating and maintaining sites on the WordPress.com VIP Go hosting platform. The goal is to provide developers with an environment which can be initialised quickly, along with some tools we believe developers will find useful (more info).

How to use VIP Go Quickstart

Pre-requisites

0. Install Vagrant and VirtualBox 4.3
   • Windows users will need to disable Hyper-V
   • Windows 10 users will require the fix here to get VirtualBox 4.3 working
1. Networking requires Zeroconf:
   • OS X: You already have Zeroconf, nothing to do here!
   • Windows: If you have iTunes, you already have this. Otherwise, you need to install Bonjour
   • Ubuntu: Run the following command sudo apt-get install avahi-dnsconfd

Installation

1. Clone this repository to your local machine
2. Move to VIP Go Quickstart directory
3. Initialize the Vagrant using the included qs-init.sh script

qs-init.sh arguments:

• --client: unique slug to distinguish this instance's database instance; alphanumeric and hyphens only, not a domain name for the Quickstart instance
• --git-repo: clone URL for a Go-structured git repository, based on the VIP Skeleton repository
• --git-branch: a branch of the Git repository, the content of the branch must be based on the VIP Skeleton repository (optional parameter, defaults to master)
• --theme: slug of the theme to activate during initialization
• --wxr: WordPress export file to import during initialization
• --up: call vagrant up to set up Vagrant for the first time; thereafter, uses vagrant provision for faster re-initialization

cd ~
git clone https://github.com/Automattic/vip-go-quickstart.git vip-go-qs
cd vip-go-qs
./qs-init.sh --client UNIQUE_SLUG --git-repo GIT_REMOTE --git-branch GIT_BRANCH [--theme DIRECTORY_NAME] [--wxr WXR_TO_IMPORT] [--up]

You'll be prompted for your local machine (aka the “host machine”) password during the booting process of Vagrant as an NFS filesystem is being set up. The NFS filesystem is used for sharing folders from the Go-structured git repository with Vagrant. During the initialization process, the provided git repository is checked out into ./go-client-repo/. You can access this directory to easily develop from your host machine using your favorite tools, IDE, etc.

Switching between client codebases

Rather than create separate Quickstart instances for every client, VIP Go's Quickstart supports easy switching between git repositories without needing to provision an entire new VM.

To switch to a new codebase, simply call qs-init.sh again with new --client and --git-repo values, as well as any optional arguments. The optional --up argument is only necessary if you've never called qs-init.sh with it, or if you've invoked vagrant destroy.

Viewing your WordPress site

Navigate to go-vip.local in your browser and you should land on a fresh WordPress site.

Entering WordPress administration

Once you are able to view the site via browser, you can also visit go-vip.local/wp-admin and log in using following credentials:

user: wordpress

password: wordpress

Developing themes and plugins

There are two shared folders: ~/vip-quickstart/themes and ~/vip-quickstart/plugins which are accessible from both the host and guest (i.e. the Vagrant VM, not the host) machines. All changes are automatically mirrored between the two (host and guest) systems, which means that you can edit files on either system and see the changes live on vip.local site.

Those folders are mounted to /var/www/wp-content/themes and /var/www/wp-content/plugins on the guest machine.

The root directory for WordPress installation on the guest machine is /var/www and, once you have your Vagrant running (see above), this directory can be accessed via vagrant ssh command:

vagrant ssh
cd /var/www

Viewing logs

The PHP log is written to /var/log/php/error.log on the guest machine. Once you have your Vagrant running (see above), you can view the log as follows:

vagrant ssh
less +F /var/log/php/error.log

N.B. The less +F command and option starts following the log file in the less file viewer, with new lines being appended as they are written to the log. To stop following the log, i.e. to stop new lines being appended in less, you can type ctrl+c, and to start again, you can type F.

Compatability with VIP Go

VIP Go Quickstart is a local environment which allows you to get up and running, writing VIP-compatible code, as quickly as possible. We use system packages when they are available, to make maintenance easier, rather than compiling custom binaries that exactly replicate VIP Go. Additionally, we may intentionally change software versions ahead of VIP Go upgrades to help test comparability before we make the upgrade in production.

VIP Go Quickstart should not be used as an indication of software versions running in production. All code should be tested in a VIP Go staging or development environment before being pushed to production. If you have questions about specific software versions or packages running in production, please open a ticket with VIP support.

Troubleshooting

Vagrant hangs during installation

In OS X's firewall, if the "Block all incoming connections" option is enabled, Vagrant hangs when mounting NFS and the VM will never start.

To solve:

1. Navigate to System Preferences > Security & Privacy > Firewall > Firewall Options in your Mac
2. Uncheck "Block all incoming connections"
3. Check "Automatically allow signed software to receive incoming connections"

What You Get

• Ubuntu 14.04
• WordPress trunk
• VIP MU Plugins - including Jetpack, VaultPress and Akismet
• WordPress site
• WP-CLI
• MySQL
• PHP
• Nginx