Build your own sign-in-or-up page for your Next.js app with Clerk
This guide shows you how to use the <SignIn /> component with the Next.js optional catch-all route in order to build a custom page for your Next.js app that allows users to sign in or sign up within a single flow.
If the prebuilt components don't meet your specific needs or if you require more control over the logic, you can rebuild the existing Clerk flows using the Clerk API. For more information, see the custom flow guides.
Build a sign-in-or-up page
The following example demonstrates how to render the <SignIn /> component to allow users to both sign-in or sign-up from a single flow.
import { SignIn } from '@clerk/nextjs'
export default function Page() {
return <SignIn />
}Make the sign-in-or-up route public
By default, clerkMiddleware() makes all routes public. This step is specifically for applications that have configured clerkMiddleware() to make all routes protected. If you have not configured clerkMiddleware() to protect all routes, you can skip this step.
To make the sign-in route public:
- Navigate to your
middleware.tsfile. - Create a new route matcher that matches the sign-in route, or you can add it to your existing route matcher that is making routes public.
- Create a check to see if the user's current route is a public route. If it is not a public route, use
auth.protect()to protect the route.
import { clerkMiddleware, createRouteMatcher } from '@clerk/nextjs/server'
const isPublicRoute = createRouteMatcher(['/sign-in(.*)'])
export default clerkMiddleware(async (auth, request) => {
if (!isPublicRoute(request)) {
await auth.protect()
}
})
export const config = {
matcher: [
// Skip Next.js internals and all static files, unless found in search params
'/((?!_next|[^?]*\\.(?:html?|css|js(?!on)|jpe?g|webp|png|gif|svg|ttf|woff2?|ico|csv|docx?|xlsx?|zip|webmanifest)).*)',
// Always run for API routes
'/(api|trpc)(.*)',
],
}Update your environment variables
Update your environment variables to point to your custom sign-in page. Learn more about the available environment variables.
NEXT_PUBLIC_CLERK_SIGN_IN_URL=/sign-inVisit your new page
Run your project with the following command:
npm run devyarn devpnpm devVisit your new custom page locally at localhost:3000/sign-in.
Custom sign-up page
Learn how to add a custom sign-up page to your Next.js app with Clerk's prebuilt components.
Read user and session data
Learn how to use Clerk's hooks and helpers to access the active session and user data in your Next.js application.
Client-side helpers
Learn more about Next.js client-side helpers and how to use them.
Next.js SDK Reference
Learn more about additional Next.js methods.
Clerk components
Learn more about Clerk's prebuilt components that make authentication and user management easy.
Feedback
Last updated on