[GOOGLE2FA-3] Remove some config steps from docs Created: 08/Jan/24  Updated: 10/Jan/24

Status: Open
Project: google-2fa-authenticator
Component/s: None
Affects Version/s: None
Fix Version/s: None

Type: Improvement Priority: Neutral
Reporter: Chris Jennings Assignee: Chris Jennings
Resolution: Unresolved Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Template:
Acceptance criteria:
Empty
Date of First Response:

 Description   

I have recently installed and run this module.

The first step in the docs, securityCallback, was not necessary. The login form is changed automatically via bootstrap. See: https://git.magnolia-cms.com/projects/INCUBATOR/repos/google-2fa-authenticator/browse/google-2fa-authenticator/src/main/resources/mgnl-bootstrap/google-2fa-authenticator/config/config.server.filters.securityCallback.clientCallbacks.form.xml

The third step, qrCodeEmailTemplate, is also not necessary.
Bootstrap: https://git.magnolia-cms.com/projects/INCUBATOR/repos/google-2fa-authenticator/browse/google-2fa-authenticator/src/main/resources/mgnl-bootstrap/google-2fa-authenticator/config/config.modules.mail.config.templatesConfiguration.ga2faQrCodeEmailTemplate.xml

The final step, OTP Issuer Config, is also bootstrapped. See: https://git.magnolia-cms.com/projects/INCUBATOR/repos/google-2fa-authenticator/browse/google-2fa-authenticator/src/main/resources/mgnl-bootstrap/google-2fa-authenticator/config/config.modules.google-2fa-authenticator.config.xml

The docs neglect to mention that to enable 2FA an administrator must flip the boolean property at /modules/google-2fa-authenticator/config@enable2FA



 Comments   
Comment by Le Hai Thanh [ 09/Jan/24 ]

Hi chris.jennings 

Thanks for your contribution!

Yes, all default configurations are automatically altered via bootstrap. However, I still believe having a configuration session would be beneficial to explain how developers can configure or modify these values. What are your thoughts on altering the section title (Configuration) or adding more descriptive wording to address this situation?

We've already included a 'Manage 2FA' section that describes how to use (enable/disable/rescue) the module. Hence, we haven't included an 'enable' step. If there are ways to enhance readability and usefulness, please feel free to make updates

Thanks,

Thanh Le

 

Generated at Mon Feb 12 02:06:57 CET 2024 using Jira 9.4.2#940002-sha1:46d1a51de284217efdcb32434eab47a99af2938b.