website/docs: document provider share impl [GH-3144]

This commit is contained in:
Mitchell Hashimoto 2014-03-12 09:09:01 -07:00
parent 229d06f122
commit da7b2c50b0
3 changed files with 28 additions and 1 deletions

View File

@ -135,6 +135,7 @@
<li<%= sidebar_current("share-ssh") %>><a href="/v2/share/ssh.html">SSH Sharing</a></li>
<li<%= sidebar_current("share-connect") %>><a href="/v2/share/connect.html">vagrant connect</a></li>
<li<%= sidebar_current("share-security") %>><a href="/v2/share/security.html">Security</a></li>
<li<%= sidebar_current("share-provider") %>><a href="/v2/share/provider.html">Custom Provider</a></li>
</ul>
<% end %>

View File

@ -0,0 +1,26 @@
---
page_title: "Custom Provider - Vagrant Share"
sidebar_current: "share-provider"
---
# Custom Provider
<div class="alert alert-warn">
<p>
<strong>Warning: Advanced Topic!</strong> This topic is related to
developing Vagrant plugins. If you're not interested in this or
you're just starting with Vagrant, it is safe to skip this page.
</p>
</div>
If you're developing a [custom provider](/v2/plugins/providers.html), you'll
need to do a tiny bit more work in order for it to work well with Vagrant
Share.
For now, this is only one step:
* `public_address` provider capability - You must implement this capability
to return a string that is an address that can be used to access the
guest from Vagrant. This does not need to be a globally routable address,
it only needs to be accessible from the machine running Vagrant. If you
can't detect an address, return `nil`.

View File

@ -26,7 +26,7 @@ In addition to these options, there are other features we've built to help:
are encrypted through the various proxies and only unencrypted during the final
local communication between the local proxy and the Vagrant environment.
* Share names, such as happy-panda-1234, are randoly chosen from a pool
* Share names, such as happy-panda-1234, are randomly chosen from a pool
of over 40,000,000 possible names. And we're routinely adding more
words to grow this pool. It is unlikely that anyone will guess your
share name.