---
title: "Configuration"
description: "Complete configuration reference for Nuxt Skew Protection."
canonical_url: "https://nuxtseo.com/docs/skew-protection/api/config"
last_updated: "2026-05-11T17:48:47.124Z"
---

Complete configuration options for `nuxt.config.ts`.

## Basic Configuration

```ts [nuxt.config.ts]
export default defineNuxtConfig({
  modules: ['nuxt-skew-protection'],

  skewProtection: {
    // Your configuration here
  }
})
```

## Options

### `enabled: boolean`

- Default: `true`

Enables or disables the module.

### `storage: StorageOptions`

- Default: `{ driver: 'fs', base: 'node_modules/.cache/nuxt-seo/skew-protection' }`

Storage configuration for version assets and metadata. Required for production.

```ts [nuxt.config.ts]
export default defineNuxtConfig({
  skewProtection: {
    storage: {
      driver: 'fs', // or 'redis', 's3', 'cloudflare-kv-binding', etc.
      // Driver-specific options
    }
  }
})
```

See [Storage Configuration](/docs/skew-protection/guides/storage-configuration) for all drivers.

### `updateStrategy 'polling' | 'sse' | 'ws'`

- Default: Auto-detected based on platform

Strategy for checking for version updates.

See [Update Strategies](/docs/skew-protection/guides/update-strategies) for details.

### `retentionDays: number`

- Default: `30`

How many days to keep old versions before cleanup.

```ts
skewProtection: {
  retentionDays: 7 // Keep versions for 7 days
}
```

### `maxNumberOfVersions: number`

- Default: `10`

Maximum number of versions to retain.

```ts
skewProtection: {
  maxNumberOfVersions: 5 // Keep max 5 versions
}
```

Cleanup happens during build. The module removes the oldest versions first.

### `cookie: CookieOptions`

- Default: See below

Cookie configuration for storing deployment version.

```ts [nuxt.config.ts]
export default defineNuxtConfig({
  skewProtection: {
    cookie: {
      name: '__nkpv',
      path: '/',
      sameSite: 'lax',
      maxAge: 60 * 60 * 24 * 7 // 7 days
    }
  }
})
```

### `bundleAssets: boolean`

- Default: `true`

Bundles previous deployment chunks to support users on old versions. The module stores and serves old build assets to users who haven't refreshed.

```ts [nuxt.config.ts]
export default defineNuxtConfig({
  skewProtection: {
    bundleAssets: true
  }
})
```

<note>

Automatically disabled when using CDN URL.

</note>

### `connectionTracking: boolean`

- Default: `false`

Enables real-time connection tracking. When enabled, the server tracks active SSE/WebSocket connections and only sends stats to authorized connections.

```ts [nuxt.config.ts]
export default defineNuxtConfig({
  skewProtection: {
    connectionTracking: true
  }
})
```

Use with the `useActiveConnections()` composable to display live connection stats:

```ts
const { total, versions, authorized } = useActiveConnections()
```

<callout type="warning">

Only works with `sse` or `ws` update strategies. Does not support polling or external adapters (Pusher/Ably).

</callout>

<callout type="info">

Stats require authorization via the `skew:authorize-stats` hook. See [Live Connection Tracking](/docs/skew-protection/guides/live-connections#authorization) for setup.

</callout>

See [Live Connection Tracking](/docs/skew-protection/guides/live-connections) for usage examples.

### `routeTracking: boolean`

- Default: `false`

Tracks which routes users are currently viewing. Requires `connectionTracking: true`.

```ts [nuxt.config.ts]
export default defineNuxtConfig({
  skewProtection: {
    connectionTracking: true,
    routeTracking: true
  }
})
```

When enabled, `useActiveConnections()` includes a `routes` property:

```ts
const { total, versions, routes } = useActiveConnections()
// routes.value = { "/": 10, "/about": 3, "/blog/post-1": 2 }
```

See [Tracking User Pages](/docs/skew-protection/guides/route-tracking) for usage examples and targeted invalidation.

### `ipTracking: boolean`

- Default: `false`

Tracks IP addresses of connected users. Requires `connectionTracking: true`.

```ts [nuxt.config.ts]
export default defineNuxtConfig({
  skewProtection: {
    connectionTracking: true,
    ipTracking: true
  }
})
```

When enabled, `useActiveConnections()` includes IP addresses in the `connections` array:

```ts
const { connections } = useActiveConnections()
// connections.value = [{ id: 'abc', version: '...', route: '/', ip: '192.168.1.1' }]
```

<callout type="warning">

IP tracking requires explicit opt-in due to privacy considerations. The module only stores IPs in memory and exposes them via the stats API. Ensure your `skew:authorize-stats` hook properly restricts access.

</callout>

The module extracts IP addresses from headers in this order: `cf-connecting-ip` (Cloudflare), `x-forwarded-for` (proxies), `x-real-ip` (nginx).

### `debug: boolean`

- Default: `false`

Enables debug logging.

```ts [nuxt.config.ts]
export default defineNuxtConfig({
  skewProtection: {
    debug: true
  }
})
```

Logs version changes, asset operations, module invalidations, and storage operations.