Skip to content

Commit

Permalink
Adding latest notes about imagick
Browse files Browse the repository at this point in the history
  • Loading branch information
tnylea committed Sep 15, 2024
1 parent d89541a commit 609997f
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 7 deletions.
16 changes: 9 additions & 7 deletions content/docs/authentication-pages.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,46 +17,48 @@ DevDojo Auth contains many pages that provide functionality for the most common

The Login Page. Visit this page at **/auth/login**

<include src="docs/auth-page-image.html" page="login"></include><div class="p-5 rounded-b-lg border text-zinc-300 bg-zinc-900 border-zinc-700">
<include src="docs/auth-page-image.html" page="login"></include><div class="p-5 border rounded-b-lg text-zinc-300 bg-zinc-900 border-zinc-700">
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.
</div>

## Register

The Register Page. Visit this page at **/auth/register**

<include src="docs/auth-page-image.html" page="register"></include><div class="p-5 rounded-b-lg border text-zinc-300 bg-zinc-900 border-zinc-700">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 <a href="{ url('/docs/config/social-providers') }">Social Provider</a>.
<include src="docs/auth-page-image.html" page="register"></include><div class="p-5 border rounded-b-lg text-zinc-300 bg-zinc-900 border-zinc-700">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 <a href="{ url('/docs/config/social-providers') }">Social Provider</a>.
</div>

## Verify Email

The Email Verification Page. Visit this page at **/auth/verify**

<include src="docs/auth-page-image.html" page="verify"></include><div class="p-5 rounded-b-lg border text-zinc-300 bg-zinc-900 border-zinc-700">By default users are not required to verify their email. Toggle the <strong>Registration Require Email Verification</strong> option in the settings to show this screen after account creation.</div>
<include src="docs/auth-page-image.html" page="verify"></include><div class="p-5 border rounded-b-lg text-zinc-300 bg-zinc-900 border-zinc-700">By default users are not required to verify their email. Toggle the <strong>Registration Require Email Verification</strong> option in the settings to show this screen after account creation.</div>

## Password Confirmation

The Password Confirmation Page. Visit this page at **/auth/confirm**

<include src="docs/auth-page-image.html" page="confirm"></include><div class="p-5 rounded-b-lg border text-zinc-300 bg-zinc-900 border-zinc-700">Add the <strong>password.confirm</strong> middleware to any page, and users will be required to confirm their password before gaining access to the page.</div>
<include src="docs/auth-page-image.html" page="confirm"></include><div class="p-5 border rounded-b-lg text-zinc-300 bg-zinc-900 border-zinc-700">Add the <strong>password.confirm</strong> middleware to any page, and users will be required to confirm their password before gaining access to the page.</div>

## Password Reset Request

The Password Reset Request Page. Visit this page at **/auth/password/reset**

<include src="docs/auth-page-image.html" page="password-reset-request"></include><div class="p-5 rounded-b-lg border text-zinc-300 bg-zinc-900 border-zinc-700">This page allows users to reset their password after clicking the reset link sent to their email.</div>
<include src="docs/auth-page-image.html" page="password-reset-request"></include><div class="p-5 border rounded-b-lg text-zinc-300 bg-zinc-900 border-zinc-700">This page allows users to reset their password after clicking the reset link sent to their email.</div>

## Password Reset

The Password Reset Page. Visit this page at **/auth/password/ReAlLyLoNgToKeNhErE**

<include src="docs/auth-page-image.html" page="password-reset"></include><div class="p-5 rounded-b-lg border text-zinc-300 bg-zinc-900 border-zinc-700">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.</div>
<include src="docs/auth-page-image.html" page="password-reset"></include><div class="p-5 border rounded-b-lg text-zinc-300 bg-zinc-900 border-zinc-700">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.</div>

## Two-Factor Challenge

The Two-Factor Authentication Challenge Page. Visit this page at **/auth/two-factor-challenge**

<include src="docs/auth-page-image.html" page="two-factor"></include><div class="p-5 rounded-b-lg border text-zinc-300 bg-zinc-900 border-zinc-700">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 <a href="{ url('/docs/config/two-factor-auth') }">Two-Factor Authentication here</a>.</div>
<include src="docs/auth-page-image.html" page="two-factor"></include><div class="p-5 border rounded-b-lg text-zinc-300 bg-zinc-900 border-zinc-700">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 <a href="{ url('/docs/config/two-factor-auth') }">Two-Factor Authentication here</a>.</div>

> 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

Expand Down
3 changes: 3 additions & 0 deletions content/docs/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,7 @@ You may find yourself needing to reset the configurations for your Authenticatio
<div class="p-5 font-mono whitespace-break-spaces bg-white/[6%] rounded-xl border border-white/[8%]"><span class="text-pink-400">php</span> <span class="text-green-400">artisan</span> <span class="text-yellow-400">vendor:publish</span> <span class="text-[#b4fd4f]">--tag=auth:config</span> <span class="text-red-400">--force</span>
</div>

# 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 <a href="https://github.com/thedevdojo/auth/pull/90" target="_blank">this PR</a>; however, it's best to only include it if needed.

0 comments on commit 609997f

Please sign in to comment.