From 71b6ba54305b86a7afea9461a3098424923b8162 Mon Sep 17 00:00:00 2001
From: Chris Roberts <code@chrisroberts.org>
Date: Thu, 23 Feb 2017 15:11:54 -0800
Subject: [PATCH] Add docs for ngrok share

---
 website/source/docs/share/ngrok.html.md | 63 +++++++++++++++++++++++++
 website/source/layouts/docs.erb         |  1 +
 2 files changed, 64 insertions(+)
 create mode 100644 website/source/docs/share/ngrok.html.md

diff --git a/website/source/docs/share/ngrok.html.md b/website/source/docs/share/ngrok.html.md
new file mode 100644
index 000000000..8e674d3f3
--- /dev/null
+++ b/website/source/docs/share/ngrok.html.md
@@ -0,0 +1,63 @@
+---
+layout: "docs"
+page_title: "ngrok - Vagrant Share"
+sidebar_current: "share-ngrok"
+description: |-
+  Vagrant share can be driven using ngrok for the underlying transport
+  by supplying the "--driver ngrok" flag to "vagrant share".
+---
+
+# Sharing via ngrok
+
+Vagrant share can be driven using ngrok from the underlying transport
+by supplying the `--driver ngrok` flag to `vagrant share`.
+
+The ngrok driver is not enabled by default. When starting the Vagrant
+share, ngrok must be specified as the driver. Users connecting to
+the share must also specify the ngrok driver to make a proper connection.
+
+
+## Sharing
+
+Starting a Vagrant share using the ngrok driver is very similar to the
+default Vagrant share command. The only addition it requires is the
+`--driver ngrok` flag:
+
+```
+$ vagrant share --driver ngrok
+```
+
+By default this will create a public HTTP endpoint
+connected to the shared VM via an ngrok process. When only HTTP is being
+shared, no connection is required from the remote side. All that is required
+is the public ngrok URL.
+
+### SSH
+
+To share an ssh connection to the shared VM the `--ssh` flag must be provided.
+Vagrant share will then create a small utility VM to enable the share with
+remote users. Once the setup is complete, a name will be assigned to the
+utility VM that remote users can reach using the `vagrant connect` command.
+
+### Full Share
+
+To enable full remote access to the shared VM the `--full` flag must be provided.
+This will enable remote users connecting to the local share full access to all
+forwarded ports defined by the shared VM Vagrantfile.
+
+## Connecting
+
+Much like the `vagrant share` command, when connecting to a Vagrant share
+that was created using the ngrok driver, the `--driver ngrok` flag must
+be provided:
+
+```
+$ vagrant connect --driver ngrok share_name
+```
+
+## ngrok configuration
+
+The current user's ngrok configuration file is used by default when
+tunnels are created for Vagrant share. While specific customization
+to the ngrok configuration is not yet supported, the feature is being
+actively worked on and will be available in the future.
diff --git a/website/source/layouts/docs.erb b/website/source/layouts/docs.erb
index ca0630679..74388b31f 100644
--- a/website/source/layouts/docs.erb
+++ b/website/source/layouts/docs.erb
@@ -74,6 +74,7 @@
             <li<%= sidebar_current("share-http") %>><a href="/docs/share/http.html">HTTP Sharing</a></li>
             <li<%= sidebar_current("share-ssh") %>><a href="/docs/share/ssh.html">SSH Sharing</a></li>
             <li<%= sidebar_current("share-connect") %>><a href="/docs/share/connect.html">Connect</a></li>
+            <li<%= sidebar_current("share-ngrok") %>><a href="/docs/share/ngrok.html">ngrok</a></li>
             <li<%= sidebar_current("share-security") %>><a href="/docs/share/security.html">Security</a></li>
             <li<%= sidebar_current("share-provider") %>><a href="/docs/share/provider.html">Custom Provider</a></li>
           </ul>