Nuxt Config · Nuxt OG Image · Nuxt SEO

-
-
-
-

[1.4K](https://github.com/harlan-zw/nuxt-seo)

[Nuxt SEO on GitHub](https://github.com/harlan-zw/nuxt-seo)

You're viewing **OG Image v5** documentation. For the latest,

.

OG Image

-
-
-
-
-
-
-
-
-
-

Search…```k`` /`

v5

- Playgrounds
- [Discord Support](https://discord.com/invite/275MBUBvgP)

### Nuxt API

-
-
-
-
-
-

### Nitro API

-

Nuxt API

# Nuxt Config

[Copy for LLMs](https://nuxtseo.com/docs/og-image/v5/api/config.md)

### [`enabled`](#enabled)

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

Conditionally toggle the module.

### [`defaults`](#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

 documentation for more details.

### [`compatibility`](#compatibility)

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

Override the compatibility flags.

See the

 guide to learn more.

### [`fonts`](#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

 documentation for more details.

### [`zeroConfig`](#zeroconfig)

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

Enable zero runtime mode. See the

 documentation for more details.

### [`googleFontMirror`](#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

 guide.

### [`satoriOptions`](#satorioptions)

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

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

### [`resvgOptions`](#resvgoptions)

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

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

### [`sharpOptions`](#sharpoptions)

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

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

### [`componentOptions`](#componentoptions)

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

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

### [`componentDirs`](#componentdirs)

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

Extra component directories that should be used to resolve components.

### [`runtimeCacheStorage`](#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.

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

## [`strictNuxtContentPaths`](#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`](#debug)

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

Enables debug logs and a debug endpoint.

[Edit this page](https://github.com/nuxt-modules/og-image/blob/v5.1.13/docs/content/4.api/3.config.md)

[Markdown For LLMs](https://nuxtseo.com/docs/og-image/v5/api/config.md)

Did this page help you?

On this page

- [enabled](#enabled)
- [defaults](#defaults)
- [compatibility](#compatibility)
- [fonts](#fonts)
- [zeroConfig](#zeroconfig)
- [googleFontMirror](#googlefontmirror)
- [satoriOptions](#satorioptions)
- [resvgOptions](#resvgoptions)
- [sharpOptions](#sharpoptions)
- [componentOptions](#componentoptions)
- [componentDirs](#componentdirs)
- [runtimeCacheStorage](#runtimecachestorage)
- [strictNuxtContentPaths](#strictnuxtcontentpaths)

[GitHub](https://github.com/harlan-zw/nuxt-seo) [ Discord](https://discord.com/invite/275MBUBvgP)

###

-
-

Modules

-
-
-
-
-
-
-
-
-

###

-
-
-

###

Nuxt

-
-
-
-
-

Vue

-
-
-
-
-
-
-
-

###

-
-
-
-
-
-
-
-
-
-

Copyright © 2023-2026 Harlan Wilton - [MIT License](https://github.com/harlan-zw/nuxt-seo/blob/main/license) · [mdream](https://mdream.dev)