Understanding 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/nuxt-seo/getting-started/introduction)

[Releases](https://nuxtseo.com/docs/nuxt-seo/releases/v5)

Nuxt SEO

- [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 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)

Search…```k`` /`

v5.1.2

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

### Getting Started

- [Introduction](https://nuxtseo.com/docs/nuxt-seo/getting-started/introduction)
- [Installation](https://nuxtseo.com/docs/nuxt-seo/getting-started/installation)
- [Troubleshooting](https://nuxtseo.com/docs/nuxt-seo/getting-started/troubleshooting)
- [Community Videos](https://nuxtseo.com/docs/nuxt-seo/getting-started/community-videos)

### Core Concepts

- [Quick Module Setup Guide](https://nuxtseo.com/docs/nuxt-seo/guides/using-the-modules)
- [Disabling Modules](https://nuxtseo.com/docs/nuxt-seo/guides/disabling-modules)
- [Nuxt Content](https://nuxtseo.com/docs/nuxt-seo/guides/nuxt-content)
- [I18n](https://nuxtseo.com/docs/nuxt-seo/guides/i18n)
- [MCP Server](https://nuxtseo.com/docs/nuxt-seo/guides/mcp)
- [LLMs.txt](https://nuxtseo.com/docs/nuxt-seo/guides/llms-txt)
- [Understanding Site Config](https://nuxtseo.com/docs/nuxt-seo/guides/site-config)
- [Debugging Modules](https://nuxtseo.com/docs/nuxt-seo/guides/debugging-modules)
- [Updating Nuxt Modules](https://nuxtseo.com/docs/nuxt-seo/guides/updating-modules)

Core Concepts

# Understanding Site Config

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

Every SEO module needs your site URL - sitemaps, OG images, Schema.org identifiers. Site Config lets you set it once instead of duplicating config across modules.

## [Quick Setup](#quick-setup)

For most sites, add this to `nuxt.config.ts`:

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

That's it. All modules now know your canonical URL and site name.

## [Available Options](#available-options)

| Option | Purpose | Default |
| --- | --- | --- |
| `url` | Canonical site URL (required for SEO) | Auto-detected in dev |
| `name` | Site name for meta tags, Schema.org | - |
| `description` | Default meta description | - |
| `defaultLocale` | Language code (e.g., `en`) | Auto from i18n |
| `indexable` | Allow search engine indexing | `true` in production |
| `trailingSlash` | URLs end with `/` | `false` |

See [full config reference](https://nuxtseo.com/docs/site-config/api/config) for all options.

## [Environment-Specific Config](#environment-specific-config)

Running staging or preview environments? Use environment variables so each deployment gets the right URL:

```
# .env.staging
NUXT_SITE_URL=https://staging.example.com
NUXT_SITE_ENV=staging
```

```
# .env.production
NUXT_SITE_URL=https://example.com
NUXT_SITE_ENV=production
```

Non-production environments are automatically blocked from indexing.

Non-production environments are automatically blocked from indexing via the robots module. No need to manually configure `noindex` for staging or preview deployments.

## [Reading Site Config](#reading-site-config)

Access your config anywhere with `useSiteConfig()`:

```
<script setup lang="ts">
const site = useSiteConfig()
// site.url, site.name, site.description, etc.
</script>
```

Works in components, composables, and server routes.

## [Multi-Tenancy](#multi-tenancy)

Serving multiple domains from one Nuxt app? Site Config handles this:

```
export default defineNuxtConfig({
  site: {
    multiTenancy: [
      {
        hosts: ['example.com', 'www.example.com'],
        config: { name: 'Example', url: 'https://example.com' }
      },
      {
        hosts: ['foo.com', 'www.foo.com'],
        config: { name: 'Foo', url: 'https://foo.com' }
      }
    ]
  }
})
```

The correct config loads based on the incoming request hostname.

See the [Multi-Tenancy guide](https://nuxtseo.com/docs/site-config/guides/multi-tenancy) for runtime configuration.

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

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

Did this page help you?

### Related

[Site Config Docs](https://nuxtseo.com/docs/site-config/getting-started/introduction) [I18n Integration](https://nuxtseo.com/docs/site-config/guides/i18n) [Multi-Tenancy](https://nuxtseo.com/docs/site-config/guides/multi-tenancy)

[LLMs.txt Help AI tools understand Nuxt SEO modules so they can assist you better.](https://nuxtseo.com/docs/nuxt-seo/guides/llms-txt) [Debugging Modules Disable modules and create minimal reproductions for Nuxt SEO issues.](https://nuxtseo.com/docs/nuxt-seo/guides/debugging-modules)

On this page

- [Quick Setup](#quick-setup)
- [Available Options](#available-options)
- [Environment-Specific Config](#environment-specific-config)
- [Reading Site Config](#reading-site-config)
- [Multi-Tenancy](#multi-tenancy)

[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 Idea Generator](https://nuxtseo.com/tools/keyword-generator)
- [Keyword Research](https://nuxtseo.com/tools/keyword-research)
- [SERP Analyzer](https://nuxtseo.com/tools/serp-analyzer)
- [Domain Rankings](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)