forked from kalabox/kalabox-app-pantheon
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
35 additions
and
42 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,54 +1,58 @@ | ||
# Kalabox Pantheon App | ||
## Overview | ||
## Overview | ||
|
||
By default Kalabox can pull apps from and push apps to Pantheon... but this is much more than basic push/pull integration. Kalabox will build out a local Pantheon environment for each app. This means `solr`, `redis`, `ssl` and `terminus` all work just like they do on Pantheon. You can also use `drush`, `wp-cli`, `ssl` and toggle `php` version. YAY! | ||
|
||
## Creating and starting a Pantheon app | ||
|
||
This will spin up a Pantheon-on-Kalabox environment, set up relevant tools like `terminus`, `drush` and `wp-cli` and pull down the site and environment that you choose. | ||
This will spin up a Pantheon-on-Kalabox environment, set up relevant tools like `terminus`, `drush` and `wp-cli` and pull down the site and environment that you choose. | ||
|
||
```bash | ||
cd /dir/i/want/my/app/to/live (usually ~/kalabox/apps) | ||
cd /dir/i/want/my/app/to/live (usually ~/Desktop/apps) | ||
kbox create pantheon | ||
? Pantheon dashboard email: [email protected] | ||
? Pantheon dashboard password: ********** | ||
? What do you want to do? Pull a pre-existing site from Pantheon | ||
? Which site? greenbiz | ||
? Which environment? gbz-870 | ||
? What will you call this monster you have created: greenbiz | ||
? Php version? 5.3.29 | ||
? Git username? Mike Pirog | ||
? Git email? [email protected] | ||
cd greenbiz | ||
kbox start # Site is available at http(s)://greenbiz.kbox | ||
? Choose a Pantheon account. [email protected] | ||
? Which site? kalabox-eight | ||
? Which environment? dev | ||
? What will you call this monster you have created: (kalabox-eight) eight | ||
cd eight | ||
kbox start # Site is available at http(s)://eight.kbox | ||
``` | ||
|
||
## Tools and working with your code | ||
|
||
You can run various Pantheon-helpful took like terminus. | ||
You can run various Pantheon-helpful tools like terminus. | ||
|
||
```bash | ||
Usage: kbox <command> [-- <options>] | ||
|
||
Examples: | ||
kbox drush -- --drush-version=5 | ||
kbox terminus -- --h | ||
kbox wp | ||
kbox git | ||
kbox rsync | ||
|
||
Commands: | ||
drush Run drush commands. | ||
git Run git commands. | ||
rsync Run rsync commands. | ||
terminus Run terminus commands. | ||
wp Run wp-cli commands. | ||
Global commands that can be run from anywhere | ||
apps Display list of apps. | ||
create | ||
pantheon Creates a Pantheon app. | ||
update Run this after you update your Kalabox code. | ||
version Display the kbox version. | ||
|
||
Actions that can be performed on this app | ||
config Display the kbox application's configuration. | ||
containers Display list of application's installed containers. | ||
destroy Completely destroys and removes an app. | ||
pull Pull down new code and optionally data and files. | ||
push Push up new code and optionally data and files. | ||
rebuild Rebuilds your app while maintaining your app data. | ||
restart Stop and then start a running kbox application. | ||
start Start an installed kbox application. | ||
stop Stop a running kbox application. | ||
|
||
Commands and tools this app can use | ||
drush Run drush commands. | ||
git Run git commands. | ||
rsync Run rsync commands. | ||
terminus Run terminus commands. | ||
wp Run wp-cli commands. | ||
|
||
``` | ||
## Pulling from Pantheon | ||
You can refresh your local code and even your database and files by running `kbox pull` from inside of your Pantheon app. This will pull from the environment you specify during `kbox create`. | ||
You can refresh your local code and even your database and files by running `kbox pull` from inside of your Pantheon app. This will pull from the environment you specify during `kbox create`. | ||
``` | ||
kbox pull -- -h | ||
|
@@ -81,8 +85,6 @@ You can use `https` by just typing in `https://myapp.kbox` in your browser. We s | |
Apache Solr comes in each local Pantheon environment. You can use it the exact same way as you do on Pantheon. Reference the [Pantheon docs](https://pantheon.io/docs/articles/sites/apache-solr/) for more information. | ||
**Currently you will need to use [this patch](https://github.com/pantheon-systems/drops-7/pull/64) to get this to work out of the box. To apply this patch, simply replace the contents of your modules/pantheon/pantheon_apachesolr/pantheon_apachesolr.module file with [this file](https://github.com/kalabox/drops-7/blob/schema-post-box/modules/pantheon/pantheon_apachesolr/pantheon_apachesolr.module). This will be rolled into the `pantheon_apachesolr` module on the next Drupal release.** | ||
|
||
## Redis | ||
Just follow the same instructions from Pantheon to get redis to work locally. | ||
|
@@ -138,14 +140,6 @@ xdebug is set up on your php appserver. Here is an example SublimeText 2 config | |
} | ||
``` | ||
## Current limitations | ||
|
||
This app is still somewhat experimental and a number of improvements are coming. The biggest things still being worked out are | ||
|
||
1. Better support for Wordpress, Drupal 8 and Backdrop | ||
2. Emulation of pantheon's binding info (for things like the CiviCRM starter kit) | ||
3. Importing new sites into Pantheon from start states. | ||
|
||
## Other Resources | ||
* [API docs](http://api.kalabox.me/) | ||
|
@@ -158,4 +152,3 @@ This app is still somewhat experimental and a number of improvements are coming. | |
------------------------------------------------------------------------------------- | ||
(C) 2015 Kalamuna and friends | ||
|