---
title: "Nuxt Config"
description: "The Nuxt OG Image module configuration."
canonical_url: "https://nuxtseo.com/docs/og-image/v5/api/config"
last_updated: "2026-05-06T18:44:32.227Z"
---

### `enabled`

- Type: `boolean`
- Default: `true`

Conditionally toggle the module.

### `defaults`

- Type: `OgImageOptions`
- Default: `{ width: 1200, height: 600, emojis: 'noto', renderer: 'satori', component: 'NuxtSeo', cacheMaxAgeSeconds: 60 * 60 * 24 * 3 }`

The default options to use when generating images.

See the [defineOgImage](/docs/og-image/api/define-og-image) documentation for more details.

### `compatibility`

- Type: `{ dev?: CompatibilityFlags, runtime?: CompatibilityFlags, prerender?: CompatibilityFlags }`
- Default: `{}`

Override the compatibility flags.

See the [compatibility](/docs/og-image/guides/compatibility) guide to learn more.

### `fonts`

- Type: `InputFontConfig[]`
- Default: `['Inter:400', 'Inter:700']`

Fonts families to use when generating images with Satori. When not using Inter it will automatically fetch the font from Google Fonts.

See the [Custom Fonts](/docs/og-image/guides/custom-fonts) documentation for more details.

### `zeroConfig`

- Type: `boolean`
- Default: `false`

Enable zero runtime mode. See the [Zero Runtime](/docs/og-image/guides/zero-runtime) documentation for more details.

### `googleFontMirror`

- Type: `string`
- Default: `undefined`

Specify a custom Google Fonts mirror host (e.g., your own proxy server that serves TTF fonts).

**Note:** The mirror must serve TTF format fonts for Satori compatibility. Most public CDNs (bunny.net, fontsource, etc.) only serve WOFF2 which is not compatible.

**For China users:** We recommend using local font files via the `fonts` option with `path` instead of relying on mirrors. See the [Custom Fonts](/docs/og-image/guides/custom-fonts#loading-a-local-font-file) guide.

### `satoriOptions`

- Type: `SatoriOptions`
- Default: `{}`

Options to pass to Satori when generating images. See the [Satori docs](https://github.com/vercel/satori).

### `resvgOptions`

- Type: `ResvgOptions`
- Default: `{}`

Options to pass to Resvg when generating images. See the [Resvg docs](https://github.com/yisibl/resvg-js).

### `sharpOptions`

- Type: `SharpOptions`
- Default: `{}`

Options to pass to Sharp when generating images. See the [Sharp docs](https://sharp.pixelplumbing.com/).

### `componentOptions`

- Type: `{ global: boolean }`
- Default: `{}`

The options to pass to when registering the `<OgImage />`, `<OgImageScreenshot />` components.

### `componentDirs`

- Type: `string[]`
- Default: `['OgImage', 'OgImageTemplate']`

Extra component directories that should be used to resolve components.

### `runtimeCacheStorage`

- Type: `boolean | (Record<string, any> & { driver: string })`
- Default: `true`

Modify the cache behaviour.

Passing a boolean will enable or disable the runtime cache with the default options.

Providing a record will allow you to configure the runtime cache fully.

```ts
export default defineNuxtConfig({
  ogImage: {
    runtimeCacheStorage: {
      driver: 'redis',
      host: 'localhost',
      port: 6379,
      password: 'password'
    }
  }
})
```

## `strictNuxtContentPaths`

- Type: `boolean`
- Default: `false`

Whether the paths within nuxt/content match their real paths. This is useful when you're using the `nuxt/content` module
without documentDriven mode.

### `debug`

- Type: `boolean`
- Default: `false`

Enables debug logs and a debug endpoint.