From 42f36268629d2029e16b70f1b112e404e6439bd7 Mon Sep 17 00:00:00 2001 From: Robert Speicher Date: Tue, 2 Jun 2015 18:39:20 -0400 Subject: Add 2FA docs [ci skip] --- doc/workflow/README.md | 3 +- doc/workflow/two_factor_authentication.md | 65 +++++++++++++++++++++++++++++++ 2 files changed, 67 insertions(+), 1 deletion(-) create mode 100644 doc/workflow/two_factor_authentication.md diff --git a/doc/workflow/README.md b/doc/workflow/README.md index 0fca68f364e..89005e51958 100644 --- a/doc/workflow/README.md +++ b/doc/workflow/README.md @@ -11,7 +11,8 @@ - [Migrating from SVN to GitLab](migrating_from_svn.md) - [Project importing from GitHub to GitLab](import_projects_from_github.md) - [Project importing from GitLab.com to your private GitLab instance](import_projects_from_gitlab_com.md) +- [Two-factor Authentication (2FA)](two_factor_authentication.md) - [Protected branches](protected_branches.md) - [Change your time zone](timezone.md) - [Keyboard shortcuts](shortcuts.md) -- [Web Editor](web_editor.md) \ No newline at end of file +- [Web Editor](web_editor.md) diff --git a/doc/workflow/two_factor_authentication.md b/doc/workflow/two_factor_authentication.md new file mode 100644 index 00000000000..81f51042bff --- /dev/null +++ b/doc/workflow/two_factor_authentication.md @@ -0,0 +1,65 @@ +# 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 **Acount**. +1. Click **Enable Two-factor Authentication**. + +TODO: Insert screenshot of 2FA page (with the "Can't scan the code?" text) + +**On your phone:** + +1. Install a compatible application. We recommend [Google Authenticator]. +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** > **Acount** 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. + +TODO: Insert screenshot of 2FA login prompt? + +## Disabling 2FA + +1. Log in to your GitLab account. +1. Go to your **Profile Settings**. +1. Go to **Acount**. +1. Click **Disable Two-factor Authentication**. + +[Google Authenticator]: https://support.google.com/accounts/answer/1066447?hl=en -- cgit v1.2.1 From 41ee2aa2d70ddb729904d90f12b0318f2ce58215 Mon Sep 17 00:00:00 2001 From: Job van der Voort Date: Wed, 3 Jun 2015 15:35:13 +0200 Subject: fix typo and add screenshots --- doc/workflow/2fa.png | Bin 0 -> 23415 bytes doc/workflow/2fa_auth.png | Bin 0 -> 15569 bytes doc/workflow/two_factor_authentication.md | 6 +++--- 3 files changed, 3 insertions(+), 3 deletions(-) create mode 100644 doc/workflow/2fa.png create mode 100644 doc/workflow/2fa_auth.png diff --git a/doc/workflow/2fa.png b/doc/workflow/2fa.png new file mode 100644 index 00000000000..bbf415210d5 Binary files /dev/null and b/doc/workflow/2fa.png differ diff --git a/doc/workflow/2fa_auth.png b/doc/workflow/2fa_auth.png new file mode 100644 index 00000000000..4a4fbe68984 Binary files /dev/null and b/doc/workflow/2fa_auth.png differ diff --git a/doc/workflow/two_factor_authentication.md b/doc/workflow/two_factor_authentication.md index 81f51042bff..8ac1ca4b351 100644 --- a/doc/workflow/two_factor_authentication.md +++ b/doc/workflow/two_factor_authentication.md @@ -14,10 +14,10 @@ is to know your username and password *and* have access to your phone. 1. Log in to your GitLab account. 1. Go to your **Profile Settings**. -1. Go to **Acount**. +1. Go to **Account**. 1. Click **Enable Two-factor Authentication**. -TODO: Insert screenshot of 2FA page (with the "Can't scan the code?" text) +![Two-factor setup](2fa.png) **On your phone:** @@ -53,7 +53,7 @@ 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. -TODO: Insert screenshot of 2FA login prompt? +![Two-factor authentication on sign in](2fa_auth.png) ## Disabling 2FA -- cgit v1.2.1