Skip to content

Commit 5eb5cb1

Browse files
JudahmeekJudahmeek
authored
Combine feature documentation into features section
...to reduce redundancy
1 parent 30cae38 commit 5eb5cb1

File tree

1 file changed

+57
-107
lines changed

1 file changed

+57
-107
lines changed

‎README.rdoc‎

Lines changed: 57 additions & 107 deletions
Original file line numberDiff line numberDiff line change
@@ -19,55 +19,63 @@ HTML and JSON API for all supported features.
1919
* Simplicity: Allow for easy configuration via a DSL
2020
* Flexibility: Allow for easy overriding of any part of the framework
2121

22-
== Features
23-
24-
* Login
25-
* Logout
26-
* Change Password
27-
* Change Login
28-
* Reset Password
29-
* Create Account
30-
* Close Account
31-
* Verify Account
32-
* Confirm Password
33-
* Remember (Autologin via token)
34-
* Lockout (Bruteforce protection)
35-
* Audit Logging
36-
* Email Authentication (Passwordless login via email link)
37-
* WebAuthn (Multifactor authentication via WebAuthn)
38-
* WebAuthn Login (Passwordless login via WebAuthn)
39-
* WebAuthn Verify Account (Passwordless WebAuthn Setup)
40-
* WebAuthn Autofill (Autofill WebAuthn credentials on login)
41-
* WebAuthn Modify Email (Email when WebAuthn authenticator added or removed)
42-
* OTP (Multifactor authentication via TOTP)
43-
* OTP Modify Email (Email when TOTP authentication setup or disabled)
44-
* OTP Unlock (Unlock TOTP authentication after lockout)
45-
* OTP Lockout Email (Email when TOTP authentication locked out or unlocked)
46-
* Recovery Codes (Multifactor authentication via backup codes)
47-
* SMS Codes (Multifactor authentication via SMS)
48-
* Verify Login Change (Verify new login before changing login)
49-
* Verify Account Grace Period (Don't require verification before login)
50-
* Password Grace Period (Don't require password entry if recently entered)
51-
* Password Complexity (More sophisticated checks)
52-
* Password Pepper
53-
* Disallow Password Reuse
54-
* Disallow Common Passwords
55-
* Password Expiration
56-
* Account Expiration
57-
* Session Expiration
58-
* Active Sessions (Prevent session reuse after logout, allow logout of all sessions)
59-
* Single Session (Only one active session per account)
60-
* JSON (JSON API support for all other features)
61-
* JWT (JSON Web Token support for all other features)
62-
* JWT Refresh (Access & Refresh Token)
63-
* JWT CORS (Cross-Origin Resource Sharing)
64-
* Update Password Hash (when hash cost changes)
65-
* Argon2
66-
* HTTP Basic Auth
67-
* Change Password Notify
68-
* Reset Password Notify
69-
* Internal Request
70-
* Path Class Methods
22+
=== Feature Documentation
23+
24+
The options/methods for the supported features are listed on a
25+
separate page per feature. If these links are not active, please
26+
view the appropriate file in the doc directory.
27+
28+
* {Base}[rdoc-ref:doc/base.rdoc] (this feature is autoloaded)
29+
* {Login Password Requirements Base}[rdoc-ref:doc/login_password_requirements_base.rdoc] (this feature is autoloaded by features that set logins/passwords)
30+
* {Email Base}[rdoc-ref:doc/email_base.rdoc] (this feature is autoloaded by features that send email)
31+
* {Two Factor Base}[rdoc-ref:doc/two_factor_base.rdoc] (this feature is autoloaded by 2 factor authentication features)
32+
* {Account Expiration}[rdoc-ref:doc/account_expiration.rdoc]
33+
* {Active Sessions}[rdoc-ref:doc/active_sessions.rdoc]
34+
* {Audit Logging}[rdoc-ref:doc/audit_logging.rdoc]
35+
* {Argon2}[rdoc-ref:doc/argon2.rdoc]
36+
* {Change Login}[rdoc-ref:doc/change_login.rdoc]
37+
* {Change Password}[rdoc-ref:doc/change_password.rdoc]
38+
* {Change Password Notify}[rdoc-ref:doc/change_password_notify.rdoc]
39+
* {Close Account}[rdoc-ref:doc/close_account.rdoc]
40+
* {Confirm Password}[rdoc-ref:doc/confirm_password.rdoc]
41+
* {Create Account}[rdoc-ref:doc/create_account.rdoc]
42+
* {Disallow Common Passwords}[rdoc-ref:doc/disallow_common_passwords.rdoc]
43+
* {Disallow Password Reuse}[rdoc-ref:doc/disallow_password_reuse.rdoc]
44+
* {Email Authentication}[rdoc-ref:doc/email_auth.rdoc]
45+
* {HTTP Basic Auth}[rdoc-ref:doc/http_basic_auth.rdoc]
46+
* {Internal Request}[rdoc-ref:doc/internal_request.rdoc]
47+
* {JSON}[rdoc-ref:doc/json.rdoc]
48+
* {JWT CORS}[rdoc-ref:doc/jwt_cors.rdoc]
49+
* {JWT Refresh}[rdoc-ref:doc/jwt_refresh.rdoc]
50+
* {JWT}[rdoc-ref:doc/jwt.rdoc]
51+
* {Lockout}[rdoc-ref:doc/lockout.rdoc]
52+
* {Login}[rdoc-ref:doc/login.rdoc]
53+
* {Logout}[rdoc-ref:doc/logout.rdoc]
54+
* {OTP}[rdoc-ref:doc/otp.rdoc]
55+
* {OTP Lockout Email}[rdoc-ref:doc/otp_lockout_email.rdoc]
56+
* {OTP Modify Email}[rdoc-ref:doc/otp_modify_email.rdoc]
57+
* {OTP Unlock}[rdoc-ref:doc/otp_unlock.rdoc]
58+
* {Password Complexity}[rdoc-ref:doc/password_complexity.rdoc]
59+
* {Password Expiration}[rdoc-ref:doc/password_expiration.rdoc]
60+
* {Password Grace Period}[rdoc-ref:doc/password_grace_period.rdoc]
61+
* {Password Pepper}[rdoc-ref:doc/password_pepper.rdoc]
62+
* {Path Class Methods}[rdoc-ref:doc/path_class_methods.rdoc]
63+
* {Recovery Codes}[rdoc-ref:doc/recovery_codes.rdoc]
64+
* {Remember}[rdoc-ref:doc/remember.rdoc]
65+
* {Reset Password}[rdoc-ref:doc/reset_password.rdoc]
66+
* {Reset Password Notify}[rdoc-ref:doc/reset_password_notify.rdoc]
67+
* {Session Expiration}[rdoc-ref:doc/session_expiration.rdoc]
68+
* {Single Session}[rdoc-ref:doc/single_session.rdoc]
69+
* {SMS Codes}[rdoc-ref:doc/sms_codes.rdoc]
70+
* {Update Password Hash}[rdoc-ref:doc/update_password_hash.rdoc]
71+
* {Verify Account}[rdoc-ref:doc/verify_account.rdoc]
72+
* {Verify Account Grace Period}[rdoc-ref:doc/verify_account_grace_period.rdoc]
73+
* {Verify Login Change}[rdoc-ref:doc/verify_login_change.rdoc]
74+
* {WebAuthn}[rdoc-ref:doc/webauthn.rdoc]
75+
* {WebAuthn Autofill}[rdoc-ref:doc/webauthn_autofill.rdoc]
76+
* {WebAuthn Login}[rdoc-ref:doc/webauthn_login.rdoc]
77+
* {WebAuthn Modify Email}[rdoc-ref:doc/webauthn_modify_email.rdoc]
78+
* {WebAuthn Verify Account}[rdoc-ref:doc/webauthn_verify_account.rdoc]
7179

7280
== Resources
7381

@@ -900,64 +908,6 @@ which configures which dependent plugins should be loaded. Options:
900908
on the Roda application. By default, an anonymous
901909
Rodauth::Auth subclass is created.
902910

903-
=== Feature Documentation
904-
905-
The options/methods for the supported features are listed on a
906-
separate page per feature. If these links are not active, please
907-
view the appropriate file in the doc directory.
908-
909-
* {Base}[rdoc-ref:doc/base.rdoc] (this feature is autoloaded)
910-
* {Login Password Requirements Base}[rdoc-ref:doc/login_password_requirements_base.rdoc] (this feature is autoloaded by features that set logins/passwords)
911-
* {Email Base}[rdoc-ref:doc/email_base.rdoc] (this feature is autoloaded by features that send email)
912-
* {Two Factor Base}[rdoc-ref:doc/two_factor_base.rdoc] (this feature is autoloaded by 2 factor authentication features)
913-
* {Account Expiration}[rdoc-ref:doc/account_expiration.rdoc]
914-
* {Active Sessions}[rdoc-ref:doc/active_sessions.rdoc]
915-
* {Audit Logging}[rdoc-ref:doc/audit_logging.rdoc]
916-
* {Argon2}[rdoc-ref:doc/argon2.rdoc]
917-
* {Change Login}[rdoc-ref:doc/change_login.rdoc]
918-
* {Change Password}[rdoc-ref:doc/change_password.rdoc]
919-
* {Change Password Notify}[rdoc-ref:doc/change_password_notify.rdoc]
920-
* {Close Account}[rdoc-ref:doc/close_account.rdoc]
921-
* {Confirm Password}[rdoc-ref:doc/confirm_password.rdoc]
922-
* {Create Account}[rdoc-ref:doc/create_account.rdoc]
923-
* {Disallow Common Passwords}[rdoc-ref:doc/disallow_common_passwords.rdoc]
924-
* {Disallow Password Reuse}[rdoc-ref:doc/disallow_password_reuse.rdoc]
925-
* {Email Authentication}[rdoc-ref:doc/email_auth.rdoc]
926-
* {HTTP Basic Auth}[rdoc-ref:doc/http_basic_auth.rdoc]
927-
* {Internal Request}[rdoc-ref:doc/internal_request.rdoc]
928-
* {JSON}[rdoc-ref:doc/json.rdoc]
929-
* {JWT CORS}[rdoc-ref:doc/jwt_cors.rdoc]
930-
* {JWT Refresh}[rdoc-ref:doc/jwt_refresh.rdoc]
931-
* {JWT}[rdoc-ref:doc/jwt.rdoc]
932-
* {Lockout}[rdoc-ref:doc/lockout.rdoc]
933-
* {Login}[rdoc-ref:doc/login.rdoc]
934-
* {Logout}[rdoc-ref:doc/logout.rdoc]
935-
* {OTP}[rdoc-ref:doc/otp.rdoc]
936-
* {OTP Lockout Email}[rdoc-ref:doc/otp_lockout_email.rdoc]
937-
* {OTP Modify Email}[rdoc-ref:doc/otp_modify_email.rdoc]
938-
* {OTP Unlock}[rdoc-ref:doc/otp_unlock.rdoc]
939-
* {Password Complexity}[rdoc-ref:doc/password_complexity.rdoc]
940-
* {Password Expiration}[rdoc-ref:doc/password_expiration.rdoc]
941-
* {Password Grace Period}[rdoc-ref:doc/password_grace_period.rdoc]
942-
* {Password Pepper}[rdoc-ref:doc/password_pepper.rdoc]
943-
* {Path Class Methods}[rdoc-ref:doc/path_class_methods.rdoc]
944-
* {Recovery Codes}[rdoc-ref:doc/recovery_codes.rdoc]
945-
* {Remember}[rdoc-ref:doc/remember.rdoc]
946-
* {Reset Password}[rdoc-ref:doc/reset_password.rdoc]
947-
* {Reset Password Notify}[rdoc-ref:doc/reset_password_notify.rdoc]
948-
* {Session Expiration}[rdoc-ref:doc/session_expiration.rdoc]
949-
* {Single Session}[rdoc-ref:doc/single_session.rdoc]
950-
* {SMS Codes}[rdoc-ref:doc/sms_codes.rdoc]
951-
* {Update Password Hash}[rdoc-ref:doc/update_password_hash.rdoc]
952-
* {Verify Account}[rdoc-ref:doc/verify_account.rdoc]
953-
* {Verify Account Grace Period}[rdoc-ref:doc/verify_account_grace_period.rdoc]
954-
* {Verify Login Change}[rdoc-ref:doc/verify_login_change.rdoc]
955-
* {WebAuthn}[rdoc-ref:doc/webauthn.rdoc]
956-
* {WebAuthn Autofill}[rdoc-ref:doc/webauthn_autofill.rdoc]
957-
* {WebAuthn Login}[rdoc-ref:doc/webauthn_login.rdoc]
958-
* {WebAuthn Modify Email}[rdoc-ref:doc/webauthn_modify_email.rdoc]
959-
* {WebAuthn Verify Account}[rdoc-ref:doc/webauthn_verify_account.rdoc]
960-
961911
=== Calling Rodauth in the Routing Tree
962912

963913
In general, you will usually want to call +r.rodauth+ early in your

0 commit comments

Comments
 (0)