{"_id":"kalabox-app-pantheon","_rev":"44-1924d8e72822e4bed586587813f0330a","name":"kalabox-app-pantheon","time":{"modified":"2022-06-19T07:46:06.082Z","created":"2015-07-01T01:11:52.290Z","0.9.1":"2015-07-01T01:11:52.290Z","0.9.2":"2015-07-18T03:13:49.815Z","0.9.3":"2015-07-18T03:50:07.355Z","0.9.4":"2015-07-18T04:26:50.669Z","0.9.5":"2015-07-18T04:50:46.159Z","0.9.6":"2015-07-18T04:55:44.020Z","0.9.7":"2015-07-18T05:20:13.535Z","0.9.8":"2015-07-18T05:58:25.055Z","0.9.9":"2015-07-18T06:33:02.079Z","0.9.10":"2015-07-18T07:32:35.142Z","0.9.11":"2015-07-18T18:03:27.051Z","0.9.12":"2015-07-20T16:07:39.491Z","0.9.13":"2015-07-20T19:46:44.856Z","0.9.14":"2015-08-12T18:52:16.582Z","0.9.15":"2015-08-12T20:44:20.257Z","0.9.16":"2015-08-13T03:29:30.203Z","0.9.17":"2015-08-25T02:32:10.858Z","0.9.18":"2015-08-28T22:50:20.483Z","0.9.19":"2015-08-28T22:53:39.189Z","0.10.1":"2015-09-19T06:20:01.710Z","0.10.2":"2015-09-25T20:18:58.750Z","0.10.3":"2015-10-07T22:04:13.147Z","0.10.4":"2015-10-08T06:34:25.838Z","0.10.5":"2015-10-19T21:45:14.008Z","0.10.6":"2015-10-19T23:38:09.475Z","0.10.7":"2015-10-29T23:46:38.054Z","0.10.8":"2015-11-25T21:29:12.199Z","0.11.0":"2016-01-22T02:26:19.407Z","0.11.1":"2016-01-27T01:41:21.409Z","0.11.2":"2016-02-10T01:11:46.267Z","0.11.3":"2016-02-19T02:43:05.714Z","0.12.0-alpha.1":"2016-03-15T22:43:24.651Z","0.12.0-alpha.3":"2016-03-15T22:47:16.387Z","0.12.0-alpha.4":"2016-03-16T01:10:39.008Z","0.12.0-alpha.5":"2016-03-16T02:41:47.478Z","0.12.0-alpha.6":"2016-03-16T20:32:07.504Z","0.12.0-alpha.7":"2016-03-17T18:31:06.367Z","0.12.0-alpha.8":"2016-03-28T17:31:24.528Z","0.12.0-alpha.10":"2016-04-12T00:35:43.908Z","0.12.0-alpha.12":"2016-05-02T01:37:36.134Z","0.12.0-beta.1":"2016-05-05T02:55:19.949Z"},"maintainers":[{"name":"pirog","email":"mike@kalamuna.com"}],"dist-tags":{"latest":"0.12.0-beta.1"},"description":"Create Pantheon-esque apps on Kalabox.","readme":"# Kalabox Pantheon App\n## Overview\n\nBy 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!\n\n## Creating and starting a Pantheon app\n\nThis 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.\n\n```bash\ncd ~/dir/i/want/my/app/to/live (usually ~/Desktop/apps)\nkbox create pantheon # and follow the prompts\n```\n\nOr you can run non-interactively\n\n```bash\ncd ~/dir/i/want/my/app/to/live (usually ~/Desktop/apps)\nkbox create pantheon -- --email=me@me.com --password=**** --site=pantheon-site --env=pantheon-env --name=myApp\n```\n\n**NOTE:** You **must** issue your `kbox create pantheon` from somewhere inside your `HOME` directory.\n**NOTE:** This 'create' functionality actually comes from the core kalabox-pantheon plugin.\n\n## Tools and working with your code\n\nYou can run various Pantheon-helpful tools like terminus. To see a list of all the things run `kbox` from inside of your app directory.\n\n```bash\nUsage: kbox <command> [-- <options>]\n\nGlobal commands that can be run from anywhere\n  create\n      pantheon     Creates a Pantheon app.\n  env              Print Kalabox environmental vars.\n  list             Display list of apps.\n  update           Run this after you update your Kalabox code.\n  version          Display the kbox version.\n\nActions that can be performed on this app\n  config           Display the kbox application's configuration.\n  destroy          Completely destroys and removes an app.\n  pull             Pull down new code and optionally data and files.\n  push             Push up new code and optionally data and files.\n  rebuild          Rebuilds your app while maintaining your app data.\n  restart          Stop and then start a running kbox application.\n  services         Display connection info for services.\n  start            Start an installed kbox application.\n  stop             Stop a running kbox application.\n\nCommands and tools this app can use\n  bower            Run a bower command\n  composer         Run a php cli command\n  drush            Run a drush 8 command on your codebase\n  git              Run a git command on your codebase\n  grunt            Run a grunt command\n  gulp             Run a gulp command\n  mysql            Drop into a mysql shell\n  node             Run a node command\n  npm              Run a npm command\n  php              Run a php cli command\n  rsync            Run a rsync command on your files directory\n  terminal         'ssh' into your appserver\n  terminus         Run a terminus command\n  wp               Run a wp-cli command on your codebase\n\nSome things that are useful for development\n  down             Bring kbox container engine down.\n  status           Display status of kbox container engine.\n  up               Bring kbox container engine up.\n\nOptions:\n  -h, --help     Display help message.                                 [boolean]\n  -v, --verbose  Use verbose output.                                   [boolean]\n\n```\n\n## Pulling from Pantheon\n\nYou can refresh your local code and even your database and files by running `kbox pull` from inside of your Pantheon app.\n\n```\nkbox pull -- -h\nOptions:\n  -h, --help     Display help message.\n  -v, --verbose  Use verbose output.\n  --database     Pull DB from an env. Options are dev, test, live and none\n  --files        Pull files from an env. Options are dev, test, live and none\n  --newbackup    True to generate a new DB backup\n```\n\n**Important:** To avoid slow pulls on larger sites, Kalabox pulls from Pantheon's database backups, instead of the active database. If you would like to retrieve the most recent version of your database, you will need to indicate y when asked Retrieve latest DB instead of most recent backup? (y/N) or use the --newbackup flag.\n\n## Pushing to Pantheon\n\nYou can easily push up code and even your database and files by running `kbox push`.\n\n```bash\nOptions:\n  -h, --help     Display help message.                                 [boolean]\n  -v, --verbose  Use verbose output.                                   [boolean]\n  -m, --message  Tell us about your change                              [string]\n  --database     Push DB to specific env. Options are dev and none      [string]\n  --files        Push files to a spefic env. Options are dev and none   [string]\n```\n\n## Connecting to your database\n\nYou can connect to your database using a third-party tool such as SequelPro\nor SqlWorkbench. To get the connection info run `kbox services` from inside a running pantheon app.\n\n```\nkbox services\n[\n  {\n    \"name\": \"edge\",\n    \"project\": \"playbox\",\n    \"url\": [\n      \"http://edge.playbox.kbox\",\n      \"https://edge.playbox.kbox\"\n    ]\n  },\n  {\n    \"name\": \"appserver\",\n    \"project\": \"playbox\",\n    \"url\": [\n      \"http://playbox.kbox\",\n      \"https://playbox.kbox\"\n    ]\n  },\n  {\n    \"name\": \"db\",\n    \"project\": \"playbox\",\n    \"credentials\": {\n      \"database\": \"pantheon\",\n      \"user\": \"pantheon\",\n      \"password\": \"\",\n      \"host\": \"10.13.37.100\",\n      \"port\": \"32783\"\n    }\n  },\n  {\n    \"name\": \"solr\",\n    \"project\": \"playbox\"\n  },\n  {\n    \"name\": \"redis\",\n    \"project\": \"playbox\"\n  }\n]\n```\n\nYour connection info will be listed in the DB object. This information\nmay change between restarts.\n\n```json\n  {\n    \"name\": \"db\",\n    \"project\": \"playbox\",\n    \"credentials\": {\n      \"database\": \"pantheon\",\n      \"user\": \"pantheon\",\n      \"password\": \"\",\n      \"host\": \"10.13.37.100\",\n      \"port\": \"32783\"\n    }\n  }\n```\n\n## Using CLI tools\n\nWe package a lot of common CLI tools into your app. You can use most of these\nmore or less like you would if you had them natively installed. Here is a\nbrief example of doing an `npm install` on a theme.\n\n```bash\ncd /path/to/my/pantheon/app\ncd code/sites/all/themes/kalatheme\nkbox npm install\n```\n\n## Edge\n\nTo see what your site is like/how it behaves hitting the pantheon varnish\nedge you can go to `http(s)://edge.myapp.kbox`. **Note that this\nwill likely interfere with your code sharing since varnish will be serving\nyou back a cached page and not what is actually on your appserver.**\n\n## SSL\n\nYou can use `https` by just typing in `https://myapp.kbox` in your browser. We self-sign the certs so you will need to allow this in your browser.\n\nPantheon's ssl layer is at the edge so if you want to test SSL in a more\nrealistica way you should route your traffic through our edgeserver at https://edge.myapp.kbox.\n\n## SOLR\n\nApache Solr comes in each local Pantheon environment. You can use it the exact same way as you do on Pantheon.\n\nhttps://pantheon.io/docs/articles/sites/apache-solr/\n\n## Redis\n\nJust follow the same instructions from Pantheon to get redis to work locally.\n\nhttps://pantheon.io/docs/articles/sites/redis-as-a-caching-backend/\n\nThe TL;DR for Drupal 7 (on php 5.3) here is\n\n1. Install the [redis module](http://drupal.org/project/redis) (only 2.x supported)\n2. Use this code snippet in settings.php\n\n```php\n// All Pantheon Environments.\nif (defined('PANTHEON_ENVIRONMENT')) {\n  // Use Redis for caching.\n  $conf['redis_client_interface'] = 'PhpRedis';\n  $conf['cache_backends'][] = 'sites/all/modules/redis/redis.autoload.inc';\n  $conf['cache_default_class'] = 'Redis_Cache';\n  $conf['cache_prefix'] = array('default' => 'pantheon-redis');\n  // Do not use Redis for cache_form (no performance difference).\n  $conf['cache_class_cache_form'] = 'DrupalDatabaseCache';\n  // Use Redis for Drupal locks (semaphore).\n  $conf['lock_inc'] = 'sites/all/modules/redis/redis.lock.inc';\n}\n```\n\n## Xdebug\n\nxdebug is set up on your php appserver. Here is an example SublimeText 2 config (similar settings have been tested on Codebug, Eclipse, and other debugging tools). Note that you may need to launch it in the browser the first time using XDEBUG_SESSION_START=1 as a query parameter (ex: http://my-app.kbox/some-page?XDEBUG_SESSION_START=1). If breakpoints aren't working in your debugger, try inserting xdebug_break() in your code.\n\n```json\n{\n  \"folders\":\n  [\n    {\n      \"path\": \"/local/path/to/my/code\"\n    }\n  ],\n  \"settings\":\n  {\n    \"xdebug\":\n    {\n      \"max_children\": 32,\n      \"max_depth\": 16,\n      \"pretty_output\": true,\n      \"path_mapping\":\n      {\n        \"/code/\": \"/local/path/to/my/code/\"\n      },\n      \"port\": 9000,\n      \"url\": \"http://mysite.kbox/\"\n    }\n  }\n}\n```\n\n## Other Resources\n\n* [API docs](http://api.kalabox.me/)\n* [Test coverage reports](http://coverage.kalabox.me/)\n* [Kalabox CI dash](http://ci.kalabox.me/)\n* [Mountain climbing advice](https://www.youtube.com/watch?v=tkBVDh7my9Q)\n* [Boot2Docker](https://github.com/boot2docker/boot2docker)\n* [Syncthing](https://github.com/syncthing/syncthing)\n* [Docker](https://github.com/docker/docker)\n\n-------------------------------------------------------------------------------------\n(C) 2016 Kalabox Inc and friends\n","versions":{"0.12.0-alpha.7":{"name":"kalabox-app-pantheon","description":"Create Pantheon-esque apps on Kalabox.","keywords":["docker","kalabox","drupal","wordpress"],"version":"0.12.0-alpha.7","repository":{"type":"git","url":"git+https://github.com/kalabox/kalabox-app-pantheon.git"},"bugs":{"url":"http://github.com/kalabox/kalabox-app-pantheon","email":"mike@kalamuna.com"},"devDependencies":{"grunt":"^0.4.5","grunt-bump":"^0.7.0","grunt-contrib-jshint":"~0.10.0","grunt-jscs":"~0.8.1","jshint-stylish":"~1.0.0","matchdep":"^0.3.0"},"gitHead":"4da54000ce3b8d19db18fe4b1a826640121522cb","homepage":"https://github.com/kalabox/kalabox-app-pantheon#readme","_id":"kalabox-app-pantheon@0.12.0-alpha.7","scripts":{},"_shasum":"cdc01570630441854a05c4ce152b1022ac4f8e96","_from":".","_npmVersion":"3.8.1","_nodeVersion":"4.2.6","_npmUser":{"name":"pirog","email":"mike@kalamuna.com"},"dist":{"shasum":"cdc01570630441854a05c4ce152b1022ac4f8e96","tarball":"https://registry.npmjs.org/kalabox-app-pantheon/-/kalabox-app-pantheon-0.12.0-alpha.7.tgz","integrity":"sha512-+Eav2dAcYl0tUbSc+gYX6dLl2zoE6pW44zwhV9fs/XQGNMagFm+jc1zpLpubMGErZZrb3jE9Rv4vn4CxhM9gBQ==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCdyI8djq7DrshB/fiZfcbvH4V7cB2nrvaIzUmAFRi7jgIhAKAGzrq85NnsC62h0z3sSW8qlG2JRMhWMUqVAKB7uS33"}]},"maintainers":[{"name":"pirog","email":"mike@kalamuna.com"}],"_npmOperationalInternal":{"host":"packages-12-west.internal.npmjs.com","tmp":"tmp/kalabox-app-pantheon-0.12.0-alpha.7.tgz_1458239463442_0.06458812789060175"}},"0.12.0-alpha.8":{"name":"kalabox-app-pantheon","description":"Create Pantheon-esque apps on Kalabox.","keywords":["docker","kalabox","drupal","wordpress"],"version":"0.12.0-alpha.8","repository":{"type":"git","url":"git+https://github.com/kalabox/kalabox-app-pantheon.git"},"bugs":{"url":"http://github.com/kalabox/kalabox-app-pantheon","email":"mike@kalamuna.com"},"devDependencies":{"grunt":"^0.4.5","grunt-bump":"^0.7.0","grunt-contrib-jshint":"~0.10.0","grunt-jscs":"~0.8.1","jshint-stylish":"~1.0.0","matchdep":"^0.3.0"},"gitHead":"9f000b36bf56a3b6cb6ae985daaf94ca9f1b27d9","homepage":"https://github.com/kalabox/kalabox-app-pantheon#readme","_id":"kalabox-app-pantheon@0.12.0-alpha.8","scripts":{},"_shasum":"96fee7bfa8ccf0725546a1044324c4a87d149c9e","_from":".","_npmVersion":"3.8.3","_nodeVersion":"4.2.6","_npmUser":{"name":"pirog","email":"mike@kalamuna.com"},"dist":{"shasum":"96fee7bfa8ccf0725546a1044324c4a87d149c9e","tarball":"https://registry.npmjs.org/kalabox-app-pantheon/-/kalabox-app-pantheon-0.12.0-alpha.8.tgz","integrity":"sha512-Mno8cDZc8NWHxm3xW0tmpmniMcOS/bLQxDXUV34YkQV6fzbtp1jkl6wymapT2vyFtDth7KOcnU8QP8EJFGYqCA==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQD0LMdW08Y+fc14g8t62aTItEu57WlhPSX6N+Yfw1jYBgIhAIKtgu/MMuRNEluG0f70FeeJ1y9alrRAxGNA/kEOweRk"}]},"maintainers":[{"name":"pirog","email":"mike@kalamuna.com"}],"_npmOperationalInternal":{"host":"packages-12-west.internal.npmjs.com","tmp":"tmp/kalabox-app-pantheon-0.12.0-alpha.8.tgz_1459186281975_0.8587667441461235"}},"0.12.0-alpha.10":{"name":"kalabox-app-pantheon","description":"Create Pantheon-esque apps on Kalabox.","keywords":["docker","kalabox","drupal","wordpress"],"version":"0.12.0-alpha.10","repository":{"type":"git","url":"git+https://github.com/kalabox/kalabox-app-pantheon.git"},"bugs":{"url":"http://github.com/kalabox/kalabox-app-pantheon","email":"mike@kalamuna.com"},"devDependencies":{"bats":"git+https://github.com/sstephenson/bats.git#master","grunt":"^0.4.5","grunt-bump":"^0.7.0","grunt-contrib-jshint":"~0.10.0","grunt-jscs":"~0.8.1","grunt-shell":"^1.2.1","jshint-stylish":"~1.0.0","matchdep":"^0.3.0"},"gitHead":"43f66c8513fcef90ad266bc5cf18e1309f88c60e","homepage":"https://github.com/kalabox/kalabox-app-pantheon#readme","_id":"kalabox-app-pantheon@0.12.0-alpha.10","scripts":{},"_shasum":"f1170e3307df22f9081a4ff9ab9191d750a31dd1","_from":".","_npmVersion":"3.8.6","_nodeVersion":"4.2.6","_npmUser":{"name":"pirog","email":"mike@kalamuna.com"},"dist":{"shasum":"f1170e3307df22f9081a4ff9ab9191d750a31dd1","tarball":"https://registry.npmjs.org/kalabox-app-pantheon/-/kalabox-app-pantheon-0.12.0-alpha.10.tgz","integrity":"sha512-A4286LrsJmVXC8lCJDFqPsBs5T4DduwS6WLv49J5fW1qw+TLEzVWLSe6xjzMbGFD884zf8d6NE4/jvH20wYqrw==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIFkiBCaM75uy3VtirYzx1CNNUpp9RFvHO46uGLW4J/ExAiBSDs/XV20tYJu0g/ACeTGsDn+8TwRbM5Aqcpr9+i1vPg=="}]},"maintainers":[{"name":"pirog","email":"mike@kalamuna.com"}],"_npmOperationalInternal":{"host":"packages-16-east.internal.npmjs.com","tmp":"tmp/kalabox-app-pantheon-0.12.0-alpha.10.tgz_1460421342547_0.40109181380830705"}},"0.12.0-alpha.12":{"name":"kalabox-app-pantheon","description":"Create Pantheon-esque apps on Kalabox.","keywords":["docker","kalabox","drupal","wordpress"],"version":"0.12.0-alpha.12","repository":{"type":"git","url":"git+https://github.com/kalabox/kalabox-app-pantheon.git"},"bugs":{"url":"http://github.com/kalabox/kalabox-app-pantheon","email":"mike@kalamuna.com"},"devDependencies":{"bats":"git+https://github.com/sstephenson/bats.git#master","grunt":"^0.4.5","grunt-bump":"^0.7.0","grunt-contrib-jshint":"~0.10.0","grunt-jscs":"~0.8.1","grunt-shell":"^1.2.1","jshint-stylish":"~1.0.0","matchdep":"^0.3.0"},"gitHead":"d8ac4929a81c8c3b8c520120da447f4c1ded5641","homepage":"https://github.com/kalabox/kalabox-app-pantheon#readme","_id":"kalabox-app-pantheon@0.12.0-alpha.12","scripts":{},"_shasum":"8a374beeb62a44801a21177e8ff4abe90b8e65f1","_from":".","_npmVersion":"3.8.8","_nodeVersion":"4.2.6","_npmUser":{"name":"pirog","email":"mike@kalamuna.com"},"dist":{"shasum":"8a374beeb62a44801a21177e8ff4abe90b8e65f1","tarball":"https://registry.npmjs.org/kalabox-app-pantheon/-/kalabox-app-pantheon-0.12.0-alpha.12.tgz","integrity":"sha512-9sOpiw8oXt5MnEnetMTZRBdU7s08tn0Pcnwoq0FYp36poaIrRjWi/x8A7HvSUo7FCBaaucLe47UvYq6Y2RWVpQ==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDDYsWgRefr3DCWrsFvZDnAOF17p93zIfzBiski1g4UKwIhALSDLw8XbSXFQcqQpSE9KKaIG7jieM9d1lmyIW/Nb0vS"}]},"maintainers":[{"name":"pirog","email":"mike@kalamuna.com"}],"_npmOperationalInternal":{"host":"packages-12-west.internal.npmjs.com","tmp":"tmp/kalabox-app-pantheon-0.12.0-alpha.12.tgz_1462153052369_0.011983807664364576"}},"0.12.0-beta.1":{"name":"kalabox-app-pantheon","description":"Create Pantheon-esque apps on Kalabox.","keywords":["docker","kalabox","drupal","wordpress"],"version":"0.12.0-beta.1","repository":{"type":"git","url":"git+https://github.com/kalabox/kalabox-app-pantheon.git"},"bugs":{"url":"http://github.com/kalabox/kalabox-app-pantheon","email":"mike@kalamuna.com"},"devDependencies":{"bats":"git+https://github.com/sstephenson/bats.git#master","grunt":"^0.4.5","grunt-bump":"^0.7.0","grunt-contrib-jshint":"~0.10.0","grunt-jscs":"~0.8.1","grunt-shell":"^1.2.1","jshint-stylish":"~1.0.0","matchdep":"^0.3.0"},"gitHead":"1c20d94c319834764598b330d02078cbeae6d306","homepage":"https://github.com/kalabox/kalabox-app-pantheon#readme","_id":"kalabox-app-pantheon@0.12.0-beta.1","scripts":{},"_shasum":"09077c2330c1cb29fcbdedefcb26cc4a17b5d816","_from":".","_npmVersion":"3.8.8","_nodeVersion":"4.2.6","_npmUser":{"name":"pirog","email":"mike@kalamuna.com"},"dist":{"shasum":"09077c2330c1cb29fcbdedefcb26cc4a17b5d816","tarball":"https://registry.npmjs.org/kalabox-app-pantheon/-/kalabox-app-pantheon-0.12.0-beta.1.tgz","integrity":"sha512-dqVnuy7b8QdACfUFXBWKWHF1m3DlmHrhTxN7xNj+vveOems/4nzr46d4yvNGSeYTA9wJvcb4e29VS1st98ey3g==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCMh+N2W8fJALtwNHavG3OfAoZai5c7retWxmx0cZaQWgIgUtia3Wy0eddr3pHH+432QebImmOK8Q1Cm3kaTZUWqLY="}]},"maintainers":[{"name":"pirog","email":"mike@kalamuna.com"}],"_npmOperationalInternal":{"host":"packages-12-west.internal.npmjs.com","tmp":"tmp/kalabox-app-pantheon-0.12.0-beta.1.tgz_1462416917435_0.25413266639225185"}}},"homepage":"https://github.com/kalabox/kalabox-app-pantheon#readme","keywords":["docker","kalabox","drupal","wordpress"],"repository":{"type":"git","url":"git+https://github.com/kalabox/kalabox-app-pantheon.git"},"bugs":{"url":"http://github.com/kalabox/kalabox-app-pantheon","email":"mike@kalamuna.com"},"readmeFilename":"README.md"}