Skip to main content
Support

Setting Up Two-Factor Authentication

Adding an extra layer of security for your HelpDocs account gives you peace of mind if your password becomes compromised.

River Sloane
Updated by River Sloane
2 min read
Table of Contents

Adding an extra layer of security for your HelpDocs account gives you peace of mind if your password becomes compromised. By enabling two-factor authentication (2FA) with a time-based one-time password (TOTP) you'll be able to make sure your Knowledge Base stays secure.

Once added your Authentication App will generate a new TOTP every 30 seconds that can be entered after logging in with your email and password.

Two-factor authentication only protects password sign-in. If your login doesn't have a password, Authentication app shows Not available until you set one with the password reset link on the login page. That link doesn't work on accounts with Require SSO turned on, where sign-in goes through your SSO provider.

Download an Authentication App

To start with you'll want to download an Authentication App capable of generating a time-based one-time password (TOTP). Here's just a few we recommend:

Set Up Authentication in Your Profile

  1. Head to your Profile by clicking your avatar in the top right, then Profile (or click here)

    Profile dropdown
  2. Scroll to Two-factor authentication and click Set up 2FA
  3. Enter your Current password and click Continue
  4. Add HelpDocs to your Authentication App by either:
    1. Scanning the QR Code using your Authentication App
    2. Copying the Set up URI and pasting it into your Authentication App
  5. Enter the current code under Enter code. We'll verify it as soon as you've typed all six digits, or you can press Verify
    A text field with 000000 typed in and a verify button next to it
  6. You'll be prompted to save your backup codes which allow you to recover your account in case you lose access to your TOTP. Each one works once. You can go ahead and download these with Download .txt file
    You won't be shown these backup codes once you navigate away. We highly recommend saving these in a safe place πŸ”
  7. Next time you log in you'll be prompted to enter your TOTP πŸ’–

Removing Two-Factor Authentication

  1. Head to Profile
  2. Scroll down to Two-factor authentication
  3. Click Disable
  4. Enter the current code your app is displaying under Passcode, or one of your backup codes under Backup code
  5. Click Disable authentication app
  6. You're done and your 2FA has been removed

What did you think of this doc?

Next Restricting your HelpDocs with Custom JWT SSO

Get in touch