Nuxt Config · Nuxt Site Config · Nuxt SEO

[NuxtSEO](https://nuxtseo.com/ "Home")

- [Modules](https://nuxtseo.com/docs/nuxt-seo/getting-started/introduction)
- [Tools](https://nuxtseo.com/tools)
- [Pro](https://nuxtseo.com/pro)
- [Learn SEO](https://nuxtseo.com/learn-seo/nuxt) [Releases](https://nuxtseo.com/releases)

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

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

[User Guides](https://nuxtseo.com/docs/site-config/getting-started/introduction)

[API](https://nuxtseo.com/docs/site-config/api/use-site-config)

[Releases](https://nuxtseo.com/docs/site-config/releases/v4)

Site Config

- [Switch to Site Config](https://nuxtseo.com/docs/site-config/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 OG Image](https://nuxtseo.com/docs/og-image/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 Skew Protection](https://nuxtseo.com/docs/skew-protection/getting-started/introduction)
- [Switch to AI Ready](https://nuxtseo.com/docs/ai-ready/getting-started/introduction)

Search…```k`` /`

v4.0.7

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

### Nuxt API

- [`useSiteConfig()`](https://nuxtseo.com/docs/site-config/api/use-site-config)
- [`updateSiteConfig()`](https://nuxtseo.com/docs/site-config/api/update-site-config)
- [`createSitePathResolver()`](https://nuxtseo.com/docs/site-config/api/create-site-path-resolver)
- [`getNitroOrigin()`](https://nuxtseo.com/docs/site-config/api/get-nitro-origin)
- [nuxt.config.ts](https://nuxtseo.com/docs/site-config/api/config)
- [Nuxt Hooks](https://nuxtseo.com/docs/site-config/api/nuxt-hooks)

### Nitro API

- [`getSiteConfig()`](https://nuxtseo.com/docs/site-config/nitro-api/use-site-config)
- [`updateSiteConfig()`](https://nuxtseo.com/docs/site-config/nitro-api/update-site-config)
- [`getSiteIndexable()`](https://nuxtseo.com/docs/site-config/nitro-api/get-site-indexable)
- [`createSitePathResolver()`](https://nuxtseo.com/docs/site-config/nitro-api/create-site-path-resolver)
- [`getNitroOrigin()`](https://nuxtseo.com/docs/site-config/nitro-api/get-nitro-origin)
- [Nitro Hooks](https://nuxtseo.com/docs/site-config/nitro-api/nitro-hooks)

Nuxt API

# Nuxt Config

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

## [`enabled`](#enabled)

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

Whether site config activates for this project.

## [`debug`](#debug)

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

Whether to activate debug mode for site config.

## [`multiTenancy`](#multitenancy)

- Type: `{ hosts: string[]; config: SiteConfigInput }[]`
- Default: `[]`

Configure multiple sites with different configurations based on the host. Each site configuration requires:

- `hosts`: An array of hostnames that should use this configuration
- `config`: The site configuration to use when the hostname matches

Example

```
export default defineNuxtConfig({
  site: {
    multiTenancy: [
      {
        hosts: ['www.example.com', 'example.com', 'local.example.com'],
        config: {
          name: 'Example',
          description: 'Example description',
          url: 'example.com',
          defaultLocale: 'en',
          currentLocale: 'en',
        },
      },
      {
        hosts: ['www.foo.com', 'foo.com', 'local.foo.com'],
        config: {
          url: 'foo.com',
          name: 'Foo',
          description: 'Foo description',
        },
      },
    ]
  }
})
```

## [`url`](#url)

- Type: `string`

The canonical site URL. On supported CI platforms (Vercel, [Netlify](https://netlify.com), Cloudflare Pages), this is automatically populated from platform environment variables if not explicitly set. See [How it works](https://nuxtseo.com/docs/site-config/guides/how-it-works) for details.

## [`env`](#env)

- Type: `string`
- Default: `process.env.NODE_ENV`

The environment the site is running in.

See [this issue](https://github.com/nuxt/nuxt/issues/19819) on why we can't use `process.env.NODE_ENV`.

## [`name`](#name)

- Type: `string`

The name of the site. On [Vercel](https://vercel.com) and Netlify, this is automatically populated from platform environment variables if not explicitly set. See [How it works](https://nuxtseo.com/docs/site-config/guides/how-it-works) for details.

## [`indexable`](#indexable)

- Type: `boolean`
- Default: `siteConfig.env === 'production'` (where `env` defaults to `process.env.NODE_ENV`)

Can the site be indexed by search engines.

## [`trailingSlash`](#trailingslash)

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

Whether to add trailing slashes to the URLs.

## [`defaultLocale`](#defaultlocale)

- Type: `string`

The default locale of the site.

[Edit this page](https://github.com/harlan-zw/nuxt-site-config/edit/main/docs/content/4.api/config.md)

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

Did this page help you?

[getNitroOrigin() Get the runtime origin URL safely across development, prerendering, and production environments.](https://nuxtseo.com/docs/site-config/api/get-nitro-origin) [Nuxt Hooks Learn how to use Nuxt Hooks to customize your site config.](https://nuxtseo.com/docs/site-config/api/nuxt-hooks)

On this page

- [enabled](#enabled)
- [debug](#debug)
- [multiTenancy](#multitenancy)
- [url](#url)
- [env](#env)
- [name](#name)
- [indexable](#indexable)
- [trailingSlash](#trailingslash)
- [defaultLocale](#defaultlocale)

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

### [NuxtSEO](https://nuxtseo.com/ "Home")

- [Getting Started](https://nuxtseo.com/docs/nuxt-seo/getting-started/introduction)
- [MCP](https://nuxtseo.com/docs/nuxt-seo/guides/mcp)

Modules

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

### [NuxtSEO Pro](https://nuxtseo.com/pro "Home")

- [Getting Started](https://nuxtseo.com/pro)
- [Dashboard](https://nuxtseo.com/pro/dashboard)
- [Pro MCP](https://nuxtseo.com/docs/nuxt-seo-pro/mcp/installation)

### [Learn SEO](https://nuxtseo.com/learn-seo "Learn SEO")

Nuxt

- [Mastering Meta](https://nuxtseo.com/learn-seo/nuxt/mastering-meta)
- [Controlling Crawlers](https://nuxtseo.com/learn-seo/nuxt/controlling-crawlers)
- [Launch & Listen](https://nuxtseo.com/learn-seo/nuxt/launch-and-listen)
- [Routes & Rendering](https://nuxtseo.com/learn-seo/nuxt/routes-and-rendering)
- [Staying Secure](https://nuxtseo.com/learn-seo/nuxt/routes-and-rendering/security)

Vue

- [Vue SEO Guide](https://nuxtseo.com/learn-seo/vue)
- [Mastering Meta](https://nuxtseo.com/learn-seo/vue/mastering-meta)
- [Controlling Crawlers](https://nuxtseo.com/learn-seo/vue/controlling-crawlers)
- [SPA SEO](https://nuxtseo.com/learn-seo/vue/spa)
- [SSR Frameworks](https://nuxtseo.com/learn-seo/vue/ssr-frameworks)
- [SEO Checklist](https://nuxtseo.com/learn-seo/checklist)
- [Pre-Launch Warmup](https://nuxtseo.com/learn-seo/pre-launch-warmup)
- [Backlinks & Authority](https://nuxtseo.com/learn-seo/backlinks)

### [Tools](https://nuxtseo.com/tools "SEO Tools")

- [Social Share Debugger](https://nuxtseo.com/tools/social-share-debugger)
- [Robots.txt Generator](https://nuxtseo.com/tools/robots-txt-generator)
- [Meta Tag Checker](https://nuxtseo.com/tools/meta-tag-checker)
- [HTML to Markdown](https://nuxtseo.com/tools/html-to-markdown)
- [XML Sitemap Validator](https://nuxtseo.com/tools/xml-sitemap-validator)
- [Schema.org Validator](https://nuxtseo.com/tools/schema-validator)
- [Keyword Research Pro](https://nuxtseo.com/tools/keyword-research)
- [SERP Analyzer Pro](https://nuxtseo.com/tools/serp-analyzer)
- [Domain Rankings Pro](https://nuxtseo.com/tools/domain-rankings)

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