-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Docs: document 2fa #11716
Merged
Docs: document 2fa #11716
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
Configuring two-factor authentication | ||
===================================== | ||
|
||
Two-factor authentication (2FA) adds an extra layer of security to your Read the Docs account. | ||
When you enable 2FA, you need to provide two pieces of information to log in: your password and a verification code. | ||
|
||
Enabling two-factor authentication | ||
---------------------------------- | ||
|
||
To enable 2FA: | ||
|
||
- Go to your account settings. | ||
- Click on :guilabel:`Two-factor authentication`. | ||
- Click on :guilabel:`Activate`. | ||
- Scan the QR code with your authenticator app. | ||
- Enter the verification code from your authenticator app. | ||
- Click on :guilabel:`Activate`. | ||
- Save your recovery codes in a safe place. | ||
|
||
.. warning:: | ||
|
||
If you lose access to your authenticator app, you can use the recovery codes to log in. | ||
Keep them in a safe place, as they are the only way to access your account if you lose your device. | ||
|
||
Disabling two-factor authentication | ||
----------------------------------- | ||
|
||
To disable 2FA: | ||
|
||
- Go to your account settings. | ||
- Click on :guilabel:`Two-factor authentication`. | ||
- Click on :guilabel:`Deactivate`. | ||
|
||
Managing recovery codes | ||
----------------------- | ||
|
||
To manage your recovery codes: | ||
|
||
- Go to your account settings. | ||
- Click on :guilabel:`Two-factor authentication`. | ||
- Click on :guilabel:`Manage recovery codes`. | ||
|
||
From there you can download your recovery codes or generate new ones. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should probably have an overview of auth stuff in the docs as well. Just having a guide feels like a good starting point, but I think we want to mention it in other places as well. If there isn't an obvious place to list this as a feature, we should probably create one.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yeah, I was having trouble finding a place where to put this content.