Updated parameter descriptions and added an example of using Mongo ov…

…er a UNIX socket Signed-off-by: Jim Ciallella <[email protected]>
chatii · Sep 23, 2014 · cc481c1 · cc481c1
1 parent 8bf43a0
commit cc481c1
Showing 1 changed file with 11 additions and 2 deletions.
diff --git a/classes/mongo/introduction.html b/classes/mongo/introduction.html
@@ -76,7 +76,7 @@ <h3 id="config">Configuration</h3>
 						<th>hostname</th>
 						<td>string</td>
 						<td>yes</td>
-						<td>the hostname</td>
+						<td>the TCP hostname, OR a UNIX socket filepath</td>
 					</tr>
 					<tr>
 						<th>database</th>
@@ -88,7 +88,7 @@ <h3 id="config">Configuration</h3>
 						<th>port</th>
 						<td>number</td>
 						<td>no</td>
-						<td>the port to use in the connection</td>
+						<td>the port to use in the connection, OR <em>0</em> if the <strong>hostname</strong> is a UNIX socket</td>
 					</tr>
 					<tr>
 						<th>replicaset</th>
@@ -122,6 +122,7 @@ <h3 id="config">Configuration</h3>
 				'database'   => 'mongo_fuel',
 			),
 
+
 			// List your own groups below.
 			'my_mongo_connection' => array(
 				'hostname'   => 'localhost',
@@ -130,6 +131,14 @@ <h3 id="config">Configuration</h3>
 				'username'   => 'user',
 				'password'   => 'p@s$w0rD',
 			),
+
+			// An alternative group example using a UNIX socket connection, instead of the TCP localhost
+			'my_mongo_sock' => array(
+				'hostname'   => '/tmp/mongodb-27017.sock',
+				'port'   => 0,
+				'database'   => 'mongo_fuel',
+			),
+
 		),
 	</code></pre>