---
title: "Install Nuxt OG Image · Nuxt OG Image · Nuxt SEO"
canonical_url: "https://nuxtseo.com/docs/og-image/v5/getting-started/installation"
last_updated: "2026-08-16T10:00:27.731Z"
meta:
  description: "Get started with Nuxt OG Image by installing the dependency to your project."
  "og:description": "Get started with Nuxt OG Image by installing the dependency to your project."
  "og:title": "Install Nuxt OG Image · Nuxt OG Image · Nuxt SEO"
---

Nuxt SEO on GitHub

You're viewing **OG Image v5** documentation. For the latest, [~~switch to v6~~](https://nuxtseo.com/docs/og-image/getting-started/introduction).

](https://nuxtseo.com/docs/og-image/v5/getting-started/introduction)

](https://nuxtseo.com/docs/og-image/v5/api/define-og-image)

](https://nuxtseo.com/docs/og-image/v5/releases/v5)

Switch to OG Image](https://nuxtseo.com/docs/og-image/getting-started/introduction)Switch to Nuxt SEO](https://nuxtseo.com/docs/nuxt-seo/getting-started/introduction)Switch to Robots](https://nuxtseo.com/docs/robots/getting-started/introduction)Switch to Sitemap](https://nuxtseo.com/docs/sitemap/getting-started/introduction)Switch to Schema.org](https://nuxtseo.com/docs/schema-org/getting-started/introduction)Switch to Link Checker](https://nuxtseo.com/docs/link-checker/getting-started/introduction)Switch to SEO Utils](https://nuxtseo.com/docs/seo-utils/getting-started/introduction)Switch to Site Config](https://nuxtseo.com/docs/site-config/getting-started/introduction)Switch to Skew Protection](https://nuxtseo.com/docs/skew-protection/getting-started/introduction)Switch to AI Ready](https://nuxtseo.com/docs/ai-ready/getting-started/introduction)

**Getting Started**

# **Install Nuxt OG Image**

## Setup Module

Want to know why you might need this module? Check out the [**~~introduction~~**](https://nuxtseo.com/docs/og-image/getting-started/introduction).

To get started with Nuxt OG Image, you need to install the dependency and add it to your Nuxt config.

`npx nuxt module add og-image`

## Verifying Installation

Out-of-the-box the module will not do anything until you configure it.

You can verify the module is installed correctly by checking the [**~~Nuxt DevTools~~**](https://devtools.nuxt.com/) for the OG Image tab.

The DevTools is the starting point, providing a playground to design and test your OG Image with full HMR support.

## Configuration

OG Images must be served with absolute URLs, if you're prerendering, you will need to provide a Site URL.

[Site Config Quick Setup](https://nuxtseo.com/docs/site-config/getting-started/introduction)

```
export default defineNuxtConfig({
  site: {
    url: 'https://example.com',
    name: 'My Awesome Website'
  },
})
```

For more advanced configurations, check out the [~~site config guide ~~](https://nuxtseo.com/docs/site-config/guides/setting-site-config).

## Next Steps

You've successfully installed Nuxt OG Image, but you need to make your first OG Image.

Follow the [**~~Getting Familiar with Nuxt OG Image~~**](https://nuxtseo.com/docs/og-image/getting-started/getting-familar-with-nuxt-og-image) tutorial to get started.

**Was this page helpful?**

[**Introduction** Generate OG Images with Vue templates in Nuxt.](https://nuxtseo.com/docs/og-image/v5/getting-started/introduction) [**Troubleshooting** Create minimal reproductions for Nuxt OG Image or just experiment with the module.](https://nuxtseo.com/docs/og-image/v5/getting-started/troubleshooting)