#1600: Update docs to reflect how to use internal and external db con…

…nection info
kalabox · Oct 4, 2016 · df0bc5c · df0bc5c
1 parent dca88a5
commit df0bc5c
Show file tree

Hide file tree

Showing 4 changed files with 90 additions and 7 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,20 +1,25 @@
+v2.0.1
+======
+
+* Updated documentation to better reflect how to use `db` connection info. [#1600](https://github.com/kalabox/kalabox/issues/1600)
+
 v2.0.0
-==================
+======
 
 * No changes! Bumping for version parity across major projects.
 
 v0.13.0-rc.2
-==================
+============
 
 * No changes! Bumping for version parity across major projects.
 
 v0.13.0-rc.1
-==================
+============
 
 * Updated `kbox services` output to be more helpful. [#1551](https://github.com/kalabox/kalabox/issues/1551)
 
 v0.13.0-beta.2
-==================
+==============
 
 * Rebooted documentation. [#1322](https://github.com/kalabox/kalabox/issues/1322)
 * Improved app to better work with new `unison` file sharing. [#1440](https://github.com/kalabox/kalabox/issues/1440)
@@ -23,7 +28,7 @@ v0.13.0-beta.2
 * Fixed broken links in main `README.md` and `RTD` index.
 
 v0.13.0-alpha.1
-==================
+===============
 
 * Upgraded to 0.13.x. [#1409](https://github.com/kalabox/kalabox/issues/1409)
 * Refactored app to include connectors previously found in core. [#1223](https://github.com/kalabox/kalabox/issues/1223)

diff --git a/docs/images/connectionInfo.png b/docs/images/connectionInfo.png
diff --git a/docs/users/cli.md b/docs/users/cli.md
@@ -171,7 +171,7 @@ kbox rebuild -- -v
 services
 --------
 
-Displays relevant connection information for your PHP services. You can use this information to connect to your database from an external DB client like [SQLPro](http://www.sequelpro.com/) or to enter correct DB credentials during the setup of Drupal sites.
+Displays relevant connection information for your PHP services. You can use this information to connect to your database from an external DB client like [SQLPro](http://www.sequelpro.com/) or to enter correct DB credentials during the setup of PHP sites.
 
 `kbox services`
 
@@ -181,3 +181,77 @@ Options:
   -v, --verbose  Use verbose output.                                   [boolean]
   --debug        Use debug output.                                     [boolean]
 ```
+
+```
+# Get external db connection info for SequelPro or other sqlClient
+kbox services
+[
+  {
+    "name": "appserver",
+    "project": "date",
+    "url": [
+      "http://date.kbox"
+    ]
+  },
+  {
+    "name": "db",
+    "project": "date",
+    # Use these settings for external connections
+    "external_connection_info": {
+      "database": "drupal",
+      "user": "drupal",
+      "password": "drupal",
+      "host": "date.kbox",
+      "port": "32768"
+    },
+    # Ignore these settings for external connections
+    "internal_connection_info": {
+      "database": "drupal",
+      "user": "drupal",
+      "password": "drupal",
+      "host": "database",
+      "port": 3306
+    }
+  },
+  {
+    "name": "unison",
+    "project": "date"
+  }
+]
+
+# Get internal db connection info for settings up a drupal, backdrop or wordpress site
+kbox services
+[
+  {
+    "name": "appserver",
+    "project": "date",
+    "url": [
+      "http://date.kbox"
+    ]
+  },
+  {
+    "name": "db",
+    "project": "date",
+    # Do not use these settings for internal connections
+    "external_connection_info": {
+      "database": "drupal",
+      "user": "drupal",
+      "password": "drupal",
+      "host": "date.kbox",
+      "port": "32768"
+    },
+    # use these settings for internal connections
+    "internal_connection_info": {
+      "database": "drupal",
+      "user": "drupal",
+      "password": "drupal",
+      "host": "database",
+      "port": 3306
+    }
+  },
+  {
+    "name": "unison",
+    "project": "date"
+  }
+]
+```
diff --git a/docs/users/gui.md b/docs/users/gui.md
@@ -50,10 +50,14 @@ Get Database Connection Info
 
 ![Site actions dropdown](../images/siteActions.png)
 
-If you click the "Actions" gear symbol on your new PHP app, you'll see a number of options. Select "Connection Info" to see the database credentials to connect to your apps database from a browser like [PHPMyAdmin](https://www.phpmyadmin.net) or [SQLPro](http://www.sequelpro.com/):
+If you click the "Actions" gear symbol on your new PHP app, you'll see a number of options. Select "Connection Info" to see the database credentials to connect to your apps database from a browser like [PHPMyAdmin](https://www.phpmyadmin.net) or [SQLPro](http://www.sequelpro.com/) or to connect during the installation of your app.
 
 ![Connection info](../images/connectionInfo.png)
 
+The left side of your connection info will contain the credentials to connect to your database from an external client like SequelPro. The right side of the info will contain information you can use during the installation of Drupal. WordPress and Backdrop should be able to detect these settings automatically.
+
+You can also use the right side connection info for any local specific code.
+
 Deploying Your Work
 -------------------