From cdf893bc1597c21b90f8c401bacf79a7c70787fb Mon Sep 17 00:00:00 2001 From: Robert Speicher <rspeicher@gmail.com> Date: Thu, 11 Jun 2015 22:54:21 -0400 Subject: Move 2FA docs from "Workflow" to "Profile Settings" --- doc/profile/2fa.png | Bin 0 -> 23415 bytes doc/profile/2fa_auth.png | Bin 0 -> 15569 bytes doc/profile/README.md | 4 ++ doc/profile/profile.md | 3 -- doc/profile/two_factor_authentication.md | 67 +++++++++++++++++++++++++++++++ 5 files changed, 71 insertions(+), 3 deletions(-) create mode 100644 doc/profile/2fa.png create mode 100644 doc/profile/2fa_auth.png create mode 100644 doc/profile/README.md delete mode 100644 doc/profile/profile.md create mode 100644 doc/profile/two_factor_authentication.md (limited to 'doc/profile') diff --git a/doc/profile/2fa.png b/doc/profile/2fa.png new file mode 100644 index 00000000000..bbf415210d5 Binary files /dev/null and b/doc/profile/2fa.png differ diff --git a/doc/profile/2fa_auth.png b/doc/profile/2fa_auth.png new file mode 100644 index 00000000000..4a4fbe68984 Binary files /dev/null and b/doc/profile/2fa_auth.png differ diff --git a/doc/profile/README.md b/doc/profile/README.md new file mode 100644 index 00000000000..6f8359d87fa --- /dev/null +++ b/doc/profile/README.md @@ -0,0 +1,4 @@ +# Profile Settings + +- [Preferences](preferences.md) +- [Two-factor Authentication (2FA)](two_factor_authentication.md) diff --git a/doc/profile/profile.md b/doc/profile/profile.md deleted file mode 100644 index 032d62cf884..00000000000 --- a/doc/profile/profile.md +++ /dev/null @@ -1,3 +0,0 @@ -# Profile Settings - -- [Preferences](preferences.md) diff --git a/doc/profile/two_factor_authentication.md b/doc/profile/two_factor_authentication.md new file mode 100644 index 00000000000..fb215c8b269 --- /dev/null +++ b/doc/profile/two_factor_authentication.md @@ -0,0 +1,67 @@ +# Two-factor Authentication (2FA) + +Two-factor Authentication (2FA) provides an additional level of security to your +GitLab account. Once enabled, in addition to supplying your username and +password to login, you'll be prompted for a code generated by an application on +your phone. + +By enabling 2FA, the only way someone other than you can log into your account +is to know your username and password *and* have access to your phone. + +## Enabling 2FA + +**In GitLab:** + +1. Log in to your GitLab account. +1. Go to your **Profile Settings**. +1. Go to **Account**. +1. Click **Enable Two-factor Authentication**. + + + +**On your phone:** + +1. Install a compatible application. We recommend [Google Authenticator] +\(proprietary\) or [FreeOTP] \(open source\). +1. In the application, add a new entry in one of two ways: + * Scan the code with your phone's camera to add the entry automatically. + * Enter the details provided to add the entry manually. + +**In GitLab:** + +1. Enter the six-digit pin number from the entry on your phone into the **Pin + code** field. +1. Click **Submit**. + +If the pin you entered was correct, you'll see a message indicating that +Two-factor Authentication has been enabled, and you'll be presented with a list +of recovery codes. + +## Recovery Codes + +Should you ever lose access to your phone, you can use one of the ten provided +backup codes to login to your account. We suggest copying or printing them for +storage in a safe place. **Each code can be used only once** to log in to your +account. + +If you lose the recovery codes or just want to generate new ones, you can do so +from the **Profile Settings** > **Account** page where you first enabled 2FA. + +## Logging in with 2FA Enabled + +Logging in with 2FA enabled is only slightly different than a normal login. +Enter your username and password credentials as you normally would, and you'll +be presented with a second prompt for an authentication code. Enter the pin from +your phone's application or a recovery code to log in. + + + +## Disabling 2FA + +1. Log in to your GitLab account. +1. Go to your **Profile Settings**. +1. Go to **Account**. +1. Click **Disable Two-factor Authentication**. + +[Google Authenticator]: https://support.google.com/accounts/answer/1066447?hl=en +[FreeOTP]: https://fedorahosted.org/freeotp/ -- cgit v1.2.1