diff --git a/content/docs/authentication-pages.md b/content/docs/authentication-pages.md index 2cee3ba..b28dd7b 100644 --- a/content/docs/authentication-pages.md +++ b/content/docs/authentication-pages.md @@ -17,7 +17,7 @@ DevDojo Auth contains many pages that provide functionality for the most common The Login Page. Visit this page at **/auth/login** -
+
The login page is where a user can enter their email address and password and be authenticated in your application. You may optionally choose to show social provider links on this page.
@@ -25,38 +25,40 @@ The Login Page. Visit this page at **/auth/login** The Register Page. Visit this page at **/auth/register** -
The registration page is where a user can sign up for a new account. Additionally, you can require users to provide their full name and allow them so register from any Social Provider. +
The registration page is where a user can sign up for a new account. Additionally, you can require users to provide their full name and allow them so register from any Social Provider.
## Verify Email The Email Verification Page. Visit this page at **/auth/verify** -
By default users are not required to verify their email. Toggle the Registration Require Email Verification option in the settings to show this screen after account creation.
+
By default users are not required to verify their email. Toggle the Registration Require Email Verification option in the settings to show this screen after account creation.
## Password Confirmation The Password Confirmation Page. Visit this page at **/auth/confirm** -
Add the password.confirm middleware to any page, and users will be required to confirm their password before gaining access to the page.
+
Add the password.confirm middleware to any page, and users will be required to confirm their password before gaining access to the page.
## Password Reset Request The Password Reset Request Page. Visit this page at **/auth/password/reset** -
This page allows users to reset their password after clicking the reset link sent to their email.
+
This page allows users to reset their password after clicking the reset link sent to their email.
## Password Reset The Password Reset Page. Visit this page at **/auth/password/ReAlLyLoNgToKeNhErE** -
This is the actual password reset page. When the user clicks a link from their email to reset their password, this is the page they will see, allowing them to reset their password.
+
This is the actual password reset page. When the user clicks a link from their email to reset their password, this is the page they will see, allowing them to reset their password.
## Two-Factor Challenge The Two-Factor Authentication Challenge Page. Visit this page at **/auth/two-factor-challenge** -
If you are using 2FA and the user has enabled 2FA for their account, this is the page they will see after attempting to log in. Learn more about Two-Factor Authentication here.
+
If you are using 2FA and the user has enabled 2FA for their account, this is the page they will see after attempting to log in. Learn more about Two-Factor Authentication here.
+ +> When using 2FA you need to have the Imagick extension installed to generate the QR code image. You'll also need to install the PHP extension via `composer require ext-imagick` ## Two-Factor Setup diff --git a/content/docs/troubleshooting.md b/content/docs/troubleshooting.md index 1afdf01..0eaf1cf 100644 --- a/content/docs/troubleshooting.md +++ b/content/docs/troubleshooting.md @@ -20,4 +20,7 @@ You may find yourself needing to reset the configurations for your Authenticatio
php artisan vendor:publish --tag=auth:config --force
+# Imagick Extension + +In order to use the 2FA QR code image, you need to install the Imagick extension as well as install it via composer: `composer require ext-imagick`. This was originally added by default in this PR; however, it's best to only include it if needed.