diff --git a/docs/getting_support.rst b/docs/getting_support.rst index 7c5205ec9..c972bc222 100644 --- a/docs/getting_support.rst +++ b/docs/getting_support.rst @@ -87,39 +87,34 @@ After your account is activated, you can login and continue to the next step. Enabling two-factor authentication ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Two-factor authentication (2FA) protects your account in the event that your -passphrase is compromised. Once enabled, you will be prompted to provide a -one-time six digit code every time you log into the support portal, in addition -to your passphrase. +Two-factor authentication (2FA) adds an extra layer of security to your account by requiring a one-time +six-digit code each time you log into the support portal, in addition to your passphrase. -To enable 2FA: +2FA is required to use the support portal. After creating or logging into your account, you will be +prompted to enable 2FA. To do so: 1. Choose an application to generate two-factor codes. We recommend the `FreeOTP app `__ for Android or iOS, but any app that implements the Time-based One Time Password (TOTP) algorithm should work. -2. If you are not already logged in, log into the support portal. -3. Click **My account** in the top right corner to navigate to your - account settings. On the settings page, click **Enable authenticator app**. - |2FA setting| - -4. You will see a page that shows a QR code, similar to the one below. +2. You will see a page that shows a QR code, similar to the one below. Use your 2FA app's QR code scanning function to scan the code on the page, or manually enter the 2FA secret (called a "plain text key" here) in the app. |2FA example| -5. Select the account you have just added to your 2FA app, and generate a new +3. Select the account you have just added to your 2FA app, and generate a new one-time token using the app. Enter it on the webpage and click **Activate**. -6. You should see a success message like the one below. Follow the +4. You should see a success message like the one below. Follow the recommendation and click **generate backup codes**. |2FA success| -7. You will see a list of codes like the one below. Each code +5. You will be prompted to enter another two-factor code. Once you have + done so, you will see a list of codes like the one below. Each code (e.g., ``ec96 a5d7 c678``) can be used once *instead of* a 2FA code during the login sequence. Store these codes securely and separately from your passphrase. The recommended method is to keep a printout of @@ -127,7 +122,7 @@ To enable 2FA: |2FA backup codes| -8. Log out of your account and attempt to log in again. After entering your +6. Log out of your account and attempt to log in again. After entering your passphrase, you will additionally be prompted for a two-factor code, which you can generate using your 2FA app. @@ -139,7 +134,6 @@ Please do not hesitate to open a ticket or email us at securedrop@freedom.press (`GPG-encrypted `__) if you encounter difficulties using 2FA on the support portal. -.. |2FA setting| image:: images/support/account_settings_with_2fa_highlighted.png .. |2FA example| image:: images/support/qr_code_example.png .. |2FA success| image:: images/support/2fa_success.png .. |2FA backup codes| image:: images/support/2fa_backup_codes.png @@ -318,15 +312,15 @@ click on the "PGP" menu option in the upper right corner of the support window. |PGPMenu| -In the PGP management window you will see two columns: one for your -public key on the left, and one with the server's public key on the -right. +In the PGP management window you will see two sections: one for your +public key on the top, and one with the server's public key on the +bottom. |PGPUpload| To provide your public key, start by exporting an ASCII-armored copy of your public key. Paste your armored public key into the empty text box -on the left and hit **Save**. +at the top and hit **Save**. |PGPSave| @@ -334,8 +328,8 @@ Importing the server's public key ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Now, import the public key for our Redmine server into your local GPG -keyring. It is available on the right hand side of the page in the -column with the heading "Redmine Server (support@freedom.press)", in the +keyring. It is available on the bottom of the page in the +section with the heading "Redmine Server (support@freedom.press)", in the text box labeled "Public PGP key". Select the entire public key and copy it to your clipboard. Import the diff --git a/docs/images/support/2fa_backup_codes.png b/docs/images/support/2fa_backup_codes.png index f74a6ebb4..0cef7de26 100644 Binary files a/docs/images/support/2fa_backup_codes.png and b/docs/images/support/2fa_backup_codes.png differ diff --git a/docs/images/support/account_settings.png b/docs/images/support/account_settings.png index 9c059351e..f4eeac6e0 100644 Binary files a/docs/images/support/account_settings.png and b/docs/images/support/account_settings.png differ diff --git a/docs/images/support/account_settings_with_2fa_highlighted.png b/docs/images/support/account_settings_with_2fa_highlighted.png deleted file mode 100644 index 4309c1f09..000000000 Binary files a/docs/images/support/account_settings_with_2fa_highlighted.png and /dev/null differ diff --git a/docs/images/support/edit_issue_1.png b/docs/images/support/edit_issue_1.png index e13da7587..259efb117 100644 Binary files a/docs/images/support/edit_issue_1.png and b/docs/images/support/edit_issue_1.png differ diff --git a/docs/images/support/edit_issue_2.png b/docs/images/support/edit_issue_2.png index 626a867bc..a43c742c9 100644 Binary files a/docs/images/support/edit_issue_2.png and b/docs/images/support/edit_issue_2.png differ diff --git a/docs/images/support/home.png b/docs/images/support/home.png index 32d86f36f..1f7b6060f 100644 Binary files a/docs/images/support/home.png and b/docs/images/support/home.png differ diff --git a/docs/images/support/issues.png b/docs/images/support/issues.png index 900dd00e0..097fd3e51 100644 Binary files a/docs/images/support/issues.png and b/docs/images/support/issues.png differ diff --git a/docs/images/support/login.png b/docs/images/support/login.png index 2f2210a02..271defbdc 100644 Binary files a/docs/images/support/login.png and b/docs/images/support/login.png differ diff --git a/docs/images/support/new_issue.png b/docs/images/support/new_issue.png index fa82d8131..44061f97e 100644 Binary files a/docs/images/support/new_issue.png and b/docs/images/support/new_issue.png differ diff --git a/docs/images/support/onboarding_issue.png b/docs/images/support/onboarding_issue.png index dd13dac20..2aaecf561 100644 Binary files a/docs/images/support/onboarding_issue.png and b/docs/images/support/onboarding_issue.png differ diff --git a/docs/images/support/overview.png b/docs/images/support/overview.png index 7266e7e84..ea1d2bada 100644 Binary files a/docs/images/support/overview.png and b/docs/images/support/overview.png differ diff --git a/docs/images/support/pgp_menu.png b/docs/images/support/pgp_menu.png index 51d416ab1..74519fc6f 100644 Binary files a/docs/images/support/pgp_menu.png and b/docs/images/support/pgp_menu.png differ diff --git a/docs/images/support/pgp_save.png b/docs/images/support/pgp_save.png index 1c7fb2a98..e230975a4 100644 Binary files a/docs/images/support/pgp_save.png and b/docs/images/support/pgp_save.png differ diff --git a/docs/images/support/pgp_upload.png b/docs/images/support/pgp_upload.png index d29d4a705..366c2c662 100644 Binary files a/docs/images/support/pgp_upload.png and b/docs/images/support/pgp_upload.png differ diff --git a/docs/images/support/projects.png b/docs/images/support/projects.png index ad55f21da..cf6c55f04 100644 Binary files a/docs/images/support/projects.png and b/docs/images/support/projects.png differ diff --git a/docs/images/support/qr_code_example.png b/docs/images/support/qr_code_example.png index c1095b13b..165b4c694 100644 Binary files a/docs/images/support/qr_code_example.png and b/docs/images/support/qr_code_example.png differ diff --git a/docs/images/support/register.png b/docs/images/support/register.png index 4fb4e5e26..13303e94c 100644 Binary files a/docs/images/support/register.png and b/docs/images/support/register.png differ