docs(mfa): WebAuthn

pennersr · Jul 30, 2024 · 9b929bd · 9b929bd
1 parent c638d8c
commit 9b929bd
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 0 deletions.
diff --git a/docs/mfa/index.rst b/docs/mfa/index.rst
@@ -7,4 +7,5 @@ Multi-Factor Authentication
    configuration
    forms
    adapter
+   webauthn
    django-allauth-2fa
diff --git a/docs/mfa/introduction.rst b/docs/mfa/introduction.rst
@@ -31,3 +31,5 @@ Remember to add the app to the ``settings.py`` of your project::
         'allauth.mfa',
         ...
     ]
+
+Note that :doc:`WebAuthn support <./webauthn>` is disabled by default.
diff --git a/docs/mfa/webauthn.rst b/docs/mfa/webauthn.rst
@@ -0,0 +1,16 @@
+WebAuthn
+========
+
+WebAuthn support is disabled by default. To enable it, add these settings::
+
+    # Make sure "webauthn" is included.
+    MFA_SUPPORTED_TYPES = ["totp", "webauthn", "recovery_codes"]
+
+    # Optional: enable support for logging in using a (WebAuthn) passkey.
+    MFA_PASSKEY_LOGIN_ENABLED = True
+
+    # Optional -- use for local development only: the WebAuthn uses the
+    #``fido2`` package, and versions up to including version 1.1.3 do not
+    # regard localhost as a secure origin, which is problematic during
+    # local development and testing.
+    MFA_WEBAUTHN_ALLOW_INSECURE_ORIGIN = True
-Original file line number
+Diff line change
@@ Expand Up @@
             'allauth.mfa',
             ...
         ]
+    Note that :doc:`WebAuthn support <./webauthn>` is disabled by default.