1
0
mirror of synced 2025-12-19 18:10:59 -05:00

TOTP manual setup instructions (#40993)

Co-authored-by: github-actions <github-actions@github.com>
Co-authored-by: Sophie <29382425+sophietheking@users.noreply.github.com>
This commit is contained in:
Hirsch Singhal
2023-08-24 08:18:37 -07:00
committed by GitHub
parent fedc0d6182
commit 9f0cf55841
3 changed files with 13 additions and 4 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 30 KiB

View File

@@ -58,7 +58,7 @@ A time-based one-time password (TOTP) application automatically generates an aut
{% tip %} {% tip %}
**Tip**: To configure authentication via TOTP on multiple devices, during setup, scan the QR code using each device at the same time. If 2FA is already enabled and you want to add another device, you must re-configure your TOTP app from your security settings. **Tip**: To configure authentication via TOTP on multiple devices, during setup, scan the QR code using each device at the same time or save the "text code", which is the TOTP secret. If 2FA is already enabled and you want to add another device, you must re-configure your TOTP app from your security settings.
{% endtip %} {% endtip %}
@@ -69,9 +69,9 @@ A time-based one-time password (TOTP) application automatically generates an aut
{%- ifversion fpt or ghec or ghes > 3.8 %} {%- ifversion fpt or ghec or ghes > 3.8 %}
1. Under "Setup authenticator app", do one of the following: 1. Under "Setup authenticator app", do one of the following:
- Scan the QR code with your mobile device's app. After scanning, the app displays a six-digit code that you can enter on {% data variables.product.product_name %}. - Scan the QR code with your mobile device's app. After scanning, the app displays a six-digit code that you can enter on {% data variables.product.product_name %}.
- If you can't scan the QR code, click **enter this text code** to see a code that you can manually enter in your TOTP app instead. - If you can't scan the QR code, click **setup key** to see a code, the TOTP secret, that you can manually enter in your TOTP app instead.
![Screenshot of the "Setup authenticator app" section of the 2FA settings. A link, labeled "enter this text code", is highlighted in orange.](/assets/images/help/2fa/2fa-wizard-app-click-code.png) ![Screenshot of the "Setup authenticator app" section of the 2FA settings. A link, labeled "setup key", is highlighted in orange.](/assets/images/help/2fa/ghes_3.8_and_higher_2fa-wizard-app-click-code.png)
1. The TOTP mobile application saves your account on {% data variables.location.product_location %} and generates a new authentication code every few seconds. On {% data variables.product.product_name %}, type the code into the field under "Verify the code from the app". 1. The TOTP mobile application saves your account on {% data variables.location.product_location %} and generates a new authentication code every few seconds. On {% data variables.product.product_name %}, type the code into the field under "Verify the code from the app".
{%- else %} {%- else %}
1. Under "Two-factor authentication", select **Set up using an app** and click **Continue**. 1. Under "Two-factor authentication", select **Set up using an app** and click **Continue**.
@@ -85,6 +85,15 @@ A time-based one-time password (TOTP) application automatically generates an aut
{% data reusables.two_fa.backup_options_during_2fa_enrollment %} {% data reusables.two_fa.backup_options_during_2fa_enrollment %}
{% ifversion ghes < 3.9 %}{% data reusables.two_fa.test_2fa_immediately %}{% endif %} {% ifversion ghes < 3.9 %}{% data reusables.two_fa.test_2fa_immediately %}{% endif %}
If you wish to setup a TOTP app manually, and require the parameters encoded in the QR code, they are:
- Type: `TOTP`
- Label: `GitHub:<username>` where `<username>` is your handle on GitHub, for example `monalisa`
- Secret: This is the encoded setup key, shown if you click {%- ifversion fpt or ghec or ghes > 3.8 %}"setup key"{%- else %}"enter this text code"{%- endif %} during configuration
- Issuer: `GitHub`
- Algorithm: The default of SHA1 is used
- Digits: The default of 6 is used
- Period: The default of 30 (seconds) is used
{% ifversion fpt or ghec %} {% ifversion fpt or ghec %}
## Configuring two-factor authentication using text messages ## Configuring two-factor authentication using text messages

View File

@@ -1 +1 @@
1. Optionally, you can configure additional 2FA methods to reduce your risk of account lockout. For more details on how to configure each additional method, see "[AUTOTITLE](/authentication/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication#configuring-two-factor-authentication-using-github-mobile)" and "[AUTOTITLE](/authentication/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication#configuring-two-factor-authentication-using-a-security-key)". 1. Optionally, you can configure additional 2FA methods to reduce your risk of account lockout. For more details on how to configure each additional method, see "[Configuring two-factor authentication using {% data variables.product.prodname_mobile %}](/authentication/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication#configuring-two-factor-authentication-using-github-mobile)" and "[Configuring two-factor authentication using a security key](/authentication/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication#configuring-two-factor-authentication-using-a-security-key)".