# Add CLItrail to Fumadocs

Where the CLItrail tag goes in Fumadocs, in its own idiom, with the consent, CSP and client-side routing details and how to check it works.

Written for Fumadocs 16 on the Next.js App Router

## Where the tag goes

Edit `app/layout.tsx`. Put the tag on every page that shows your install command; site-wide is best, after your existing analytics tags.

```js
import Script from 'next/script';
import { RootProvider } from 'fumadocs-ui/provider/next';
import type { ReactNode } from 'react';

export default function Layout({ children }: { children: ReactNode }) {
  return (
    <html lang="en" suppressHydrationWarning>
      <body>
        <RootProvider>{children}</RootProvider>
        <Script src="https://YOUR_SERVICE/browser.js" data-website="YOUR_WEBSITE_ID" strategy="afterInteractive" />
      </body>
    </html>
  );
}
```

## Only after consent

Use the loader in place of the tag: nothing from CLItrail loads until `startClitrail()` runs. Load the loader before your consent manager's script and call `startClitrail()` from the manager's accept callback (most managers also run it on later visits once a choice is stored; check yours). Use the marketing category when installs go to Google Ads, Meta, TikTok or X Ads, and the analytics category when they only reach GA4 or your webhooks.

Consent loader

```js
// Loads CLItrail only after the visitor agrees. Call startClitrail() from your
// consent manager's "accepted" callback; nothing is fetched or stored before that.
window.startClitrail = () => {
  if (document.getElementById('clitrail')) return;
  const tag = document.createElement('script');
  tag.id = 'clitrail';
  tag.src = 'https://YOUR_SERVICE/browser.js';
  tag.dataset.website = 'YOUR_WEBSITE_ID';
  document.head.append(tag);
};
```

```js
<Script src="/clitrail-consent.js" strategy="beforeInteractive" />
```

## Client-side routing

Links and `router.push` change pages without a reload. Render `<ClitrailRoutes />` once in the root layout: it records a visit whenever `usePathname()` changes. The page the browser loaded is recorded by the tag, not again.

Route helper

```js
// Records a visit when client-side navigation opens a new page path. The tag records
// the page the browser loaded, so that page is never recorded twice; before the SDK has
// started (for example, before consent) it records nothing.
declare global {
  interface Window {
    InstallAttribution?: { init(options: { service: string; project: string }): Promise<unknown>; ready?: Promise<unknown> };
  }
}

let recorded: string | undefined;

export function recordVisit(): void {
  if (typeof window === 'undefined') return;
  recorded ??= new URL(performance.getEntriesByType('navigation')[0]?.name ?? location.href).pathname;
  const sdk = window.InstallAttribution;
  if (!sdk?.ready || location.pathname === recorded) return;
  recorded = location.pathname;
  sdk.ready = sdk.init({ service: 'https://YOUR_SERVICE', project: 'YOUR_WEBSITE_ID' });
}
```

```js
'use client';
import { useEffect } from 'react';
import { usePathname } from 'next/navigation';
import { recordVisit } from '../lib/clitrail';

// Render once in the root layout: records a visit whenever the path changes.
export function ClitrailRoutes() {
  const pathname = usePathname();
  useEffect(() => { recordVisit(); }, [pathname]);
  return null;
}
```

Render it once

```js
import { ClitrailRoutes } from './clitrail-routes';

// In <body>, next to the CLItrail Script:
<ClitrailRoutes />
```

## Content Security Policy

A fixed policy goes in `next.config.js` `headers()`; a nonce-based one in `proxy.ts` (`middleware.ts` before Next.js 16). In either, add `https://YOUR_SERVICE` to `script-src` and `connect-src`, and `blob:` to `worker-src` (only Safari before 26 needs that one). With a nonce and `'strict-dynamic'`, also pass the nonce to the Script (`nonce={nonce}`, read from `headers()` in a Server Component) as Next.js's CSP guide shows.

```
script-src 'self' https://YOUR_SERVICE;
connect-src 'self' https://YOUR_SERVICE;
worker-src 'self' blob:;
```

## Verify it works

1. Run `npm run dev` (http://localhost:3000) or deploy.
2. Open a page with the tag in Chrome or Firefox (accept analytics first if you gate CLItrail on consent), open the developer console and run `await InstallAttribution.ready`. It resolves to `{ ok: true, urlId, hasAnalyticsContext, expiresAt }`.
3. In the CLItrail dashboard, open Visits & identities: the visit is listed.
4. Anything else names the cause: `disabled` (no consent yet, or `data-enabled="false"`), `opfs_unavailable` (the page is not served over https or from localhost), `Error` (the service refused the visit: add the page's origin, including a development origin such as `http://localhost:3000`, under Settings → Additional domains). If `InstallAttribution` is undefined, the tag did not load: check the Network tab and your Content-Security-Policy.

Then run your installer on the same computer and check **Install events**, or run the hook with [`--doctor`](https://clitrail.com/docs/doctor).

## Notes

Fumadocs on another framework (React Router, TanStack Start, Waku) follows that framework's guide.

Fumadocs documentation: [fumadocs.dev/docs](https://fumadocs.dev/docs)

Using other install paths or destinations? The [setup generator](https://clitrail.com/docs/setup-generator) puts this snippet together with your hooks and destination checklist.
