---
title: "Install Nuxt Site Config"
description: "Get started with Nuxt Site Config by installing the dependency to your project."
canonical_url: "https://nuxtseo.com/docs/site-config/getting-started/installation"
last_updated: "2026-10-11T21:08:13.310Z"
---

## Setup Module

::module-install{name="site-config" included-in="@nuxtjs/seo" warning="Auto-installed with SEO modules. Manual install only for custom modules."}
::

::tip
Using an AI agent? Get the nuxt-site-config Skill on [skilld.dev/gh/harlan-zw/nuxt-site-config](https://skilld.dev/gh/harlan-zw/nuxt-site-config).
::

## Verifying Installation

After installing the module, visit `/__site-config__/debug.json` to see the current site config, or check the Site Config tab in Nuxt DevTools.

## Module Kit Usage

Add `nuxt-site-config` to your package dependencies, then declare it in `moduleDependencies`.
Nuxt loads the module dependency automatically.
Kit functions initialize the config stack when first called.
Resolve the module from your package so nested dependencies work with pnpm's global virtual store.

```ts [modules.ts]
import { fileURLToPath } from 'node:url'
import { defineNuxtModule } from '@nuxt/kit'
import { updateSiteConfig } from 'nuxt-site-config/kit'

export default defineNuxtModule({
  // ...
  moduleDependencies: {
    [fileURLToPath(import.meta.resolve('nuxt-site-config'))]: { version: '>=5.0.0' },
  },
  setup(options) {
    // Optional: set some site config from your modules options
    // This is not recommended, only to keep supporting your modules options.
    // The user's `site` key and `NUXT_SITE_*` env vars override it.
    updateSiteConfig({
      _context: 'my-module',
      url: options.siteUrl,
    })
  }
})
```

That's it. Explore the documentation to learn more.

## Next Steps

You've successfully installed Nuxt Site Config. Here's the recommended reading path:

1. **[Recommended Config](/docs/site-config/guides/setting-site-config)** - Set your site `url`, `env`, and `name`
2. **[How it works](/docs/site-config/guides/how-it-works)** - Understand config resolution order
3. **[Runtime Site Config](/docs/site-config/guides/runtime-site-config)** - Set config dynamically per-request

## Sitemap

See the full [sitemap](/sitemap.md) for all pages.