website: Vagrant Enterprise user docs

This commit is contained in:
Justin Campbell 2017-05-19 12:05:34 -04:00
parent 821ae518f7
commit b862724ce1
4 changed files with 88 additions and 0 deletions

View File

@ -0,0 +1,56 @@
---
layout: "docs"
page_title: "Authentication"
sidebar_current: "vagrant-cloud-users-authentication"
---
# Authentication
Vagrant Enterprise requires a username and password to sign up and login.
However, there are several ways to authenticate with your account.
### Authentication Tokens
Authentication tokens are keys used to access your account via tools or over the
various APIs used in Vagrant Enterprise.
You can create new tokens in the token section of your account settings. It's
important to keep tokens secure, as they are essentially a password and can be
used to access your account or resources. Additionally, token authentication
bypasses two factor authentication.
### Authenticating Tools
All HashiCorp tools look for the `ATLAS_TOKEN` environment variable:
```shell
$ export ATLAS_TOKEN=TOKEN
```
This will automatically authenticate all requests against this token. This is
the recommended way to authenticate with our various tools. Care should be given
to how this token is stored, as it is as good as a password.
### Two Factor Authentication
You can optionally enable Two Factor authentication, requiring an SMS or TOTP
one-time code every time you log in, after entering your username and password.
You can enable Two Factor authentication in the security section of your account
settings.
Be sure to save the generated recovery codes. Each backup code can be used once
to sign in if you do not have access to your two-factor authentication device.
### Sudo Mode
When accessing certain admin-level pages (adjusting your user profile, for
example), you may notice that you're prompted for your password, even though
you're already logged in. This is by design, and aims to help guard protect you
if your screen is unlocked and unattended.
### Session Management
You can see a list of your active sessions on your security settings page. From
here, you can revoke sessions, in case you have lost access to a machine from
which you were accessing.

View File

@ -0,0 +1,11 @@
---
layout: "docs"
page_title: "User Accounts"
sidebar_current: "vagrant-cloud-users"
---
# User Accounts
Users are the main identity system in Vagrant Enterprise. A user can be a
member of multiple [organizations](/docs/enterprise/organizations/index.html),
as well as individually collaborate on various resources.

View File

@ -0,0 +1,13 @@
---
layout: "docs"
page_title: "Account Recovery"
sidebar_current: "vagrant-cloud-users-recovery"
---
# Account Recovery
If you have lost access to your Vagrant Enterprise account, use the reset
password form on the login page to send yourself a link to reset your password.
If an email is unknown, [contact us](mailto:support@hashicorp.com) for further
help.

View File

@ -243,6 +243,14 @@
</ul>
</li>
<li<%= sidebar_current("vagrant-cloud-users") %>>
<a href="/docs/vagrant-cloud/users/index.html">Users</a>
<ul class="nav">
<li<%= sidebar_current("vagrant-cloud-users-authentication") %>><a href="/docs/vagrant-cloud/users/authentication.html">Authentication</a></li>
<li<%= sidebar_current("vagrant-cloud-users-recovery") %>><a href="/docs/vagrant-cloud/users/recovery.html">Account Recovery</a></li>
</ul>
</li>
<li<%= sidebar_current("vagrant-cloud-request-limits") %>><a href="/docs/vagrant-cloud/request-limits.html">Request Limits</a></li>
<li<%= sidebar_current("vagrant-cloud-support") %>><a href="/docs/vagrant-cloud/support.html">Support</a></li>
</ul>