Skip to content
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

DOC Remove mention of webauthn module #577

Merged
merged 1 commit into from
Nov 26, 2024
Merged

DOC Remove mention of webauthn module #577

Show file tree
Hide file tree
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
3 changes: 1 addition & 2 deletions composer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,7 @@
"silverstripe/webauthn-authenticator": "<4.5.0"
},
"suggest": {
"silverstripe/totp-authenticator": "Adds a method to authenticate with you phone using a time-based one-time password.",
"silverstripe/webauthn-authenticator": "Adds a method to authenticate with security keys or built-in platform authenticators."
"silverstripe/totp-authenticator": "Adds a method to authenticate with you phone using a time-based one-time password."
},
"extra": {
"expose": [
Expand Down
7 changes: 2 additions & 5 deletions docs/en/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,7 @@ title: Multi-factor authentication (MFA)

# Multi-factor authentication (MFA)

This module provides bases classes for implementing multi-factor authentication (MFA) in Silverstripe CMS. You should also install one of the additional multi-factor authenticator modules:

- [silverstripe/totp-authenticator](https://github.com/silverstripe/silverstripe-totp-authenticator)
- [silverstripe/webauthn-authenticator](https://github.com/silverstripe/silverstripe-webauthn-authenticator)
This module provides bases classes for implementing multi-factor authentication (MFA) in Silverstripe CMS. You should also install the [silverstripe/totp-authenticator](https://github.com/silverstripe/silverstripe-totp-authenticator) module to implement multi-factor authentication.

This module provides two distinct processes for MFA; verification and registration. This module provides a decoupled
architecture where front-end and back-end are separate. Provided with the module is a React app that interfaces with
Expand All @@ -23,7 +20,7 @@ composer require silverstripe/mfa

After installing this module *and* a supported factor method module (e.g. TOTP), the default member authenticator
will be replaced with the MFA authenticator instead. This will provide no change in the steps taken to log in until
an MFA Method has also been configured for the site. The TOTP and WebAuthn modules will configure themselves
an MFA Method has also been configured for the site. The TOTP modules will configure itself
automatically.

After installing the MFA module and having at least one method configured, MFA will automatically be enabled. By default
Expand Down