Skip to content

create README.md for 2FA #5673

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Oct 16, 2024
Merged

create README.md for 2FA #5673

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions plugins/two-factor-auth/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Two Factor Authentication

The Two-Factor Authentication (2FA) Plugin for Countly enhances account security by adding an additional layer of authentication. It allows users to enable or disable 2FA for their accounts and provides administrative controls for managing 2FA settings for other users.

## Configuration View:

Registers labels for 2FA settings to customize the web UI.

## TwoFAUser Component:

Manages the 2FA setup modal.
Initializes 2FA settings and handles user interactions for enabling or disabling 2FA.
Sends requests to enable or disable 2FA and handles success and error responses.

## Registering the Component:

Registers the TwoFAUser component in the Countly Vue container under the account settings page.
This plugin provides a comprehensive solution for managing 2FA settings within the Countly application, enhancing the security of user accounts by requiring an additional authentication step.
Loading