# Add CLItrail to Starlight (Astro) Where the CLItrail tag goes in Starlight (Astro), in its own idiom, with the consent, CSP and client-side routing details and how to check it works. Written for Starlight 0.x on Astro 7 ## Where the tag goes Edit `astro.config.mjs`. Put the tag on every page that shows your install command; site-wide is best, after your existing analytics tags. ```js import { defineConfig } from 'astro/config'; import starlight from '@astrojs/starlight'; export default defineConfig({ integrations: [ starlight({ title: 'My Docs', head: [ { tag: 'script', attrs: { src: 'https://YOUR_SERVICE/browser.js', 'data-website': 'YOUR_WEBSITE_ID', defer: true } }, ], }), ], }); ``` ## 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 head: [{ tag: 'script', attrs: { src: '/clitrail-consent.js', defer: true } }], ``` ## Client-side routing Starlight pages load in full, so the tag is enough. If you add Astro's `` through a component override, follow the Astro guide's routing step. ## Content Security Policy The build is static files, so the policy lives in your host's header settings (for example `_headers` on Cloudflare Pages or Netlify, or `vercel.json`): add `https://YOUR_SERVICE` to `script-src` and `connect-src`, and `blob:` to `worker-src` (only Safari before 26 needs that one). ``` 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:4321) 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 Starlight's `head` option adds tags to every page's ``, with the attributes you give. Starlight (Astro) documentation: [starlight.astro.build/reference/configuration](https://starlight.astro.build/reference/configuration/) 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.