Remix session replay installation

  1. Install the package

    Required
    Remix version

    This guide is for Remix v2. For Remix v3, see our React Router v7 docs.

    Install the PostHog JavaScript library using your package manager:

    npm install posthog-js
  2. Configure Vite

    Required

    Add posthog-js and posthog-js/react to ssr.noExternal in your vite.config.ts so they get bundled for SSR:

    vite.config.ts
    // ... imports and rest of config
    export default defineConfig({
    plugins: [
    remix({
    future: {
    v3_fetcherPersist: true,
    v3_relativeSplatPath: true,
    v3_throwAbortReason: true,
    v3_singleFetch: true,
    v3_lazyRouteDiscovery: true,
    },
    }),
    tsconfigPaths(),
    ],
    ssr: {
    noExternal: ["posthog-js", "posthog-js/react"],
    },
    });
  3. Create a provider

    Required

    Create a provider.tsx file in the app folder. Set up the PostHog provider to initialize after hydration:

    app/provider.tsx
    import { useEffect, useState } from "react";
    import posthog from "posthog-js";
    import { PostHogProvider } from "posthog-js/react";
    export function PHProvider({ children }: { children: React.ReactNode }) {
    const [hydrated, setHydrated] = useState(false);
    useEffect(() => {
    posthog.init("<ph_project_api_key>", {
    api_host: "https://us.i.posthog.com",
    defaults: "2025-11-30"
    });
    setHydrated(true);
    }, []);
    if (!hydrated) return <>{children}</>;
    return <PostHogProvider client={posthog}>{children}</PostHogProvider>;
    }
  4. Wrap your app

    Required

    Import the PHProvider component in your app/root.tsx file and use it to wrap your app:

    app/root.tsx
    // ... imports
    import { PHProvider } from "./provider";
    // ... links, meta, etc.
    export function Layout({ children }: { children: React.ReactNode }) {
    return (
    <html lang="en">
    <head>
    <meta charSet="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1" />
    <Meta />
    <Links />
    </head>
    <body>
    <PHProvider>
    {children}
    <ScrollRestoration />
    <Scripts />
    </PHProvider>
    </body>
    </html>
    );
    }
    export default function App() {
    return <Outlet />;
    }
  5. Watch session recordings

    Recommended

    Visit your site or app and interact with it for at least 10 seconds to generate a recording. Navigate between pages, click buttons, and fill out forms to capture meaningful interactions.

    Watch your first recording →

  6. Next steps

    Recommended

    Now that you're recording sessions, continue with the resources below to learn what else Session Replay enables within the PostHog platform.

    ResourceDescription
    Watching recordingsHow to find and watch session recordings
    Privacy controlsHow to mask sensitive data in recordings
    Network recordingHow to capture network requests in recordings
    Console log recordingHow to capture console logs in recordings
    More tutorialsOther real-world examples and use cases

Community questions

Was this page useful?

Questions about this page? or post a community question.