From b862724ce1ee05de9397e0afb0517c7246b44d24 Mon Sep 17 00:00:00 2001 From: Justin Campbell Date: Fri, 19 May 2017 12:05:34 -0400 Subject: [PATCH] website: Vagrant Enterprise user docs --- .../users/authentication.html.md | 56 +++++++++++++++++++ .../docs/vagrant-cloud/users/index.html.md | 11 ++++ .../docs/vagrant-cloud/users/recovery.html.md | 13 +++++ website/source/layouts/docs.erb | 8 +++ 4 files changed, 88 insertions(+) create mode 100755 website/source/docs/vagrant-cloud/users/authentication.html.md create mode 100755 website/source/docs/vagrant-cloud/users/index.html.md create mode 100755 website/source/docs/vagrant-cloud/users/recovery.html.md diff --git a/website/source/docs/vagrant-cloud/users/authentication.html.md b/website/source/docs/vagrant-cloud/users/authentication.html.md new file mode 100755 index 000000000..5b015be94 --- /dev/null +++ b/website/source/docs/vagrant-cloud/users/authentication.html.md @@ -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. diff --git a/website/source/docs/vagrant-cloud/users/index.html.md b/website/source/docs/vagrant-cloud/users/index.html.md new file mode 100755 index 000000000..a9e423567 --- /dev/null +++ b/website/source/docs/vagrant-cloud/users/index.html.md @@ -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. diff --git a/website/source/docs/vagrant-cloud/users/recovery.html.md b/website/source/docs/vagrant-cloud/users/recovery.html.md new file mode 100755 index 000000000..9c7ce71ff --- /dev/null +++ b/website/source/docs/vagrant-cloud/users/recovery.html.md @@ -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. diff --git a/website/source/layouts/docs.erb b/website/source/layouts/docs.erb index c80e5323f..e4c1e387f 100644 --- a/website/source/layouts/docs.erb +++ b/website/source/layouts/docs.erb @@ -243,6 +243,14 @@ + > + Users + + + >Request Limits >Support