### Install @clerk/remix Once you have a Remix application ready, you need to install Clerk's Remix SDK. This gives you access to our prebuilt components and hooks for Remix applications. ``` bash npm install @clerk/remix ``` ### Set Environment Keys Below is an example of your .env file. To get the respective keys go to the API Keys page in the Clerk dashboard. ```bash CLERK_PUBLISHABLE_KEY=pk_test_•••••••••••••••••••••••••••••••••• CLERK_SECRET_KEY=sk_test_•••••••••••••••••••••••••••••••••• ``` ### Disable ErrorBoundary Currently we are unable to support ErrorBoundaryV2 but will support this when Remix V2 is in general release, make sure that it is set to `false` in your `remix.config.js`: ```json /** @type {import('@remix-run/dev').AppConfig} */ module.exports = { ignoredRouteFiles: ["**/.*"], // appDirectory: "app", // assetsBuildDirectory: "public/build", // serverBuildPath: "build/index.js", // publicPath: "/build/", serverModuleFormat: "cjs", future: { v2_errorBoundary: false, v2_meta: true, v2_normalizeFormMethod: true, v2_routeConvention: true, }, }; ``` ### Configure `rootAuthLoader` To configure Clerk in your Remix application, you will need to update your root loader. This will enable us to have access to authentication state in any Remix routes. ```tsx import type { MetaFunction,LoaderFunction } from "@remix-run/node"; import { Links, LiveReload, Meta, Outlet, Scripts, ScrollRestoration, } from "@remix-run/react"; import { rootAuthLoader } from "@clerk/remix/ssr.server"; export const meta: MetaFunction = () => ({ charset: "utf-8", title: "New Remix App", viewport: "width=device-width,initial-scale=1", }); export const loader: LoaderFunction = (args) => rootAuthLoader(args); export default function App() { return ( ); } ``` If you need to load in additonal data you can pass your loader directly to the `rootAuthLoader`. ```tsx //Imports export const loader: LoaderFunction = args => { return rootAuthLoader(args, ({ request }) => { const { sessionId, userId, getToken } = request.auth; // fetch data return { yourData: 'here' }; }); }; // Additonal application code. ``` ### Configure ClerkApp Clerk provides a `ClerkApp` wrapper to provide the authentication state to your React tree. This helper works with Remix SSR out-of-the-box and follows the "higher-order component" paradigm. ```tsx import { ClerkApp } from "@clerk/remix"; import type { MetaFunction,LoaderFunction } from "@remix-run/node"; import { Links, LiveReload, Meta, Outlet, Scripts, ScrollRestoration, } from "@remix-run/react"; import { rootAuthLoader } from "@clerk/remix/ssr.server"; // Import ClerkApp import { ClerkApp } from "@clerk/remix"; export const meta: MetaFunction = () => ({ charset: "utf-8", title: "New Remix App", viewport: "width=device-width,initial-scale=1", }); export const loader: LoaderFunction = (args) => rootAuthLoader(args); function App() { return ( ); } // Wrap your app in ClerkApp(app) export default ClerkApp(App); ```` ### Set ClerkCatchBoundary Clerk uses short lived tokens to keep your application secure, to refresh expired tokens Clerk uses Remix's catch boundary. If you are seeing a 401 after a short period of time even though your user is logged in. Please verify you have implemented this section. ```tsx import { ClerkApp } from "@clerk/remix"; import type { MetaFunction,LoaderFunction } from "@remix-run/node"; import { Links, LiveReload, Meta, Outlet, Scripts, ScrollRestoration, } from "@remix-run/react"; import { rootAuthLoader } from "@clerk/remix/ssr.server"; import { ClerkApp, ClerkCatchBoundary } from "@clerk/remix"; export const meta: MetaFunction = () => ({ charset: "utf-8", title: "New Remix App", viewport: "width=device-width,initial-scale=1", }); export const loader: LoaderFunction = (args) => rootAuthLoader(args); // add a Catch Boundary export const CatchBoundary = ClerkCatchBoundary(); function App() { return ( ); } export default ClerkApp(App); ``` If you need to add a custom boundary to your application you can pass it as an argument to the `ClerkCatchBoundary`. ```tsx //imports export const CatchBoundary = ClerkCatchBoundary(YourBoundary); // Additional application code ``` Clerk offers a set of prebuilt components that you can use to embed sign in, sign up, and other user management functions into your Next.js application. We are going to use the ``,`` components by utlizing Remix routes. The functionality of the components are controlled by the instance settings you specify in your [Clerk Dashboard](https://dashboard.clerk.dev). ### Build Your Sign Up The page needs to be mounted on a catch all route for example: `app/routes/sign-up/$.tsx` ```tsx import { SignUp } from "@clerk/remix"; export default function SignUpPage() { return (

Sign Up route

); } ``` ### Build Your Sign In The page needs to be mounted on a catch all route for example: `app/routes/sign-in/$.tsx` ```tsx import { SignIn } from "@clerk/remix"; export default function SignInPage() { return (

Sign In route

); } ``` ### Update your dashboard settings To make sure you are using the embedded components you will need to update your instance settings in the [Clerk Dashboard](https://dashboard.clerk.dev) to use the embedded components. 1. Select Paths 2. Set paths to `/sign-in` and `/sign-up` By default, the Clerk components inherit the font family. ### Protecting Your Pages #### Client Side Clerk offers Control Components that allow you to protect your pages, below is a simple example using Clerk's hosted components and the `` and `` control components. ```tsx import { SignedIn, SignedOut, RedirectToSignIn, UserButton, } from "@clerk/remix"; export default function Index() { return (

Index route

You are signed in!

); } ``` #### Server Side To protect your routes you can use the the loader to check for the `userId` singleton, and if it doesn't exists redirect your user back to the sign in page. ```tsx import { UserButton, } from "@clerk/remix"; import { getAuth } from "@clerk/remix/ssr.server"; import { LoaderFunction, redirect } from "@remix-run/node"; export const loader: LoaderFunction = async (args) => { const { userId } = await getAuth(args); if(!userId){ return redirect("/sign-in"); } return {}; } export default function Index() { return (

Index route

You are signed in!

); } ``` ### Read Session & User Data Clerk provides a set of hooks and helpers that you can use to access the active session and user data in your Remix application. We have included examples of how to use these helpers to get you started. ### Client Side #### `useAuth` The `useAuth` hook is a convenient way to access the current auth state. This hook provides the minimal information needed for data-loading and helper methods to manage the current active session. ```tsx import { useAuth } from "@clerk/remix"; export default function Example() { const { isLoaded, userId, sessionId, getToken } = useAuth(); // In case the user signs out while on the page. if (!isLoaded || !userId) { return null; } return (

Hello, {userId} your current active session is {sessionId}

); } ``` #### `useUser` The `useUser` hook is a convenient way to access the current user data where you need it. This hook provides the user data and helper methods to manage the current active session. ```tsx import { useUser } from "@clerk/remix"; export default function Example() { const { isLoaded, isSignedIn, user } = useUser(); if (!isLoaded || !isSignedIn) { return null; } return

Hello, {user.firstName} welcome to Clerk

; } ``` ### Server Side #### getAuth() Using getAuth allows you to retrieve auth state and also ways to fetch data using the `getToken` function. ```tsx import {getAuth} from "@clerk/remix"; export const loader: LoaderFunction = async (args) => { // Using getAuth to retrieve data as needed. const { userId, sessionId, getToken } = await getAuth(args); console.log("Use getAuth() to access the auth state:", userId, sessionId, getToken); if (!userId) { return redirect("/sign-in?redirect_url=" + args.request.url); } // fetch data where you need the userId. const posts = await mockGetPosts(userId); return { posts }; }; ``` #### Retrieve Full User ```tsx import {getAuth,clerkClient} from "@clerk/remix"; export const loader: LoaderFunction = async (args) => { const { userId } = await getAuth(args); if (!userId) { return redirect("/sign-in?redirect_url=" + args.request.url); } const user = await createClerkClient({secretKey: process.env.CLERK_SECRET_KEY}).users.getUser(userId); return { serialisedUser: JSON.stringify(user) }; }; ```

Remix Authentication

Easily add secure, edge- and SSR-friendly authentication to Remix with Clerk.