diff --git a/README.md b/README.md index 51b51c9..56f352a 100644 --- a/README.md +++ b/README.md @@ -6,32 +6,37 @@ are managed by Vagrant. Kalastack was built to run primarily on Ubuntu Server 12 ## Quickstart -Kalastack requires Vagrant and VirtualBox to be run correctly. Before you begin please download both. -Notes: This has only been tested on Mac OSX 1.8 and with Vagrant 1.1.2 and VirtualBox 4.2.8. +Kalastack requires [Vagrant 1.1.2](http://downloads.vagrantup.com/tags/v1.1.2) and [VirtualBox 4.28](http://download.virtualbox.org/virtualbox/4.2.8/) to be run correctly. Before you begin please download both. +Notes: At this time, Kalastack is actively tested on Mac OSX 1.8 and with Vagrant 1.1.2 and VirtualBox 4.2.8. -Once you have downloaded and installed both Vagrant and Virtual box please do the following: +Once you have downloaded and installed both Vagrant and Virtual box, +you can build out the complete stack: -1. mkdir ~/kalastack -2. cd ~/kalastack -3. git clone git://github.com/kalamuna/kalastack.git ./ -4. vagrant box add kalabox http://files.vagrantup.com/precise64.box -5. vagrant up kalabox --provision-with=shell,puppet_server + $ mkdir ~/kalastack + $ cd ~/kalastack + $ git clone git://github.com/kalamuna/kalastack.git ./ + $ vagrant box add kalabox http://files.vagrantup.com/precise64.box + $ vagrant up kalabox --provision-with=shell,puppet_server -This should build out the complete stack. To ssh into your server run vagrant ssh from ~/kalastack. +To ssh into your server, from within ~/kalastack, issue: + + $ vagrant ssh ## Post Install Checks ### VHOSTS -Add the following entry to /etc/hosts +Add the following entry to /etc/hosts on your host system - 192.168.42.10 start.kala php.kala grind.kala kala + 192.168.42.10 start.kala php.kala grind.kala kala + +On Windows XP this is located at c:\WINDOWS\system32\drivers\etc\hosts -* On Windows XP this is located at c:\WINDOWS\system32\drivers\etc\hosts +You should now be able to access http://start.kala in your browser ### YOUR FILES -Kalastack uses NFS file sharing. You can access your server webroot at ~/kalabox/www on you host +Kalastack uses NFS file sharing. You can access your server webroot at ~/kalabox/www on your host machine. This way you can use your local IDE to edit files on your server. ## Working with Pantheon @@ -39,17 +44,17 @@ machine. This way you can use your local IDE to edit files on your server. ### SITE ALIASES The first step to working with Pantheon is to get your site aliases. These are -available for download on your Pantheon account page. You will need to put the -downloaded file into ~/kalabox/drush on your host machine. You can verify that they are -functioning correctly by running "drush sa" on your Kalastack. +available for download on your Pantheon account page. You will need to rename and put the +downloaded file into ~/kalabox/drush/aliases.drushrc.php on your host machine. You can verify +your aliases are functioning correctly by running "drush sa" on your Kalastack. ## SSH KEYS -You are also going to want to make sure you creat and add your Kalabox ssh public key to -pantheon. +You are also going to want to make sure you create and add your Kalabox ssh public key to +Pantheon. This can be a little tricky. See [how to participate](https://github.com/kalamuna/kalastack/wiki/How-to-Participate#ssh-key) for more info - ssh-keygen - cat ~/.ssh/id_rsa.pub + $ ssh-keygen + $ cat ~/.ssh/id_rsa.pub ## DRUSH @@ -61,66 +66,65 @@ naming convention as your pantheon aliases (PANTHEON.SITENAME.ENV) but you will omit the @. You are using the alias name as an argument, not as an alias. Here are the commands. - 1. drush build SITENAME.dev + $ drush build SITENAME.dev + +Will completely build your Pantheon site on your Kalastack, this will +edit settings.php and set up a vhost. After running this command and +adding your server name to your hosts /etc/hosts file you should be +able to visit the site in your web browser. + + $ drush krefresh SITENAME.dev + +Will refresh the code, database and files on your Kalastack from your +pantheon site - Will completely build your pantheon site on your Kalastack, this will - edit settings.php and set up a vhost. After running this command and - adding your server name to your hosts /etc/hosts file you should be - able to browse to the site. + $ drush crush SITENAME.dev - 2. drush krefresh SITENAME.dev +Will completely remove SITENAME.dev from your Kalastack. - Will refresh the code, database and files on your Kalastack from your - pantheon site + $ drush kala - 3. drush crush SITENAME.dev +Will show helpful info - Will completely remove SITENAME.dev from your Kalastack. - - 4. drush kala - - Will show helpful info - - 5. drush code SITENAME.dev + $ drush code SITENAME.dev - Will either git clone or git pull from your pantheon codebase to your - Kalabox at /var/www/SITENAME on your guest and ~/kalabox/www/SITENAME - on your guest. - - 6. drush data SITENAME.dev +Will either git clone or git pull from your Pantheon codebase to your +Kalabox at /var/www/SITENAME on your guest and ~/kalabox/www/SITENAME +on your guest. - Will either download and import from your pantheon database to your - Kalabox at kala:SITENAME_kala - - 7. drush files SITENAME.dev + $ drush data SITENAME.dev - Will sync your pantheon files to your Kalastack at - /var/www/SITENAME/sites/default/files on your stack and - ~/kalabox/www/SITENAME/sites/default/files on your host. - - 8. drush vhost SITENAME.dev +Will download and import your Pantheon dev MySQL database to your +Kalabox in a DB named SITENAME_kala + + $ drush files SITENAME.dev + +Will sync your pantheon dev files to your Kalastack, accessible from +/var/www/SITENAME/sites/default/files when ssh'd in to your stack, and from +~/kalabox/www/SITENAME/sites/default/files on your host. + + $ drush vhost SITENAME.dev + +Will build and enable a nginx vhost file of your Pantheon site on your +Kalastack at SITENAME.kala - Will build and enable a nginx vhost file of your pantheon site on your - Kalastack at SITENAME.kala ### UPDATING YOUR HOST HOSTS FILE Remember that the Kalastack does not automatically update the /etc/hosts file on -your HOST so you will have to add the following line manually. - - "192.168.42.10 SITENAME.kala" +your HOST so you will have to add each new site line manually in order +to visit http://SITENAME.kala in your web browser! -You should now be able to navigate to SITENAME.kala in your browser and get to -your site! + 192.168.42.10 SITENAME.kala -## Xdebux +## Xdebug Kalastack ships with xdebug for both debugging and profiling. ### DEBUGGING -For debugging we recommend you use an IDE on your host OS such as netbeans or -eclipse. The xdebug setup should already be done on the Kalabox end so you should +Debugging is best done with an IDE such as netbeans or eclipse on your host OS. +The xdebug setup should already be done on the Kalabox end so you should only need to set up your IDE. Here is some useful documentation to help: @@ -129,18 +133,18 @@ http://wiki.netbeans.org/HowToConfigureXDebug ### PROFILING -For profiling we recommend you use the webgrind client which comes preconfigured -with your Kalabox and is located at grind.kala. +For profiling, we recommend you use the webgrind client which comes preconfigured +with your Kalabox and is located at http://grind.kala. Profiling on every page has a performance impact so you must trigger what pages -you want to profile. You can do this manually by appending ?XDEBUG_PROFILE to +you want to profile by manually appending ?XDEBUG_PROFILE to the URL (see http://xdebug.org/docs/profiler for more detail) and then -checking webgrind. +checking [webgrind](http://grind.kala). -Many broswers also offer tools/plugins to turn profiling on and off. +Many broswers also offer automated tools/plugins to turn profiling on and off. https://chrome.google.com/webstore/detail/xdebug-helper/eadndfjplgieldjbigjakmdgkmoaaaoc ################################################################################ -(C) 2012 Kalamuna LLC +(C) 2013 Kalamuna LLC